Services

Retrieve list of available services for the account, optionally filtered by carrier, destination and package

Changed on
get/services

Request

  • Base URL
    https://api.parcel.royalmail.com/api/v1
  • URL
    https://api.parcel.royalmail.com/api/v1/services
  • Auth
    API key in header Authorization

Query parameters

destinationCountryCodestring

ISO 3166-1 alpha-3 country code of the shipment destination (e.g. GBR). Must be a recognised ISO 3166-1 alpha-3 code — an unrecognised value returns a 400. Supply it to scope results to a single destination (e.g. before checkout); GBR additionally requires destinationPostcode to be set. Omit it (along with destinationPostcode, packagingFormat and packageWeight) to browse the full, unfiltered service catalogue for discovery. destinationPostcode, packagingFormat and packageWeight require destinationCountryCode to also be supplied — providing any of them without it returns a 400, since the underlying carrier lookup can only be filtered once a destination is known.

destinationPostcodestring

Postcode of the shipment destination. Required when destinationCountryCode is GBR — a 400 is returned if it's missing or blank. For any other destination country, postcode-based filtering isn't supported, so this value is ignored even if supplied.

packagingFormat'Letter' | 'LargeLetter' | 'SmallParcel' | 'MediumParcel' | 'Parcel' | 'Documents'

Packaging format of the shipment. Requires destinationCountryCode to also be supplied — a 400 is returned otherwise.

packageWeightinteger

Weight of the package in grams. Requires destinationCountryCode to also be supplied — a 400 is returned otherwise.

carrierGuidstring uuid

GUID of a carrier configured on the account, to scope results to that carrier only. An unrecognised carrierGuid returns a 400. If carrierName is also supplied, both must refer to the same carrier.

carrierNamestring

Name of a carrier configured on the account, to scope results to that carrier only. An unrecognised carrierName returns a 400. If carrierGuid is also supplied, both must refer to the same carrier.

shippingAccountNamestring

Alternative to carrierName; takes precedence when both are supplied.

Response

Return list of services grouped by carrier

carrierGuidstring uuid required
carrierNamestring required
shippingAccountNamestring required

Same value as carrierName.

Changes