v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Services

Get Carrier Services

Retrieves the list of Royal Mail services available within the system. The response includes the service code and description for each Royal Mail service, along with Royal Mail‑specific service levels returned in the CarrierSpecifics object. <br /> <br />Note: Each service returned represents a Royal Mail offering that may be available for use, subject to the customer's Royal Mail account configuration.

get/v4/carriers/rm/services

Query parameters

shippingAccountIdstring

SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you). Include this to get carrier-specific fields such as service levels for your specific shipping account.

Response

Returns a list of services.

ServiceCodestring required

A unique identifier for each shipping service provided by the carrier. This code is typically alphanumeric and allows for easy reference and differentiation between various carrier services offered, for example, CRL1, TPM, and so on.

Descriptionstring required

A detailed explanation of the carrier service, outlining its features, benefits, and any pertinent conditions. This information helps understand the scope and specifics of what the service entails.

Example response

[
  {
    "ServiceCode": "CRL1",
    "Description": "Royal Mail 24 Standard/Signed For (Parcel - Daily Rate Service)",
    "CarrierSpecifics": {
      "ServiceLevels": [
        "01",
        "02"
      ]
    }
  }
]