Poq.SDK.Node

Home > @poq/sdk-sfcc > OrdersClient > patchOrdersByID

OrdersClient.patchOrdersByID() method

Update an order. Considered fields for update are status (same status transitions are possible as for dw.order.Order.setStatus(int status) plus CREATED to FAILED) and custom properties. During the call the correct channel type will be assured to be set for the order in a successful call. Without agent context the channel type will be storefront otherwise callcenter.

Signature:

patchOrdersByID(orderNo: string, body: Order, options?: RequestOptions): Promise<PoqResponse<Order>>;

Parameters

Parameter	Type	Description
orderNo	string	the order number
body	Order
options	RequestOptions	(Optional) Override http request option.

Returns:

Promise<PoqResponse<Order>>