The Direct Shipment Capture (DSC) API allows DSD Suppliers to send details about planned, started, en route, and arrived shipments, to help ensure a more efficient receiving process within a Walmart store.
New Version Available
This is reference details for DSC v1. To onboard to the latest version please see our v2 Get Started guide.
Endpoints
POST
/store/directshipment
Request Body Details
| Parameter | Mandatory | Description | Data Type |
|---|---|---|---|
| messageId | Yes | A unique reference identifier for the message that can be used for tracing API requests. This is a generally a UUID but can be any unique value up to 36 characters. | String |
| eventCreationTime | Yes | The system time from the supplier of when the event was created, in Epoch format (ms). | Integer |
| eventType | Yes | A unique identifier for the type of action that is being taken. Note: Only the events below will be accepted, and they are case sensitive. PLANNED - Use when the shipment is first planned, but has not left the originating facility. STARTED - Use when the shipment leaves the originating facility. ENROUTE - Use when the shipment is en route to a specific Walmart store. ARRIVED - Use when the shipment has arrived at a specific Walmart store. | String |
| trailerNbr | No | The identifier for the trailer. | String |
| destinations | Yes | An array containing information about the Walmart store and the shipment. Only one destination is allowed. | Array |
| shipmentDeliverydate | Yes | The Date the shipment will arrive at a Walmart store, in YYYY-MM-DD format. | Date |
| storeNbr | Yes | The Walmart store number for the shipment. | String |
| loads | Yes | An array containing information about the shipment contents. | Array |
| asn | No | The Advance Shipment Notice associated with the load. | String |
| packNbr | Yes | The pack or SSCC number which indicates what products are packed together for shipment. | String |
| shipment | Yes | An object containing shipment details. | Object |
| locationArea | Yes | The location where the shipment will be dropped off, e.g. BACKROOM. | String |
| palletQty | No | The number of pallets associated with the shipment. | Integer |
| caseQty | No | The number of cases associated with the shipment. | Integer |
| toteQty | No | The number of totes associated with the shipment. | Integer |
| itemization | No | An array of GTINs and quantities associated with the shipment. | Array |
| gtin | No | The 14 digit GTIN of the shipped item. | String |
| qty | No | The quantity of the shipped GTIN. | Float |
| etaWindow | Yes (for planned, started, enroute events) | An object that contains the earliest and latest ETAs for the shipment. Only applicable for planned, started, and enroute events. | Object |
| earliestEta | Yes (for planned, started, enroute events) | Earliest possible ETA in UTC format, e.g. 2024-10-17T16:30+0000Z (where "+0000Z" is not changed, i.e. do not provide the timezone offset). Only for planned, started, enroute events. | UTC Date/time |
| latestEta | Yes (for planned, started, enroute events) | Latest possible ETA in UTC format, e.g. 2024-10-17T16:30+0000Z (where "+0000Z" is not changed, i.e. do not provide the timezone offset) Only for planned, started, enroute events. | UTC Date/time |
| arrivalTime | Yes (for arrived events) | Actual time of the truck arrival in UTC format, e.g. 2024-10-17T16:30+0000Z (where "+0000Z" is not changed, i.e. do not provide the timezone offset). Only for arrived events. | UTC Date/time |
©️Walmart | All Rights Reserved | Confidential
