Order Amend Lines Request

This request cancels all or part of an order line item. The request contains canceled order line item data like line number, quantity, and barcode information.

Request

This sample contains two blocks of information in order.lines.product. The quantity parameter in the first block displays the orderedQuantity if the order is canceled before pick complete. If the order is canceled after the pick is complete, then the quantity parameter displays the pickedQuantity.

The second block in order.lines.product displays when fewer quantities were picked than ordered or when fewer quantities were picked as substituted/overriden. The customer would have initiated cancellation in the quantity line.

{ "order": { "orderId": "345261", "customerOrderId": "1234567", "requestId": "bacd-13579-awsede-plok", "orderSource": "Walmart", "lines": [ { "lineNbr": 1, "product": [ { "quantity": 1.0, "barcode": "101000384940", "barcodeType": "UPC" }, { "quantity": 3.0, "barcode": "251627353627", "barcodeType": "UPC" } ] } ] }
}
Path Params
string
required
Defaults to 2328273

Specifies the value representing the order for a particular customer order identifier.

Example

2328273

Body Params

Request order update

order
object
required
Headers
string

Specifies the consumer identifier provided by tenants for accessing requests and webhooks.

Walmart Supply Chain as a Service (WSCaaS) will stamp the client identifier based on the consumer identifier.

Example

2d6cf199-9b07-4350-bb2b9-0db3c2

string
required

Specifies the external identifier of the client store.

Example

9221

string

Specifies an optional parameter to get the delivery node number for Hub & Spoke (H&S) or Remote Click and Collect (RCNC) orders.

Example

S465-94

string
required

Specifies the literal and value for Bearer <authenticationToken>.

Example

Bearer eyJraWQiOiI1N…yLTQ4MjctOGUz

string
required

Specifies the literal application/json.

Example

application/json

string

Specifies an optional parameter to indicate the order mode.

A sample value of TRAINING indicates the order belongs to Training Mode.
See Training Mode Features.
If this header is not present, the order will be treated as a production order.

Example

TRAINING

Responses
202

A tenant can subscribe to FAAS_ORDER_AMENDLINES_ACK to track the status

400

Bad Request

Language
Response
Click Try It! to start a request and see the response here!