List available services
Lists available shipping services, package types, and service requirements.
Behavior
- Availability depends on your account. Use the returned service and package types for shipment requests.
Permission
Any valid Customer API key
See Troubleshooting for authentication, access, rate-limit, and service errors.
/servicesAuthorizationBearer token · headerrequiredRequired header: Authorization: Bearer <customer-api-key>. Use a Customer API key with the operation's required permission. Never use a dashboard or webshop token.
Successful result
successanyrequiredmessagestringrequireddataobjectrequiredShow propertiesHide properties
servicesobject[]Show propertiesHide properties
objectserviceCodestringnamestringreceiverMobileRequiredbooleanreceiverPhoneRequiredbooleanreceiverEmailRequiredbooleanfieldLimitsobject | nullmaxDescriptionLengthnumberpackageTypesServicePackage[]Show propertiesHide properties
ServicePackagetypestringrequiredAllowed packages[].type for this serviceCode.
unitstringrequiredPricing unit: by weight or by package count. Package weight is still supplied in kg.
KILOGRAMQUANTITYisPalletbooleanrequiredWhether this package type represents a pallet.
maxWeightnumberrequiredMaximum weight of one package in kg.
maxHeightnumberrequiredMaximum package height in cm.
maxWidthnumberrequiredMaximum package width in cm.
maxLengthnumberrequiredMaximum package length in cm.
requiredPackageFieldsstring[]requiredFields that must be supplied for this package type. International volume-weight pricing can also require length, width, and height.
requestIdstringrequiredInvalid input or unsupported operation.
successanyrequiredmessagestringrequireddataanyrequiredrequestIdstringrequirederrorCodestringrequirederrorsobject | anyrequiredShow propertiesHide properties
fieldsobject[]Show propertiesHide properties
objectpathstringrequirederrorCodestringrequiredmessagestringrequiredpricePriceShow propertiesHide properties
currencystringrequiredbaseAmountstringrequiredsurchargeAmountstringrequiredpalletExchangeAmountstringrequiredtaxAmountstringrequiredtotalAmountstringrequiredcurrentStatusstringretryAfterSecondsintegeranyResource does not exist or belongs to another account.
successanyrequiredmessagestringrequireddataanyrequiredrequestIdstringrequirederrorCodestringrequirederrorsobject | anyrequiredShow propertiesHide properties
fieldsobject[]Show propertiesHide properties
objectpathstringrequirederrorCodestringrequiredmessagestringrequiredpricePriceShow propertiesHide properties
currencystringrequiredbaseAmountstringrequiredsurchargeAmountstringrequiredpalletExchangeAmountstringrequiredtaxAmountstringrequiredtotalAmountstringrequiredcurrentStatusstringretryAfterSecondsintegerany