DX STF Client API

UpdateOrderClientProcessed

Order Requests

Order

The following routes are available for this service:
PUT	/api/order/{OrderId}/processed	Update order as customer processed, will also acknowledge order if not yet set.

"use strict";
export class TokenDto {
    /** @param {{token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    token;
}
export class UpdateOrderClientProcessed {
    /** @param {{orderId?:string,customerReference?:string,customerProcessedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Order ID or Token */
    orderId;
    /**
     * @type {string}
     * @description Customer order reference in destination system */
    customerReference;
    /**
     * @type {string}
     * @description Date and Time order was processed in destination system */
    customerProcessedDate;
}

JavaScript UpdateOrderClientProcessed DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"customerReference":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}