DX STF Client API

<back to all web services

UpdateOrderClientProcessed

Order Requests

Order

Requires Authentication
The following routes are available for this service:
PUT/api/order/{OrderId}/processedUpdate order as customer processed, will also acknowledge order if not yet set.
UpdateOrderClientProcessed Parameters:
NameParameterData TypeRequiredDescription
OrderIdpathGuidNoOrder ID or Token
CustomerReferencebodystringYesCustomer order reference in destination system
CustomerProcessedDatebodyDateTimeNoDate and Time order was processed in destination system
TokenDto Parameters:
NameParameterData TypeRequiredDescription
TokenformGuidNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/order/{OrderId}/processed HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}