Logistics API

Retrieves a list with all active Contact Attempt configurations.

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

Retrieves the active error code information with all udm classes that are associated with each error code.

get
/api/v1.0/PartnerAssetData/meta/errorCodes

Query Parameters

api-versionstring

Response

The refined metadata from manufacturer table

CHGResultOfListOfErrorCodeMetaDataResponse

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

Retrieves the manufacturer information

get
/api/v1.0/PartnerAssetData/meta/manufacturers

Query Parameters

api-versionstring

Response

OK

CHGResultOfListOfManufacturerMetaDataResponse

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

Retrieves a list of transport orders for a logistics partner

get
/api/v1.0/PartnerAssetData/transportOrders

Query Parameters

api-versionstring

Headers

CHG-Accountinteger | string(int32)

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

Response

The transport order details

Retrieves the transport order details for a logistics partner

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

Query Parameters

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

The transport order details

CHGResultOfTransportOrderResponse

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