| PUT | /api/order/{OrderId}/processed | Update order as customer processed, will also acknowledge order if not yet set. |
|---|
export class TokenDto implements ICommandResponse
{
public token: string;
public constructor(init?: Partial<TokenDto>) { (Object as any).assign(this, init); }
}
/** @description Order */
// @Api(Description="Order")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
export class UpdateOrderClientProcessed
{
/** @description Order ID or Token */
// @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
public orderId: string;
/** @description Customer order reference in destination system */
// @ApiMember(Description="Customer order reference in destination system")
public customerReference: string;
/** @description Date and Time order was processed in destination system */
// @ApiMember(Description="Date and Time order was processed in destination system")
public customerProcessedDate: string;
public constructor(init?: Partial<UpdateOrderClientProcessed>) { (Object as any).assign(this, init); }
}
TypeScript UpdateOrderClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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
{}