Walmart Orders API
The Walmart Order Management APIs help Sellers to manage customer's Sales Orders and to stay up-to-date on orders fulfillment, which orders to fulfill, and when to fulfill them.
OpenAPI Specification
openapi: 3.0.1
info:
title: Walmart Order Management
description: The Walmart Order Management APIs help Sellers to manage customer’s Sales Orders and to stay up-to-date on orders fulfillment, which orders to fulfill, and when to fulfill them.
servers:
- url: https://marketplace.walmartapis.com
description: Production URL
- url: https://sandbox.walmartapis.com
description: Sandbox URL
security:
- basicScheme: []
paths:
"/v3/orders/{purchaseOrderId}/shipping":
post:
tags:
- Orders
summary: Walmart Ship Order Lines
description: Updates the status of order lines to Shipped and trigger the charge to the customer. The response to a successful call contains the order with the shipped line items.
operationId: shippingUpdates
parameters:
- name: purchaseOrderId
in: path
description: purchaseOrderId
required: true
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: File fields
content:
application/json:
schema:
type: object
properties:
orderShipment:
required:
- orderLines
type: object
properties:
processMode:
type: string
description: Optional. Use this parameter only to update tracking information after order is shipped. Use 'PARTIAL_UPDATE' as value. Here PARTIAL_UPDATE will indicate that post shipment tracking information needs to be updated
orderLines:
required:
- orderLine
type: object
properties:
orderLine:
type: array
description: Information about one order line shipment
items:
required:
- lineNumber
- orderLineStatuses
- sellerOrderId
type: object
properties:
lineNumber:
type: string
description: The line number associated with the details for each individual item in the purchase order
intentToCancelOverride:
type: boolean
description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer
default: false
sellerOrderId:
type: string
description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters
orderLineStatuses:
required:
- orderLineStatus
type: object
properties:
orderLineStatus:
type: array
description: Details about the Order Line status
items:
required:
- status
- statusQuantity
- trackingInfo
type: object
properties:
status:
type: string
description: Use 'Shipped'
enum:
- Created
- Acknowledged
- Shipped
- Delivered
- Cancelled
- Refund
asn:
required:
- packageASN
type: object
properties:
packageASN:
type: string
palletASN:
type: string
statusQuantity:
required:
- amount
- unitOfMeasurement
type: object
properties:
unitOfMeasurement:
type: string
description: Unit of quantity
enum:
- EACH
- EA
amount:
type: string
description: The quantity of the unit of measurement for the item.
description: Details about the status update
trackingInfo:
required:
- carrierName
- methodCode
- shipDateTime
- trackingNumber
type: object
properties:
shipDateTime:
type: integer
description: The date the package was shipped
format: int64
carrierName:
type: object
properties:
otherCarrier:
type: string
description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided
carrier:
type: string
description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.'
enum:
- UPS
- USPS
- FedEx
- Airborne
- OnTrac
- DHL Ecommerce - US
- DHL
- LS
- UDS
- UPSMI
- FDX
- PILOT
- ESTES
- SAIA
- FDS Express
- Seko Worldwide
- HIT Delivery
- FEDEXSP
- RL Carriers
- Metropolitan Warehouse & Delivery
- China Post
- YunExpress
- Yellow Freight Sys
- AIT Worldwide Logistics
- Chukou1
- Sendle
- Landmark Global
- Sunyou
- Yanwen
- 4PX
- GLS
- OSM Worldwide
- FIRST MILE
- AM Trucking
- CEVA
- India Post
- SF Express
- CNE
- TForce Freight
- AxleHire
- LSO
- Royal Mail
- ABF Freight System
- WanB
- Roadrunner Freight
- Meyer Distribution
- AAA Cooper
- Canada Post
- Southeastern Freight Lines
- Japan Post
- Correos de Mexico
- XPO Logistics
- JD Logistics
- YDH
- JCEX
- Flyt
- Deutsche Post
- Better Trucks
- Asendia
- SFC
- UBI
- ePost Global
- YF Logistics
- RXO
- Estes Express
- Shypmax
- WIN.IT America
- PITT OHIO
- PostNord Sweden
- Equick
- Whistl
- Tusou
- Shiprocket
- DTDC
- PTS
description: Information about the package carrier(s)
methodCode:
type: string
description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight'
enum:
- Standard
- Express
- OneDay
- Freight
- WhiteGlove
- Value
trackingNumber:
type: string
description: The shipment tracking number
trackingURL:
type: string
description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used
description: List of information about the package shipment and tracking updates
returnCenterAddress:
required:
- address1
- city
- country
- postalCode
- state
type: object
properties:
name:
type: string
description: The name for the person/place of return address
address1:
type: string
description: The first line of the return address
address2:
type: string
description: The second line of the return address
city:
type: string
description: The city of the return address
state:
type: string
description: The state of the return address
postalCode:
type: string
description: The zip code of the return address
country:
type: string
description: The country of the return address
dayPhone:
type: string
description: Phone of the center where the package shipment is returned
emailId:
type: string
description: Email of the center where the package shipment is returned
description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified
currentTrackingInfo:
type: object
properties:
trackingNumber:
type: string
description: The shipment tracking number
description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field.
description: Details about the Order Line status
description: A list of status updates for that orderLine, including shipping status updates
sellerOrderNo:
type: string
writeOnly: true
description: Information about one order line shipment
description: List of orderLines in the shipment
description: Information about a shipment
xml:
name: orderShipment
example:
orderShipment:
orderLines:
orderLine:
- lineNumber: '1'
intentToCancelOverride: false
sellerOrderId: '92344'
orderLineStatuses:
orderLineStatus:
- status: Shipped
statusQuantity:
unitOfMeasurement: EACH
amount: '1'
trackingInfo:
shipDateTime: 1580821866000
carrierName:
carrier: UPS
methodCode: Standard
trackingNumber: '22344'
trackingURL: http://walmart/tracking/ups?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92345
returnCenterAddress:
name: walmart
address1: walmart store 2
city: Huntsville
state: AL
postalCode: '35805'
country: USA
dayPhone: '12344'
emailId: [email protected]
- lineNumber: '2'
sellerOrderId: '92344'
orderLineStatuses:
orderLineStatus:
- status: Shipped
statusQuantity:
unitOfMeasurement: EACH
amount: '1'
trackingInfo:
shipDateTime: 1580821866000
carrierName:
carrier: FedEx
methodCode: Express
trackingNumber: '22344'
trackingURL: http://walmart/tracking/fedEx?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92344
returnCenterAddress:
name: walmart
address1: walmart store 2
city: Huntsville
state: AL
postalCode: '35805'
country: USA
dayPhone: '12344'
emailId: [email protected]
application/xml:
schema:
type: object
properties:
orderShipment:
required:
- orderLines
type: object
properties:
processMode:
type: string
description: Optional. Use this parameter only to update tracking information after order is shipped. Use 'PARTIAL_UPDATE' as value. Here PARTIAL_UPDATE will indicate that post shipment tracking information needs to be updated
orderLines:
required:
- orderLine
type: object
properties:
orderLine:
type: array
description: Information about one order line shipment
items:
required:
- lineNumber
- orderLineStatuses
- sellerOrderId
type: object
properties:
lineNumber:
type: string
description: The line number associated with the details for each individual item in the purchase order
intentToCancelOverride:
type: boolean
description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer
default: false
sellerOrderId:
type: string
description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters
orderLineStatuses:
required:
- orderLineStatus
type: object
properties:
orderLineStatus:
type: array
description: Details about the Order Line status
items:
required:
- status
- statusQuantity
- trackingInfo
type: object
properties:
status:
type: string
description: Use 'Shipped'
enum:
- Created
- Acknowledged
- Shipped
- Delivered
- Cancelled
- Refund
asn:
required:
- packageASN
type: object
properties:
packageASN:
type: string
palletASN:
type: string
statusQuantity:
required:
- amount
- unitOfMeasurement
type: object
properties:
unitOfMeasurement:
type: string
description: Unit of quantity
enum:
- EACH
- EA
amount:
type: string
description: The quantity of the unit of measurement for the item.
description: Details about the status update
trackingInfo:
required:
- carrierName
- methodCode
- shipDateTime
- trackingNumber
type: object
properties:
shipDateTime:
type: integer
description: The date the package was shipped
format: int64
carrierName:
type: object
properties:
otherCarrier:
type: string
description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided
carrier:
type: string
description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.'
enum:
- UPS
- USPS
- FedEx
- Airborne
- OnTrac
- DHL Ecommerce - US
- DHL
- LS
- UDS
- UPSMI
- FDX
- PILOT
- ESTES
- SAIA
- FDS Express
- Seko Worldwide
- HIT Delivery
- FEDEXSP
- RL Carriers
- Metropolitan Warehouse & Delivery
- China Post
- YunExpress
- Yellow Freight Sys
- AIT Worldwide Logistics
- Chukou1
- Sendle
- Landmark Global
- Sunyou
- Yanwen
- 4PX
- GLS
- OSM Worldwide
- FIRST MILE
- AM Trucking
- CEVA
- India Post
- SF Express
- CNE
- TForce Freight
- AxleHire
- LSO
- Royal Mail
- ABF Freight System
- WanB
- Roadrunner Freight
- Meyer Distribution
- AAA Cooper
- Canada Post
- Southeastern Freight Lines
- Japan Post
- Correos de Mexico
- XPO Logistics
- JD Logistics
- YDH
- JCEX
-
# --- truncated at 32 KB (2650 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/walmart/refs/heads/main/openapi/walmart-marketplace-orders-openapi-original.yml