Endpoints
The courier option object
Attributes
- codestring
Short courier code. Pass this value back when updating an order to
shipping. - namestring
Human-readable courier name.
nullList available courier options
GET/
- Credentials
- Any active API key.
- For
- Print farms
- Operation id
listPrintFarmCourierOptions
Returns every available courier option (code + name) for use when updating an order to shipping. The list is the same for every caller. Always includes an other entry as a fallback for couriers not in the catalog.
Returns200 OK
The list of available courier options.
Responses
- 200
The list of available courier options.
- 401
API key is missing or invalid.
- 403
The API key does not have the required permission scope.
- 429
Rate limit exceeded - wait until the window resets before retrying.
- 500
An unexpected error occurred on our side.
Errors use the print farm error body.
GET/v1/print-farm/courier-options
curl "https://public-api.dapi.digital/v1/print-farm/courier-options" \
-H "x-api-key: $DAPI_API_KEY"Response
{
"courier_options": [
{
"code": "ups",
"name": "UPS"
}
]
}