--- updatedAt: 2026-04-12T09:22:47.000Z --- # Retrieve all orders This request retrieves all open purchase orders and purchase orders closed and canceled within the last 30 days and their relevant details. Use the appropriate query parameters to filter the purchase orders in the returned list. All query parameters are optional. Calls to this endpoint return 50 purchase orders by default. You can specify a minimum of 1 order and a maximum of 100 orders per API call. [block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "termsOfService": "http://swagger.io/terms/", "title": "Order Management", "description": "The Walmart Order Management APIs allow suppliers to integrate native applications with Walmart data to get near real-time updates directly from the Walmart Orders system.", "version": "2.0", "contact": { "name": "Contact", "email": "contact@email.com" } }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false, "explorer-enabled": true }, "servers": [ { "url": "https://api-gateway.walmart.com", "description": "Production URL" }, { "url": "https://sandbox.walmartapis.com", "description": "Sandbox URL" } ], "tags": [ { "name": "Orders", "description": "The Walmart Order Management APIs allow you to integrate your native applications with Walmart data to get near real-time updates directly from the Walmart Orders system.\nThe Order Management APIs provide data for Walmart U.S. purchase orders for both ecommerce and stores.\n\nThe Order Management APIs do not include Drop Ship Vendor (DSV) orders.\nFor information about Drop Ship Vendor orders, see the [Drop Ship Vendor (DSV) Order Management API Overview](/suppliers/docs/drop-ship-vendor-dsv-order-management-api-overview)." } ], "paths": { "/v3/walmartOrders": { "get": { "tags": [ "Orders" ], "operationId": "getAllWalmartPurchaseOrders", "summary": "Retrieve all orders", "description": "This request retrieves all open purchase orders and purchase orders closed and canceled within the last 30 days and their relevant details.\n\nUse the appropriate query parameters to filter the purchase orders in the returned list.\nAll query parameters are optional.\n\nCalls to this endpoint return 50 purchase orders by default.\nYou can specify a minimum of 1 order and a maximum of 100 orders per API call.", "parameters": [ { "in": "query", "name": "purchaseOrderID", "required": false, "schema": { "type": "string" }, "description": "Walmart-issued unique identifier of the purchase order.", "example": "123456789" }, { "in": "query", "name": "hostPurchaseOrderId", "required": false, "schema": { "type": "string" }, "description": "Unique identifier of the host purchase order that created this purchase order.", "example": "3732492413" }, { "in": "query", "name": "type", "required": false, "schema": { "type": "string", "enum": [ "0", "3", "5", "6", "7", "10", "11", "12", "13", "14", "15", "16", "17", "20", "22", "23", "33", "37", "40", "42", "43", "45", "46", "50", "53", "63", "70", "73", "77", "83", "93" ] }, "description": "Walmart-issued purchase order code that identifies the purchase order type.\n\nValid values include, but are not limited to:\n\n| Value | Meaning |\n| ----- | ------------------------ |\n| 3 | GENERAL DISTRIBUTION |\n| 7 | GENERAL SHIP BILL |\n| 20 | REBUY REGULAR |\n| 22 | REBUY SEASONAL |\n| 33 | ASSEMBLY DISTRIBUTION |\n| 37 | ASSEMBLY SHIP AND BILL |\n| 40 | IMPORT REBUY REGULAR |\n| 42 | IMPORT REBUY SEASONAL |\n| 43 | IMPORT DISTRIBUTION |\n| 53 | TAB DISTRIBUTION |\n| 73 | STORE REPLN DISTRIBUTION |\n| 77 | FITSPRO |", "example": "3" }, { "in": "query", "name": "purchaseOrderStatus", "required": false, "schema": { "type": "string", "enum": [ "ACTIVE", "CANCELLED", "CLOSED", "SPLIT_IMPORT" ] }, "description": "Status of the purchase order.\n\nValid values are:\n\n| Value | Meaning |\n| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |\n| ACTIVE | Status of a newly created purchase order that has not yet been fulfilled. Suppliers can request edits to purchase orders when in active status. |\n| CANCELLED | Status of the purchase order that is no longer in progress, but none of the purchase order lines have been fulfilled by the supplier. |\n| CLOSED | Status of the purchase order that is no longer in progress and the lines in the purchase order have been fulfilled. |\n| SPLIT_IMPORT | Indicates the import order was split up into smaller orders. |", "example": "ACTIVE" }, { "in": "query", "name": "purchaseOrderSupplyChainStatus", "required": false, "schema": { "type": "string" }, "description": "Status of the purchase order in the supply chain.\n\nValid values for domestic and distribution center purchase orders are:\n\n| Value | Meaning |\n| --------- | ---------------------------------- |\n| CANCELLED | Indicates the order was cancelled. |\n| CLOSED | Indicates the order was closed. |\n| OPEN | Indicates the order was opened. |\n| RECEIVED | Indicates the order was received. |\n\nValid values for import purchase orders are:\n\n| Value | Meaning |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| AT_PORT | Indicates the order is at a port. |\n| CANCELLED | Indicates the order was cancelled. |\n| CLOSED | Indicates the order was closed. |\n| GATED_IN | Indicates a container has been unloaded from a ship and moved to an internal storage space in the distribution center (DC). In the DC, containers are initially stored in an external storage space (gated out) and later moved to an internal storage space (gated in). |\n| RECEIVED | Indicates the order was received. |\n| SAILING_MESSAGE | Indicates the cargo is sailing on the ship. |", "example": "OPEN" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "type": "string" }, "description": "Returns purchase orders created after the specified date and time.", "example": "2025-07-29T13:00:00.000Z" }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "type": "string" }, "description": "Returns purchase orders created before the specified date and time.", "example": "2025-09-01T13:00:00.000Z" }, { "in": "query", "name": "mustArriveByDateAfter", "required": false, "schema": { "type": "string" }, "description": "Returns purchase orders that must arrive after the specified date and time.", "example": "2025-07-29T13:00:00.000Z" }, { "in": "query", "name": "mustArriveByDateBefore", "required": false, "schema": { "type": "string" }, "description": "Returns purchase orders that must arrive before the specified date and time.", "example": "2025-07-29T13:00:00.000Z" }, { "in": "query", "name": "limit", "schema": { "type": "string" }, "description": "Limits the number of returned results. Valid values are 1-100.", "example": "50" }, { "in": "query", "name": "nextCursor", "schema": { "type": "string" }, "description": "Indicates a value that allows users to retrieve the next set of records in the query response.\n\n`nextCursor` is the preferred pagination mechanism for this API.", "example": "123456789" }, { "in": "header", "name": "accept", "required": false, "schema": { "type": "string" }, "description": "Data type expected in a response sent from the server.\n\nValid values are:\n\n| Value | Meaning |\n| ---------------- | ------------------------------------------ |\n| application/json | JSON format for data returned in response. |", "example": "application/json" }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "required": false, "schema": { "type": "string" }, "description": "Identifier that tracks the consumer request by channel.\n\nUse the consumer channel type provided by Walmart during your onboarding.\nSee your system administrator or developer management for the `WM_CONSUMER.CHANNEL.TYPE` value.", "example": "0f3e4dd4-0514-4346-b39d" }, { "in": "header", "name": "WM_QOS.CORRELATION_ID", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for each API call, used to track and debug issues.", "example": "6474-a253" }, { "in": "header", "name": "wm_sec.access_token", "required": true, "schema": { "type": "string" }, "description": "Access token returned by the [Create access token request](https://developer.walmart.com/suppliers/reference/postcreateanaccesstoken).\n\nRequired for token-based authentication.", "example": "eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "purchaseOrdersListMeta": { "type": "object", "description": "Contains information related to the list of purchase orders displayed in the response.", "properties": { "totalCount": { "type": "integer", "description": "Total number of purchase orders for the supplier with the request and given parameters.", "example": 1 }, "limit": { "type": "integer", "description": "Limits the number of purchase orders returned in the current response.", "example": 100 }, "nextCursor": { "type": "string", "description": "Value used to retrieve the next set of purchase orders, when more purchase orders are received than can be displayed in a single response.", "example": "123456789 , *" } } }, "purchaseOrders": { "type": "array", "description": "Contains purchase order details.", "items": { "type": "object", "properties": { "purchaseOrderId": { "type": "string", "description": "Walmart-issued unique identifier of the purchase order.", "example": "885653369" }, "hostPurchaseOrderId": { "type": "string", "description": "Unique identifier for the host purchase order that created this purchase order.", "example": "3732492413" }, "purchaseOrderStatus": { "type": "string", "enum": [ "ACTIVE", "CANCELLED", "CLOSED", "SPLIT_IMPORT" ], "description": "Indicates the status of the purchase order.\n\nValid values are:\n\n| Value | Meaning |\n| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| ACTIVE | Status of a newly created purchase order that has not yet been fulfilled. Suppliers can request edits to purchase orders when in active status. |\n| CANCELLED | Status of the purchase order that is no longer in progress, but none of the purchase order lines have been fulfilled by the supplier. |\n| CLOSED | Status of the purchase order that is no longer in progress and the lines in the purchase order have been fulfilled. |\n| SPLIT_IMPORT | Indicates the import order was split up into smaller orders. |", "example": "ACTIVE" }, "purchaseOrderSupplyChainStatus": { "type": "string", "description": "Status of the purchase order in the supply chain.\n\nValid values for domestic and distribution center purchase orders are:\n\n| Value | Meaning |\n| --------- | ---------------------------------- |\n| CANCELLED | Indicates the order was cancelled. |\n| CLOSED | Indicates the order was closed. |\n| OPEN | Indicates the order was opened. |\n| RECEIVED | Indicates the order was received. |\n\nValid values for import purchase orders are:\n\n| Value | Meaning |\n| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| AT_PORT | Indicates the order is at a port. |\n| CANCELLED | Indicates the order was cancelled. |\n| CLOSED | Indicates the order was closed. |\n| GATED_IN | Indicates a container has been unloaded from a ship and moved to an internal storage space in the distribution center (DC). In the DC, containers are initially stored in an external storage space (gated out) and later moved to an internal storage space (gated in). |\n| RECEIVED | Indicates the order was received. |\n| SAILING_MESSAGE | Indicates the cargo is sailing on the ship. |", "example": "OPEN" }, "createDate": { "type": "string", "format": "dateTime", "description": "Original date and time, in ISO 8601 format, specifying when the purchase order was created.", "example": "2024-12-17T20:53:40Z" }, "createdBy": { "type": "string", "description": "Username of the system or merchant user who created the purchase order.", "example": "dsikes" }, "lastChangeDate": { "type": "string", "format": "dateTime", "description": "Date and time, in ISO 8601 format, when the purchase order was last modified.", "example": "2025-07-17T20:00:00Z" }, "createdReason": { "type": "string", "description": "Reason why the request was created.", "example": "Business Decision" }, "eventCode": { "type": "string", "description": "Code for special events, such as holidays.", "example": "NEWMODWK50" }, "otherPOsToShipWith": { "type": "array", "description": "List of other purchase orders shipping with the current order.\n\nReturns a null array for:\n\n* Manual orders for prepaid suppliers that do not have load optimization\n* Lower-volume non-truck load orders", "items": { "type": "string", "description": "Walmart-issued unique identifier of the purchase order.", "example": "123456789" }, "example": [ "1044115236", "1044086327", "1044134477", "1044132862", "1044086300" ] }, "supplierInformation": { "type": "object", "description": "Contains information related to the supplier receiving the purchase order.", "properties": { "supplierId": { "type": "integer", "description": "Nine-digit supplier number.\n\nThis value is a combination of the six-digit supplier number, two-digit department number, and one-digit sequence number.", "example": 123456789 }, "supplierName": { "type": "string", "description": "Name of the supplier with whom Walmart placed the purchase order.", "example": "Supplier 123" }, "importFactoryId": { "type": "integer", "description": "Identifier of the factory that manufactured the imported items.", "example": 0 }, "vendorId": { "type": "string", "description": "Unique identifier of the vendor.", "example": "123456" } } }, "purchaseOrderInformation": { "type": "object", "description": "Contains purchase order details.", "properties": { "type": { "type": "string", "description": "Walmart-issued purchase order code that identifies the purchase order type.\n\nValid values include, but are not limited to:\n\n| Value | Meaning |\n| ----- | ------------------------ |\n| 3 | GENERAL DISTRIBUTION |\n| 7 | GENERAL SHIP BILL |\n| 20 | REBUY REGULAR |\n| 22 | REBUY SEASONAL |\n| 33 | ASSEMBLY DISTRIBUTION |\n| 37 | ASSEMBLY SHIP AND BILL |\n| 40 | IMPORT REBUY REGULAR |\n| 42 | IMPORT REBUY SEASONAL |\n| 43 | IMPORT DISTRIBUTION |\n| 53 | TAB DISTRIBUTION |\n| 73 | STORE REPLN DISTRIBUTION |\n| 77 | FITSPRO |", "example": "3" }, "source": { "type": "string", "description": "Indicates if the purchase order is for domestic or imported goods.\n\nValid values are:\n\n| Value | Meaning |\n| ----------- | ------------------------------------------- |\n| domestic_po | Internal, not international, purchase order |\n| import_po | International purchase order |", "example": "domestic_po" }, "channelMethod": { "type": "string", "description": "Fulfillment method for the purchase order.\n\nValid values are:\n\n| Value | Meaning |\n| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Crossdock | Items ordered are delivered to a Walmart distribution center or consolidation center. The items are directly loaded on outbound trailers at distribution centers and delivered to stores. |\n| Direct Store Delivery | Items ordered are shipped directly from the supplier to a store. Direct store delivery (DSD) purchase orders do not flow through or to warehouses. |\n| Direct Store Delivery Consolidation | Items are delivered to a regional distribution center (RDC). |\n| Staplestock | Items are distributed directly to a Walmart distribution center or fulfillment center. These items physically reside at the distribution centers. |", "example": "Crossdock" }, "storeDistribution": { "type": "boolean", "description": "Indicates whether or not the purchase order will be distributed to stores.\n\nOnly the following purchase order types are distributed to stores: `3`, `33`, `43`, `53`, `73`, and `77`.", "example": true }, "freightTerms": { "type": "string", "description": "Shipping method terms the supplier uses to fulfill the purchase order.\n\nValid values are:\n\n| Value | Meaning |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Collect | Walmart is responsible for scheduling the carriers and transporting the product. Walmart is also responsible for the cost of transporting the goods. |\n| Prepaid | The supplier owns the product until it is received at Walmart's distribution centers. While prepaid suppliers are responsible for the cost of transportation, they are also able to choose their preferred carrier. |", "example": "Prepaid" }, "warehouseArea": { "type": "string", "description": "Designated storage or processing zone within a distribution center or fulfillment center where the goods are intended to be received, staged, stored, or processed.", "example": "1A - GROCRY" }, "transportationMethod": { "type": "string", "description": "Method of transportation used to move goods from the supplier to the Walmart destination facility.", "enum": [ "truck", "rail", "ocean", "air" ], "example": "truck" }, "contractedCarrier": { "type": "string", "description": "Transportation provider that Walmart has formally contracted to handle the shipment of goods from the supplier to a Walmart facility.", "example": "Acme Freight" }, "loadType": { "type": "string", "description": "Indicates how the freight is organized or structured for transport.", "example": "" }, "domesticImportIndicator": { "type": "string", "description": "Indicates if the purchase order is for domestic or imported goods.", "enum": [ "Domestic", "Import" ], "example": "Domestic" }, "backhaulIndicator": { "type": "string", "description": "Indicates if Walmart's private fleet or contracted carrier picked up product from a supplier location after completing a delivery to a store or distribution center, rather than returning empty.", "enum": [ "Yes", "No" ], "example": "No" }, "purchaseOrderComments": { "type": "array", "description": "Array of comments on the purchase order, entered by Walmart or the vendor, to provide additional information.", "items": { "type": "object", "description": "Contains a comment on the purchase order, entered by Walmart or the vendor, to provide additional information.", "properties": { "commentType": { "type": "string", "description": "Originator of a comment on the purchase order.", "example": "Vendor" }, "comment": { "type": "string", "description": "Manual comment on the purchase order, entered by Walmart or the vendor, to provide additional information.", "example": "Transmission HOLD" } }, "example": { "commentType": "Vendor", "comment": "Transmission HOLD" } }, "example": [ { "commentType": "Vendor", "comment": "Transmission HOLD" } ] }, "globalLocationNumber": { "type": "string", "description": "13-digit global location number used by Walmart to identify specific locations in the supply chain.", "example": "0123456789012" }, "parentCompany": { "type": "string", "description": "Legal or corporate entity that owns or oversees the vendor or supplier fulfilling the purchase orders.", "example": "Walmart Stores Inc" }, "entryMethod": { "type": "string", "description": "Indicates whether the purchase order was generated automatically, manually, or through an external system like Electronic Data Interchange (EDI).", "example": "Systematic" } } }, "buyerId": { "type": "array", "description": "List of buyer identifiers associate with a purchase order.", "items": { "type": "string", "description": "Identifier of the Walmart buyer who placed the purchase order.", "example": "B0T071V" }, "example": [ "B0T071V" ] }, "totalQuantityOrdered": { "type": "object", "description": "Contains information about the total quantity of all items in the purchase order.", "properties": { "vendorPacks": { "type": "integer", "description": "Number of units in the purchase order.", "example": 16 }, "warehousePacks": { "type": "integer", "description": "Number of warehouse packs in the purchase order.\nAlso known as break packs.\n\nWalmart will break the pack into the orderable units to distribute the items.", "example": 64 }, "sellableUnits": { "type": "integer", "description": "Number of units in the purchase order to be sold to Walmart customers.\nAlso known as consumable units.", "example": 384 } } }, "totalQuantityReceived": { "type": "object", "description": "Contains details about the total quantity of all units Walmart received in the purchase order.", "properties": { "vendorPacks": { "type": "integer", "description": "Number of units in the purchase order.", "example": 0 }, "warehousePacks": { "type": "integer", "description": "Number of warehouse packs that were ordered.\nAlso known as break packs.\n\nWalmart will break the pack into the orderable units to distribute the items.", "example": 0 }, "sellableUnits": { "type": "integer", "description": "Number of units in the purchase order to be sold to Walmart customers.\nAlso known as consumable units.", "example": 0 } } }, "totalCost": { "type": "number", "description": "Total cost of the purchase order.\nAlso known as the *net first cost*.", "example": 11508.48 }, "totalCostUOM": { "type": "string", "description": "Currency code for the total cost of the purchase order.", "example": "USD" }, "totalWeight": { "type": "number", "description": "Total weight of all the items present in the purchase order.", "example": 115.984 }, "totalWeightUOM": { "type": "string", "description": "Unit of measure for the total weight of all the items present in the purchase order.", "example": "LB" }, "totalCube": { "type": "number", "description": "Total cubic dimensions of all the items present in the purchase order.", "example": 115.984 }, "totalCubeUOM": { "type": "string", "description": "Unit of measure for the cubic dimensions of all the items present in the purchase order.", "example": "CF" }, "shippingInformation": { "type": "object", "description": "Contains purchase order shipping information.", "properties": { "mustArriveByDate": { "type": "string", "description": "Date, in ISO 8601 format, when all items in the purchase order must arrive at the destination node defined in the purchase order.", "example": "2025-01-06" }, "originalMustArriveByDate": { "type": "string", "description": "Date, in ISO 8601 format, when all items in the purchase order must arrive at the destination node defined in the purchase order.", "example": "2025-01-06" }, "mustArriveAtPortByDate": { "type": "string", "description": "Date, in ISO 8601 format, when all items in the purchase order must arrive at the destination port defined in the purchase order.", "example": "2025-01-06" }, "doNotShipBeforeDate": { "type": "string", "format": "dateTime", "description": "Date, in ISO 8601 format, before which the supplier cannot ship items in the purchase order to Walmart.", "example": "2025-01-06" }, "doNotShipAfterDate": { "type": "string", "format": "dateTime", "description": "Date, in ISO 8601 format, after which the supplier cannot ship items in the purchase order to Walmart.", "example": "2025-01-06" }, "doNotReceiveBeforeDate": { "type": "string", "format": "dateTime", "description": "Date, in ISO 8601 format, by which Walmart will not receive any of the items shipped as part of the purchase order.", "example": "2025-01-06" }, "destinationFacilityId": { "type": "integer", "description": "Numeric identifier of the Walmart destination facility (warehouse, distribution center, or store).", "example": 6043 }, "appointmentDate": { "type": "string", "format": "dateTime", "description": "Shipment delivery appointment date and time.\n\nBoth collect and prepaid shipments require delivery appointments.\nWalmart schedules delivery appointments for collect shipments, and suppliers or carriers schedule delivery appointments for prepaid shipments.", "example": "03/22/2025 11:00:00 PM CST" }, "appointmentNbr": { "type": "string", "description": "Unique identifier assigned to a scheduled delivery time slot at a Walmart facility.", "example": "12345" }, "gatedInDate": { "type": "string", "format": "dateTime", "description": "Exact date and time that a trailer physically arrives and is checked in at the gate of a Walmart facility.", "example": "03/22/2025 11:00:00 PM CST" }, "destinationFacilityInformation": { "type": "object", "description": "Contains information about the destination facility.", "properties": { "contactName": { "type": "string", "description": "Name of the contact person at the destination facility.", "example": "John Doe" }, "contactNbr": { "type": "string", "description": "Phone number of the contact person at the destination facility.", "example": "8048629104" }, "address": { "type": "string", "description": "Street address of the destination facility.", "example": "2100 MAIN ST" }, "state": { "type": "string", "description": "Two-letter state abbreviation.", "example": "AK" }, "city": { "type": "string", "description": "City of the destination facility.", "example": "Bentonville" }, "zipCode": { "type": "string", "description": "Five-digit ZIP code of the destination facility.", "example": "72712" }, "divisionCode": { "type": "string", "description": "Division number of the destination facility.", "example": "7" }, "destinationCountryCode": { "type": "string", "description": "Country to which the products in the purchase order are being shipped, or where they will be received into Walmart's supply chain.\n\nDetermines import and export processes, duty obligations, and supply chain routing.", "example": "US" } } }, "destinationReceivingInformation": { "type": "array", "description": "List of destination receiving objects.", "items": { "type": "object", "description": "Formal record generated when Walmart's receiving location scans in or manually confirms the receipt of goods ordered.", "properties": { "receiverNbr": { "type": "string", "description": "Walmart location for receiving the ordered goods.", "example": "1887" }, "freightBillQuantity": { "type": "string", "description": "Number of units or cases listed on the freight bill submitted by the carrier or vendor.\n\nUsed for receiving and invoice reconciliation.", "example": "1562" }, "trailerContentRecordNumber": { "type": "string", "description": "System-generated or vendor-provided record detailing all items and quantities loaded onto a trailer for delivery to a distribution center or store.", "example": "1562" }, "rejectedQuantity": { "type": "string", "description": "Number of units or items that were delivered but not accepted by the receiving facility.", "example": "0" }, "processedDate": { "type": "string", "description": "Date on which the purchase order was processed or approved by the procurement system or buyer.\n\nUsed by Walmart's internal supply chain and inventory systems to track the lifecycle of the purchase order.", "example": "1/17/2025" }, "trailerNbr": { "type": "string", "description": "Unique identifier assigned to the trailer transporting goods associated with the purchase order.\n\nUsed by Walmart's logistics and receiving systems to track, verify, and match shipments to purchase orders during transit and at delivery." }, "carrierCode": { "type": "string", "description": "Unique alphanumeric identifier assigned to the transportation provider (carrier) responsible for delivering the goods from the supplier to the Walmart destination facility.", "example": "WM" } } } } } }, "vendorAllowances": { "type": "array", "description": "List of financial adjustments or discounts applied to a specific line item in a purchase orders.", "items": { "type": "object", "description": "Contains information about financial discounts applied to a purchase order according to the vendor agreement.", "properties": { "allowanceType": { "type": "string", "description": "Type of discount applied to purchase orders according to the vendor agreement.\nValid values are:\n\n| Value | Meaning |\n| ----- | ------------------------------------------------------------- |\n| AA | Advertising allowance |\n| BD | Development charge/network allowance |\n| BH | Backhaul allowance |\n| CB | Central buy |\n| DA | Display allowance |\n| DM | Defective merchandise |\n| EB | Early buy allowance |\n| FA | Freight allowance |\n| FC | Inbound freight charges |\n| FG | Free goods |\n| HA | Handling |\n| MS | Split delivery |\n| ND | New distribution allowance |\n| NW | New warehouse |\n| OL | New store - PO level |\n| PA | Promotional allowance |\n| PM | Price and market allowance |\n| PR | Purchase rebate |\n| QD | Quantity discount |\n| SA | New store |\n| SB | Special buy |\n| SD | Softlines defective merchandise allowance |\n| TL | Truckload allowance |\n| TR | Cooperative advertising/merchandising allowance (performance) |\n| VD | Volume discount |\n| VT | Tax - Value Added Tax (VAT) |\n| WA | Warehouse allowance |\n| WC | Discount |\n| WD | Other |", "example": "NW" }, "allowancePercent": { "type": "string", "description": "Pre-negotiated deduction percentage rate applied to the cost of goods to account for agreed-upon costs or support functions.", "example": "5" }, "perishableInventoryIndicator": { "type": "string", "description": "Indicates whether or not any inventory in the purchase order is perishable goods, either fresh or refrigerated.", "enum": [ "Y", "N" ], "example": "Y" } } } }, "purchaseOrderActivities": { "type": "array", "description": "List of significant actions or events that have occurred related to the purchase order.", "items": { "type": "object", "description": "Contains details about a significant action or event that has occurred related to the purchase order.", "properties": { "poActivityType": { "type": "string", "description": "Describes the type of activity or event that has taken place for the purchase order.", "example": "Acknowledgement Sent" }, "poActivityDate": { "type": "string", "format": "dateTime", "description": "Date and time, in ISO 8601 format, when the purchase order activity occurred.", "example": "2025-09-12 18:14:27.0" } }, "example": { "poActivityType": "Acknowledgement Sent", "poActivityDate": "2025-09-12 18:14:27.0" } } } } } } } }, "example": { "purchaseOrdersListMeta": { "totalCount": 1, "limit": 100, "nextCursor": "123456789" }, "purchaseOrders": [ { "purchaseOrderId": "885653369", "hostPurchaseOrderId": "3732492413", "purchaseOrderStatus": "ACTIVE", "purchaseOrderSupplyChainStatus": "OPEN", "createDate": "2024-12-17T20:53:40Z", "createdBy": "dsikes", "lastChangeDate": "2025-07-17T20:00:00Z", "createdReason": "Business Decision", "eventCode": "NEWMODWK50", "otherPOsToShipWith": [ "1044115236", "1044086327", "1044134477", "1044132862", "1044086300" ], "supplierInformation": { "supplierId": 123456789, "supplierName": "Supplier 123", "importFactoryId": 0, "vendorId": "123456" }, "purchaseOrderInformation": { "type": "3", "source": "domestic_po", "channelMethod": "Crossdock", "storeDistribution": true, "freightTerms": "Prepaid", "warehouseArea": "1A - GROCRY", "transportationMethod": "truck", "contractedCarrier": "Acme Freight", "loadType": "", "domesticImportIndicator": "Domestic", "backhaulIndicator": "No", "purchaseOrderComments": [ { "commentType": "Vendor", "comment": "Transmission HOLD" } ], "globalLocationNumber": "0123456789012", "parentCompany": "Walmart Stores Inc", "entryMethod": "Systematic" }, "buyerId": [ "B0T071V" ], "totalQuantityOrdered": { "vendorPacks": 16, "warehousePacks": 64, "sellableUnits": 384 }, "totalQuantityReceived": { "vendorPacks": 0, "warehousePacks": 0, "sellableUnits": 0 }, "totalCost": 11508.48, "totalCostUOM": "USD", "totalWeight": 115.984, "totalWeightUOM": "LB", "totalCube": 115.984, "totalCubeUOM": "CF", "shippingInformation": { "mustArriveByDate": "2025-01-06", "originalMustArriveByDate": "2025-01-06", "mustArriveAtPortByDate": "2025-01-06", "doNotShipBeforeDate": "2025-01-06", "doNotShipAfterDate": "2025-01-06", "doNotReceiveBeforeDate": "2025-01-06", "destinationFacilityId": 6043, "appointmentDate": "03/22/2025 11:00:00 PM CST", "appointmentNbr": "12345", "gatedInDate": "03/22/2025 11:00:00 PM CST", "destinationFacilityInformation": { "contactName": "John Doe", "contactNbr": "8048629104", "address": "2100 MAIN ST", "state": "AK", "city": "Bentonville", "zipCode": "72712", "divisionCode": "7", "destinationCountryCode": "US" }, "destinationReceivingInformation": [ { "receiverNbr": "1887", "freightBillQuantity": "1562", "trailerContentRecordNumber": "1562", "rejectedQuantity": "0", "processedDate": "1/17/2025", "trailerNbr": "204421", "carrierCode": "WM" } ] }, "vendorAllowances": [ { "allowanceType": "NW", "allowancePercent": "5", "perishableInventoryIndicator": "Y" } ], "purchaseOrderActivities": [ { "poActivityType": "Acknowledgement Sent", "poActivityDate": "2025-09-12 18:14:27.0" }, { "poActivityType": "Acknowledgement Received", "poActivityDate": "2025-09-12 18:31:10.0" } ] } ] } } } }, "204": { "description": "No data. No Content. The Purchase Order ID does not exist or no access exists." }, "400": { "description": "Bad payload conditions.\n\n* Validation errors `createdAfter` date earlier than `createdBefore` results\n* Validation errors Limit cannot be greater than 100\n* Validation errors Invalid purchase order status\n* Validation errors type must be a number\n* Validation errors `hostPurchaseOrderId` must be a number\n* Validation errors Invalid purchase order Supply chain status" }, "500": { "description": "Internal Server Error." } } } } }, "x-tagGroups": [ { "name": "1P Suppliers Orders Reference", "tags": [ "Orders" ] } ] } ```