Carrier Services

The Carrier Services API allows you to query Scurri for the services that are available for each carrier.

The result contains the identifier for each service, which you can use in the rest of the API calls, whenever a Carrier Service needs to be specified.

Operations

List Available Carrier Services

Request

List all the carrier services for the logged in user

Security

TokenAuth

Path

company_slugstringrequired

Query

enhancementsboolean

Whether to include enhanced services in the response.

package_typesboolean

Whether to include package types in the response.

curl -i -X GET \
  'https://docs.scurri.com/_mock/connect/consignments-api/versions/1.0.0/openapi/_api/v1/company/{company_slug}/carrierservices/?enhancements=true&package_types=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Request was successful

Bodyapplication/json

Array [

carrier_idstringrequired

the name of the carrier to which the service belongs

Example:"Generic Carrier"

identifierstringrequired

A unique, human readable, identifier for the service.

Example:"Generic Carrier|Generic Domestic Service GDOM"

namestringrequired

The name of the service

Example:"Next Day"

enhancementsArray of strings

List of enhancements supported by the service. Becomes available when the enhancements query parameter is passed as true.

Example:

[
  "dangerous_goods"
]

package_typesArray of strings

List of package types supported by the service. Becomes available when the package_types query parameter is passed as true.

Example:

[
  "parcel"
]

]

Response

[
  {
    "carrier_id": "Generic Carrier",
    "identifier": "Generic Carrier|Generic Domestic Service GDOM",
    "name": "Next Day",
    "enhancements": [ … ],
    "package_types": [ … ]
  }
]