v1

latestOpenAPI 3.0.12026-07-242073551.1 MB

Carriers

Get Carrier Services

Retrieves a list of services offered by a specific carrier, giving users insight into the various available transportation and logistics options. The response includes the service code and description for each carrier service, along with the carrier service levels returned in the CarrierSpecifics object (if available).

get/v4/carriers/{carrierCode}/services

Path parameters

carrierCodestring required

A unique identifier for this carrier. This code is typically alphanumeric and serves as a reference to distinguish between various carriers within the system.

Query parameters

shippingAccountIdstring

SAPIENT Shipping Account Id (assigned by SAPIENT) or Alias (assigned by you). Include this if you want to only get the services 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.

{"stackTrail":"components:schemas:CarrierService:properties:CarrierSpecifics","oasType":"schema","type":"unknown","description":"Used to provide carrier-specific service information returned for a given carrier service. This object may include details, such as service level availability and other carrier-specific attributes, enabling customers to determine availability of specific carrier offerings.","nullable":true}

Example response

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