Search
K
Logistics API

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

Allows transport order fields to be updated to the logistics partner

patch
/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*)$

Body

Allows the operation to be prematurely aborted

TransportOrderUpdateRequest

actualDeliveryAtnull | string(date-time)
actualPickupAtnull | string(date-time)
carrierEmailnull | string
carrierPhonenull | string
carrierTransportNumbernull | string
commentsobject
Show Child Parameters
contactAttemptsnull | array[object]
Show Child Parameters
deliveryContactnull | string
instructionsPickupSiteNotenull | string
pickupAssetsnull | array[object]
Show Child Parameters
pickupContactnull | string
pickupEmailnull | string
pickupPhonenull | string
plannedDeliveryAtnull | string(date-time)
plannedPickupAtnull | string(date-time)
transportStatusnull | string

Response

CHGActionResult

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