Update Order Request

patch

https://developer.api.us.stg.walmart.com/v1/orders/{orderId}

This request updates order attributes (like pickup person, delivery address, and more) and converts a pickup order to a delivery order and a delivery order to a pickup order.

Path Params

orderId

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

Specifies an object for the order.

Headers

WM.CONSUMER_ID

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

X-storeId

string

required

Specifies the external identifier of the client store.

Example

9221

X-destinationStoreId

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

Authorization

string

required

Specifies the literal and value for Bearer <authenticationToken>.

Example

Bearer eyJraWQiOiI1N…yLTQ4MjctOGUz

Content-Type

string

required

Specifies the literal application/json.

Example

application/json

ORDER_MODE

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_UPDATE_ACK to track the status.

500

Server Error

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request