DX STF Client API

<back to all web services

DuplicatedOrder

Order Requests

Order

Requires Authentication
The following routes are available for this service:
PUT/api/order/{OrderId}/duplicateMark order as duplicate
"use strict";
export class TokenDto {
    /** @param {{token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    token;
}
/** @typedef {'OrderExist'} */
export var DuplicateOrderReasonCode;
(function (DuplicateOrderReasonCode) {
    DuplicateOrderReasonCode["OrderExist"] = "OrderExist"
})(DuplicateOrderReasonCode || (DuplicateOrderReasonCode = {}));
export class DuplicatedOrder {
    /** @param {{orderId?:string,duplicateReasonCode?:DuplicateOrderReasonCode,duplicateReasonCodeDescription?:string,duplicateDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Order ID or Token */
    orderId;
    /**
     * @type {DuplicateOrderReasonCode}
     * @description Reason code */
    duplicateReasonCode;
    /**
     * @type {string}
     * @description Description */
    duplicateReasonCodeDescription;
    /**
     * @type {?string}
     * @description Date and Time order was identified as duplicate */
    duplicateDate;
}

JavaScript DuplicatedOrder DTOs

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

HTTP + JSV

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

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

{
	duplicateReasonCode: OrderExist,
	duplicateReasonCodeDescription: String,
	duplicateDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}