API Reference
My Account

Create or cancel an order

post
https://example.com/v1/orders

This request initiates the process of order creation or cancellation.

Body Params
string
required

The external order ID. This is a partner-supplied ID.

string
required

The parent identifier of the store.

string
required

The source of the order. This must be one of the following allowed values.

Allowed values: "Online"

string
required

The status of the order. This must be one of the following allowed values.

Allowed values: "NEW", "CANCELLED"

string

The name of the preferred carrier for express delivery. The set of eligible carriers is determined by the client.

string

The time at which an express delivery will be ready for driver pickup. Specify a UTC date and time in ISO 8601 format.

This value is mandatory for delivery orders. Delivery orders have an order_service value of "D" or "PD".

Example: "2024-02-23T08:31:00"

string

The start of the allowed window of time for order delivery. Specify a UTC date and time in ISO 8601 format.

This value is mandatory for delivery orders. Delivery orders have an order_service value of "D" or "PD".

Example: "2024-02-23T09:00:00"

string

The end of the allowed window of time for order delivery. Specify a UTC date and time in ISO 8601 format.

This value is mandatory for delivery orders. Delivery orders have an order_service value of "D" or "PD".

Example: "2024-02-23T09:30:00"

customer_contact_info
object
required

An object that provides contact information for a customer.

order_price_info
object
required

An object that provides information on the cost of the order, including totals, taxes, and bag and delivery fees.

items
array of objects
required

A list of the items that are included in the order, by item ID.

items*
delivery_instructions
array of objects

The instructions for delivery of the order.

delivery_instructions
order_summary
object

An object that represents an order by total weight and special handling requirements.

This value is mandatory for delivery orders. Delivery orders have an order_service value of "D" or "PD".

cancel_details
object

Additional information about the cancellation, if available.

string
enum
required

The marketplace that is the source of the order.
This must be one of the following country or region codes, specified in conformance with ISO 3166.

CodeCountry or Region
USUnited States
UKUnited Kingdom
EUEuropean Union
Allowed:
delivery_details
object

The delivery address, including the latitude and longitude of the location.

This value is mandatory for delivery orders. Delivery orders have an order_service value of "D" or "PD".

string
required

The ISO 639 language code that is associated with the order.

Examples: "en-us", "fr-ca", "hi-in"

string
enum
required

The order service required for the order.
This must be one of the following values.

ValueOrder Service
"P"Picking
"D"Delivery
"PD"Picking and delivery
"W"White Label
Allowed:
string

The due time for order delivery. Specify a UTC date and time in ISO 8601 format.

This value is mandatory for picking orders. Picking orders have an order_service value of "P" or "PD".

Examples: 2024-02-23T09:30:00

string

The URL that is used to track the delivery of the order. The URL shows the location of the driver.

string

The unique identifier of the delivery order. The identifier is provided by the delivery partner.

string

The unique identifier of the quotation. The identifier is provided by the carrier.

This value is mandatory for white label orders. White label orders have an order_service value of "W".

string

The unique identifier of the customer. The identifier is provided by the retailer.

This value is mandatory for white label orders. White label orders have an order_service value of "W".

string

Specify the action for the courier to take on a delivery. This must be one of the following values.

This value is optional and applies only to white label orders and select carriers. White label orders have an order_service value of "W".

ValueAction
"deliverable_action_meet_at_door"Meet-at-door delivery. This is the default if deliverable_action is not set.
"deliverable_action_leave_at_door"The preferred action for the courier to take on a delivery. When used, undeliverable_action can be set to "leave_at_door" for contactless delivery. The order cannot be left at the door if signature or ID verification requirements were applied when the delivery was created. Photo confirmation of delivery is required to complete order drop-off.
string

Specify the action for the courier to take on an undeliverable order. This must be one of the following values.

This value is optional and applies only to white label orders and select carriers. White label orders have an order_service value of "W".

ValueAction
"leave_at_door"This action is taken when the customer is not available to receive a normal delivery. In this case, the courier is requested to leave the package at a dropoff location. Note: (1) An order cannot be set to "leave at door" when signature, PIN, or ID verification requirements are applied when the deliver is created; and, (2) Photo confirmation of delivery is required to complete order drop-off.
"return"This action is taken when the customer is not available to receive a normal delivery. In this case, the courier is requested to return the package back to the pickup location. If deliverable_action is set to "leave at door", the courier is given the option to return the package to the pickup location if circumstances dictate.
"discard"This action is taken when a package cannot be delivered. In this case, the courier is allowed to keep or discard the package if it cannot be delivered.
delivery_verification
object

The steps that must be taken to verify delivery before dropoff is complete. These typically include picture or pincode.

This value is optional and only applies to white label orders and select carriers. White label orders have an order_service value of "W".

Headers
string
required

The Walmart consumer identifier (ID) of the tenant. The tenant must submit this ID in the header of every request.

Example:

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

Response

Updated about 1 year ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
Updated about 1 year ago