Logistics API

API v1

26.8.0.0OAS 3.1
API Base URL
Security
Authorization (oauth2)

Bearer {access_token}.

Bearer (http)

JWT Authorization header using the Bearer scheme.

Returns all valid asset class IDs and their English descriptions

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

Query Parameters

api-versionstring

Response

A list of asset classes with their numeric IDs and English descriptions

CHGResultOfListOfAssetClassMetaDataResponse

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

The refined metadata from manufacturer table

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-PartnerIdinteger | 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-PartnerIdinteger | 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