Logistics API

Gets requested documents for a transport order.

get
/api/v1.0/PartnerAssetData/transportOrders/{transportOrderId}/documents

Query Parameters

documentTypesarray[string]

The types of documents to retrieve.

documentLanguagestring

Language code for the requested documents using ISO 639-1 + ISO 3166 format (e.g., en-GB).

api-versionstring

Path Parameters

transportOrderIdinteger | string(int32)required

Unique transport order identifier

Match pattern:^-?(?:0|[1-9]\d*)$

Headers

CHG-Accountinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

Response

ZIP file containing the requested documents.

Deletes an asset

delete
/api/v1.0/PartnerAssetData/transportOrders/{transportOrderId}/pickupAssets/{assetId}

Query Parameters

api-versionstring

Path Parameters

transportOrderIdinteger | string(int32)required

Unique transport order identifier

Match pattern:^-?(?:0|[1-9]\d*)$

assetIdinteger | string(int32)required

Unique identifier of the pickup asset to delete

Match pattern:^-?(?:0|[1-9]\d*)$

Headers

CHG-Accountinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

Response

Retrieves a list of transport orders for a logistics partner

get
/api/v2.0/PartnerAssetData/logistics/transportOrders

Query Parameters

api-versionstring

Headers

CHG-Accountinteger | string(int32)

Match pattern:^-?(?:0|[1-9]\d*)$

Response

The transport order details

Returns all valid asset class IDs and their English descriptions

get
/api/v2.0/PartnerAssetData/meta/assetClasses

Query Parameters

api-versionstring

Response

OK

CHGResultOfListOfAssetClassMetaDataResponse

messagesAny Of
null | array[object]
CHGMessageTextMessage
Show Child Parameters
responsenull | array[object]
Show Child Parameters

Retrieves a list with all active Contact Attempt configurations.

get
/api/v2.0/PartnerAssetData/meta/contactAttempts

Query Parameters

api-versionstring

Response

OK

CHGResultOfListOfContactAttemptResponse

messagesAny Of
null | array[object]
CHGMessageTextMessage
Show Child Parameters
responsenull | array[object]
Show Child Parameters