Skip to main content
GET
/
carriers
/
services
cURL
curl --request GET \
  --url https://api.atlast.co/v1/carriers/services \
  --header 'Authorization: Bearer <token>'
[
  {
    "carrierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceId": "<string>",
    "name": "<string>",
    "deliveryEnabled": true,
    "collectionEnabled": true,
    "collectionDependency": "NONE",
    "carrierName": "<string>",
    "type": "ROYAL_MAIL",
    "sizeConstraints": [
      {
        "name": "WIDTH",
        "min": 1,
        "max": 123,
        "unit": "CM"
      }
    ],
    "weightConstraint": {
      "min": 1,
      "max": 123,
      "unit": "GRAMS"
    },
    "logo": "<string>",
    "color": "<string>",
    "labelExpireDays": 123
  }
]
Returns all carrier services currently configured to your At Last account.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

200 - application/json

The request has succeeded.

​
carrierId
string<uuid>
required
​
serviceId
string
required
​
name
string
required
​
deliveryEnabled
boolean
required
​
collectionEnabled
boolean
required
​
collectionDependency
enum<string>
required
Available options:
NONE,
DELIVERY,
SAME
​
carrierName
string
required

Name of the carrier

​
type
enum<string>
required

The carrier type as seen in the CarrierType enum.

Available options:
ROYAL_MAIL,
EVRI_CORPORATE,
YODEL,
DPD,
INTERNATIONAL,
USPS,
COLL8,
CANADA_POST,
DHL,
AUSTRALIA_POST,
NZ_POST,
INPOST,
DHL_ECOMMERCE,
UPS
​
sizeConstraints
object[]
​
weightConstraint
object

Url for the carrier logo

​
color
string

Preferred carrier colour

​
labelExpireDays
integer

Indicates how long do labels last for (in days) after they've been created.