Delivery Types

1 API call in this section.

List Delivery Types

External & Carrier Integrations / Delivery Types

GET/external/delivery-types

List all delivery types available. Responses: 200 success; 500 internal_server_error.

Send a bearer token in Authorization and a tenant API key when the integration requires X-APIKey or X-API-Key.

Request

curl

1curl --request GET "$ONDI_BASE_URL/external/delivery-types" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "X-API-Key: {{api_key}}"

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

X-API-KeyOptional

header string

{{api_key}}

Responses

Success Response200OK

Response body

json

1{2  "success": true,3  "message": "delivery_types_retrieved_successfully",4  "deliveryTypes": [5    {6      "id": "dt-uuid-1",7      "name": "Local",8      "code": "LOCAL"9    },10    {11      "id": "dt-uuid-2",12      "name": "International",13      "code": "INTL"14    }15  ]16}

Error - Server Error500Internal Server Error

Response body

json

1{2  "success": false,3  "message": "internal_server_error"4}