{ "opencollection": "1.0.0", "info": { "name": "Walmart Cost Management Assortment Recommendations DSV Orders API", "version": "1.0" }, "items": [ { "info": { "name": "DSV Orders", "type": "folder" }, "items": [ { "info": { "name": "Walmart Ship One or More Purchase Order Lines", "type": "http" }, "http": { "method": "POST", "url": "https://api-gateway.walmart.com/v3/orders/:purchaseOrderId/shipping", "headers": [ { "name": "Accept", "value": "application/xml" }, { "name": "WM_CONSUMER.CHANNEL.TYPE", "value": "0f3e4dd4-0514-4346-b39d-…" }, { "name": "WM_QOS.CORRELATION_ID", "value": "6474-a253" }, { "name": "WM_SEC.ACCESS_TOKEN", "value": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM…" }, { "name": "Content-Type", "value": "application/xml" } ], "params": [ { "name": "purchaseOrderId", "value": "2581154514813", "type": "path", "description": "Specifies an identifier associated with the purchase order.\n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" }, { "name": "shipNode", "value": "123456701", "type": "query", "description": "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. The identifier is autogenerated during drop ship vendor (DSV) account creation. Every time users add or update a facility in Supplier Center, a new identifier is generated. Ensure this value is up to date.\n\nExample(s):
\n123456701\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

POST /v3/orders/{purchaseOrderId}/shipping

\n\nThis request allows consumers to ship one or more purchase order (PO) lines. \n\nFor Site to Store (S2S) orders, package and pallet advance ship notices (ASN) need to be included in the request payload.\n\nChanging the status of order lines to `Shipped` triggers a charge to the customer. \nIn order to avoid underselling, orders must be acknowledged before sending a shipping update. \nOnce an or" }, { "info": { "name": "Walmart Cancel Order Lines", "type": "http" }, "http": { "method": "POST", "url": "https://api-gateway.walmart.com/v3/orders/:purchaseOrderId/cancel", "headers": [ { "name": "Accept", "value": "application/xml" }, { "name": "WM_CONSUMER.CHANNEL.TYPE", "value": "0f3e4dd4-0514-4346-b39d-…" }, { "name": "WM_QOS.CORRELATION_ID", "value": "6474-a253" }, { "name": "WM_SEC.ACCESS_TOKEN", "value": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM…" }, { "name": "Content-Type", "value": "application/xml" } ], "params": [ { "name": "purchaseOrderId", "value": "2581154514813", "type": "path", "description": "Specifies an identifier associated with the purchase order.\n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" }, { "name": "shipNode", "value": "123456701", "type": "query", "description": "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. The identifier is autogenerated during drop ship vendor (DSV) account creation. Every time users add or update a facility in Supplier Center, a new identifier is generated. Ensure this value is up to date.\n\nExample(s):
\n123456701\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "

POST /v3/orders/{purchaseOrderId}/cancel

\n\nThis request cancels one or more order lines before an order has been fulfilled. \n\nA `purchaseOrderId` must be included to cancel an order line. \nUpdate the inventory after canceling an order.\n\nThe response to a successful call contains the order with the canceled line item.\n\nSupported cancellation reasons include:\n* SUPPLIER_CANCEL_CUSTOMER_REQUEST\n* SUPPLIER_CANCEL_BACKORDER\n* SUPPLIER_CA" }, { "info": { "name": "Walmart Acknowledge Orders", "type": "http" }, "http": { "method": "POST", "url": "https://api-gateway.walmart.com/v3/orders/:purchaseOrderId/acknowledge", "headers": [ { "name": "Accept", "value": "application/xml" }, { "name": "WM_CONSUMER.CHANNEL.TYPE", "value": "0f3e4dd4-0514-4346-b39d-…" }, { "name": "WM_QOS.CORRELATION_ID", "value": "6474-a253" }, { "name": "WM_SEC.ACCESS_TOKEN", "value": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM…" }, { "name": "Content-Type", "value": "application/xml" } ], "params": [ { "name": "purchaseOrderId", "value": "2581154514813", "type": "path", "description": "Specifies an identifier associated with the purchase order.\n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" }, { "name": "shipNode", "value": "123456701", "type": "query", "description": "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. The identifier is autogenerated during drop ship vendor (DSV) account creation. Every time users add or update a facility in Supplier Center, a new identifier is generated. Ensure this value is up to date.\n\nExample(s):
\n123456701\n" } ] }, "docs": "

POST /v3/orders/{purchaseOrderId}/acknowledge

\n\nThis request allows a drop ship vendor (DSV) to acknowledge an order, including all order lines, preferably within four hours of receipt of the order.\n\nThe response to a successful call contains the acknowledged order. \nAs a good practice, acknowledge orders to avoid underselling.\n\nOnly those orders that are in a `Created` state should be acknowledged. \nOrders that are in an `Acknowled" }, { "info": { "name": "Walmart Retrieve All Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api-gateway.walmart.com/v3/orders", "headers": [ { "name": "Accept", "value": "application/xml" }, { "name": "WM_CONSUMER.CHANNEL.TYPE", "value": "0f3e4dd4-0514-4346-b39d-…" }, { "name": "WM_QOS.CORRELATION_ID", "value": "6474-a253" }, { "name": "WM_SEC.ACCESS_TOKEN", "value": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM…" } ], "params": [ { "name": "shipNode", "value": "123456701", "type": "query", "description": "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. \nThe identifier is autogenerated during drop ship vendor (DSV) account creation. \nEvery time users add or update a facility in Supplier Center, a new identifier is generated. \nEnsure this value is up to date.\n\nExample(s):\n123456701\n" }, { "name": "limit", "value": "100", "type": "query", "description": "Specifies the number of orders to be returned. \n\nThe value cannot be larger than 200.\n\nExample(s):
\n100\n" }, { "name": "sku", "value": "6194456252572", "type": "query", "description": "Specifies the stock keeping unit (SKU) item identifier.\n\nThis identifier is specified by the drop ship vendor (DSV) and used by the vendor in the specification file to refer to each item.\n\nThe following special characters in the stock keeping unit (SKU) require encoding: ':', '/', '?', '#', '[', ']', '@', '!', '$', '&', \"'\", '(', ')', '*', '+', ',', ';', '=', ',', '{', and '}'. '%' requires encoding if it is part of the stock keeping unit (SKU). Encode spaces with %20. Other characters do not require encoding.\n\nExample(s):\n06194456252572\n" }, { "name": "customerOrderId", "value": "6101730068963", "type": "query", "description": "Specifies an identifier associated with the sales orders to retrieve or filter the orders.\n\nExample(s):
\n6101730068963\n" }, { "name": "purchaseOrderId", "value": "2581154514813", "type": "query", "description": "Specifies an identifier associated with the purchase order. \n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" }, { "name": "status", "value": "Created", "type": "query", "description": "Specifies the status of the purchase order line. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Created | The purchase order line has been created. |\n| Acknowledged | The purchase order line has been acknowledged. |\n| Shipped | The purchase order line has been shipped. |\n| Delivered | The purchase order line has been delivered. |\n| Cancelled | The purchase order line has been cancelled. |\n\nExample(s):
\nCreated\n" }, { "name": "createdStartDate", "value": "2023-03-16T10:30:15Z", "type": "query", "description": "Specifies the created start date for the query. \n\nThis query fetches all purchase orders created after this date. \nThe default is the current date minus seven days. \nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-16 \n2023-03-16T10:30:15Z\n" }, { "name": "createdEndDate", "value": "2023-03-19T10:30:15Z", "type": "query", "description": "Specifies the created end date for the query. \n\nThis query fetches all purchase orders created before this date. \nThe default is the current date minus seven days. \nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-19 \n2023-03-19T10:30:15Z\n" }, { "name": "fromExpectedShipDate", "value": "2023-03-20T10:30:15Z", "type": "query", "description": "Specifies the \"from\" expected ship date for the query. \n\nThis query fetches all purchase orders that have order lines with an expected ship date after this date.\nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-20 \n2023-03-20T10:30:15Z\n" }, { "name": "toExpectedShipDate", "value": "2023-03-21T10:30:15Z", "type": "query", "description": "Specifies the \"to\" expected ship date for the query. \n\nThis query fetches all purchase orders that have order lines with an expected ship date before this date.\nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-21\n2023-03-21T10:30:15Z\n" }, { "name": "productInfo", "value": "false", "type": "query", "description": "Specifies the image URL and product weight in the response, if available.\n\nIf `true`, the image URL and product weight are provided in the response.\n\nIf `false`, the image URL and product weight are not provided in the response.\n\nThe value defaults to `false`.\n\nExample(s):
\nfalse\n" } ] }, "docs": "

GET /v3/orders

\n\nThis request retrieves details of all the orders for specified search criteria.\n\nThe search only retrieves orders created in last 180 days. \nA maximum of 20,000 orders can be fetched at a time. \nAttempting to download more than 20,000 orders will return an error.\n" }, { "info": { "name": "Walmart Retrieve a Single Order", "type": "http" }, "http": { "method": "GET", "url": "https://api-gateway.walmart.com/v3/orders/:purchaseOrderId", "headers": [ { "name": "Accept", "value": "application/xml" }, { "name": "WM_CONSUMER.CHANNEL.TYPE", "value": "0f3e4dd4-0514-4346-b39d-…" }, { "name": "WM_QOS.CORRELATION_ID", "value": "6474-a253" }, { "name": "WM_SEC.ACCESS_TOKEN", "value": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM…" } ], "params": [ { "name": "purchaseOrderId", "value": "2581154514813", "type": "path", "description": "Specifies an identifier associated with the purchase order.\n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" }, { "name": "shipNode", "value": "123456701", "type": "query", "description": "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. The identifier is autogenerated during drop ship vendor (DSV) account creation. Every time users add or update a facility in Supplier Center, a new identifier is generated. Ensure this value is up to date.\n\nExample(s):
\n123456701\n" }, { "name": "productInfo", "value": "false", "type": "query", "description": "Specifies the image URL and product weight in the response, if available.\n\nIf `true`, the image URL and product weight are provided in the response.\n\nIf `false`, the image URL and product weight are not provided in the response.\n\nThe value defaults to `true`.\n\nExample(s):
\nfalse\n" } ] }, "docs": "

GET /v3/orders/{purchaseOrderId}

\n\nThis request retrieves order detail as defined by a specific `purchaseOrderId` and `shipNode`.\n\nOnly orders created in last 180 days can be fetched.\n" }, { "info": { "name": "Walmart Retrieve All Released Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api-gateway.walmart.com/v3/orders/released", "headers": [ { "name": "Accept", "value": "application/xml" }, { "name": "WM_CONSUMER.CHANNEL.TYPE", "value": "0f3e4dd4-0514-4346-b39d-…" }, { "name": "WM_QOS.CORRELATION_ID", "value": "6474-a253" }, { "name": "WM_SEC.ACCESS_TOKEN", "value": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM…" } ], "params": [ { "name": "shipNode", "value": "123456701", "type": "query", "description": "Specifies the distribution facility distributor identifier.\n\nThis parameter identifies each facility from which the inventory is requested. \nThe identifier is autogenerated during drop ship vendor (DSV) account creation. \nEvery time users add or update a facility in Supplier Center, a new identifier is generated. \nEnsure this value is up to date.\n\nExample(s):\n123456701\n" }, { "name": "limit", "value": "100", "type": "query", "description": "Specifies the number of orders to be returned. \n\nThe value cannot be larger than 200.\n\nExample(s):
\n100\n" }, { "name": "sku", "value": "6194456252572", "type": "query", "description": "Specifies the stock keeping unit (SKU) item identifier.\n\nThis identifier is specified by the drop ship vendor (DSV) and used by the vendor in the specification file to refer to each item.\n\nThe following special characters in the stock keeping unit (SKU) require encoding: ':', '/', '?', '#', '[', ']', '@', '!', '$', '&', \"'\", '(', ')', '*', '+', ',', ';', '=', ',', '{', and '}'. '%' requires encoding if it is part of the stock keeping unit (SKU). Encode spaces with %20. Other characters do not require encoding.\n\nExample(s):\n06194456252572\n" }, { "name": "customerOrderId", "value": "6101730068963", "type": "query", "description": "Specifies an identifier associated with the sales orders to retrieve or filter the orders.\n\nExample(s):
\n6101730068963\n" }, { "name": "purchaseOrderId", "value": "2581154514813", "type": "query", "description": "Specifies an identifier associated with the purchase order. \n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" }, { "name": "createdStartDate", "value": "2023-03-16T10:30:15Z", "type": "query", "description": "Specifies the created start date for the query. \n\nThis query fetches all purchase orders created after this date. \nThe default is the current date minus seven days. \nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-16 \n2023-03-16T10:30:15Z\n" }, { "name": "createdEndDate", "value": "2023-03-19T10:30:15Z", "type": "query", "description": "Specifies the created end date for the query. \n\nThis query fetches all purchase orders created before this date. \nThe default is the current date minus seven days. \nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-19 \n2023-03-19T10:30:15Z\n" }, { "name": "fromExpectedShipDate", "value": "2023-03-20T10:30:15Z", "type": "query", "description": "Specifies the \"from\" expected ship date for the query. \n\nThis query fetches all purchase orders that have order lines with an expected ship date after this date.\nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-20 \n2023-03-20T10:30:15Z\n" }, { "name": "toExpectedShipDate", "value": "2023-03-21T10:30:15Z", "type": "query", "description": "Specifies the \"to\" expected ship date for the query. \n\nThis query fetches all purchase orders that have order lines with an expected ship date before this date.\nUse either UTC (yyyy-MM-dd) or ISO 8601 (yyyy-MM-dd'T'HH:mm:ssZ) formats. \n\nExample(s):
\n2023-03-21\n2023-03-21T10:30:15Z\n" }, { "name": "productInfo", "value": "false", "type": "query", "description": "Specifies the image URL and product weight in the response, if available.\n\nIf `true`, the image URL and product weight are provided in the response.\n\nIf `false`, the image URL and product weight are not provided in the response.\n\nThe value defaults to `false`.\n\nExample(s):
\nfalse\n" } ] }, "docs": "

GET /v3/orders/released

\n\nThis request retrieves all the orders with line items in `Created` status.\n\nThese orders have been released from the Walmart Order Management System (OMS) to the supplier for processing. \nReleased orders are ready for supplier fulfillment.\n\nOnly orders created in last 180 days can be fetched, and a maximum of 20,000 orders can be fetched and downloaded at a time. \nAttempting to download more than 20,000 ord" } ] } ], "bundled": true }