Logistics API

API v1

Gets requested documents for a transport order.

get
/api/v2.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/v2.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

AccountManager

object
_changedPropertiesnull | object
_changedPropertyNamesnull | array[string]
_internalReferenceIDnull | string
additionalPropertiesnull | object
dataStateinteger
isActiveboolean
namenull | string
numberinteger | string(int32)

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

signnull | string
userIdinteger | string(int32)

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

Example

ActionInvocationMode

integer

ActionParameter

object
actionIdinteger | string(int32)

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

namenull | string
valuenull | string
valueTypeinteger
Example