ORDER UPDATE
Use this call to update order with track&trace codes or add/remove tags.
Request payload
| Field | Obligatory | Type | Default value | Description |
| orders | no | collection of orderUpdate | ||
| orderlines | no | collection of lineUpdate |
Response payload
| Field | Obligatory | Type | Description |
| ID | yes | string | Order number |
| ProcessID | yes | string | Id of process (to be used to request process status) |
Request example
<?xml version="1.0" encoding="utf-8"?>
<update>
<orders>
<orderUpdate>
<orderIdentifierType>channelNumber</orderIdentifierType>
<orderIdentifier>SHOP12345</orderIdentifier>
<connectionIdentifier>322</connectionIdentifier>
<connectionInvoice>INV-2018-322</connectionInvoice>
<connectionNumber>ORD000322</connectionNumber>
<addTags>
<tag>customtag1</tag>
</addTags>
<removeTags>
<tag>customtag2</tag>
</removeTags>
</orderUpdate>
</orders>
<orderlines>
<lineUpdate>
<orderlineIdentifierType>channelLineId</orderlineIdentifierType>
<orderlineIdentifier>SHOP12345_1</orderlineIdentifier>
<trackingNumber>JVGL133242424234</trackingNumber>
<carrier>DHL</carrier>
</lineUpdate>
</orderlines>
</update>
Response example
{
"Request": {
"RequestType": "Order",
"RequestAction": "Update",
"RequestIdentifier": "abc321",
"ProcessedAt": "2018-03-23T14:28:01+01:00"
},
"Response": {
"Result": "Success",
"OrderUpdateResponseContainer": {
"ID": "abc321",
"ProcessID": "ogULdgmyvJRra3ZD"
}
}
}
<?xml version="1.0"?>
<ApiResponseContainer>
<Request>
<RequestType>Order</RequestType>
<RequestAction>Update</RequestAction>
<RequestIdentifier>abc321</RequestIdentifier>
<ProcessedAt>2018-03-23T14:28:01+01:00</ProcessedAt>
</Request>
<Response>
<Result>Success</Result>
<OrderUpdateResponseContainer>
<ID><![CDATA[abc321]]></ID>
<ProcessID><![CDATA[ogULdgmyvJRra3ZD]]></ProcessID>
</OrderUpdateResponseContainer>
</Response>
</ApiResponseContainer>