api-versionstring
Retrieves the transport order details for a logistics partner
get
/api/v1.0/PartnerAssetData/transportOrders/{transportOrderId}
Query Parameters
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
Response
The transport order details
CHGResultOfTransportOrderResponse
messages
Any Ofnull | 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
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
Response
CHGActionResult
messages
Any Ofnull | array[object]
CHGMessageTextMessage
Show Child Parameters
Gets all asset data (goods in and inventory) for a transport order
get
/api/v1.0/PartnerAssetData/transportOrders/{transportOrderId}/assets
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
Response
OK
CHGResultOfListOfAssetResponse
messages
Any Ofnull | array[object]
CHGMessageTextMessage
Show Child Parameters
responsenull | array[object]
Show Child Parameters
Imports assets into SMS from a partner. Supports both minimal goods-in data and detailed inventory data. The assetTested field indicates that the asset has been fully processed and may be sold.
post
/api/v1.0/PartnerAssetData/transportOrders/{transportOrderId}/assets
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
Body
Allows the operation to be prematurely aborted
actualDeliveryAtstring(date-time)
assetClassIdinteger | string(int32)
Match pattern:^-?(?:0|[1-9]\d*)$
assetErasednull | boolean
assetTestednull | boolean
caseColornull | string
errorsnull | array[integer,string](int32)
Match pattern:^-?(?:0|[1-9]\d*)$
graphicsAdapternull | string
imeinull | string
keyboardLayoutnull | string
manufacturernull | string
memorynull | integer | string(int32)
Match pattern:^-?(?:0|[1-9]\d*)$
modelDescriptionnull | string
powerSupplynull | string
processorDescriptionnull | string
refurbishmentPricenull | number | string(double)
Match pattern:^-?(?:0|[1-9]\d*)(?:\.\d+)?$
screenSizenull | number | string(double)
Match pattern:^-?(?:0|[1-9]\d*)(?:\.\d+)?$
serialNumbernull | string
storageCapacitynull | integer | string(int32)
Match pattern:^-?(?:0|[1-9]\d*)$
typeOfCasenull | string
uniqueIdnull | string
Response
Response
No Content
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-PartnerIdinteger | string(int32)
Match pattern:^-?(?:0|[1-9]\d*)$
Response
Response
ZIP file containing the requested documents.