openapi: 3.0.1 info: title: Walmart DSV Order Management description: | Drop ship vendors (DSV) use the DSV Order Management API to stay up to date on order fulfillment. **May 2024**
Built: 05/09/2024, 14:39:22 version: '1.0' servers: - url: https://api-gateway.walmart.com description: Production URL - url: https://sandbox.walmartapis.com description: Sandbox URL paths: "/v3/orders/{purchaseOrderId}/shipping": post: tags: - DSV Orders operationId: postShipOrderLines summary: Walmart Ship One or More Purchase Order Lines description: "

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 order line is marked as shipped, it cannot be updated.\n\nNote: `shipDateTime` must be in UTC.\n\nThe response to a successful call contains the order with the shipped line item.\n" parameters: - in: path name: purchaseOrderId required: true schema: type: string description: | Specifies an identifier associated with the purchase order. This value is used to query a purchase order. Example(s):
2581154514813 example: '2581154514813' - in: query name: shipNode required: true schema: type: string description: | Specifies the distribution facility distributor identifier. This 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. Example(s):
123456701 example: '123456701' - in: header name: Accept required: false schema: type: string description: | Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: | Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the 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: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: | Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… - in: header name: Content-Type required: true schema: type: string description: "Specifies the format of request and response body data. \n\nIt specifies if the payload is JSON, XML, form data, or other data type. \nSetting `Content-Type` appropriately is essential when exchanging formatted data with APIs.\n\nValid values are:\n\n| Value | Meaning |\n| --- | --- |\n| application/xml | XML format for request and response body data. |\n| application/json | JSON format for request and response body data. |\n" example: application/xml requestBody: description: Request fields content: applications/json: schema: type: object required: - orderLines properties: orderLines: type: object description: 'Specifies an object for a list of order lines in the order. ' required: - orderLine properties: orderLine: type: array description: 'Specifies an array of objects for purchase order line information for each item. ' items: type: object required: - lineNumber - orderLineStatuses properties: lineNumber: type: string description: 'Specifies the line number associated with the details for the individual item in the purchase order. ' example: '1' orderLineStatuses: type: object description: "Specifies an object that lists statuses for order lines. \n" required: - orderLineStatus properties: orderLineStatus: type: array description: "Specifies an array of objects for details about individual order line status. \n" items: type: object required: - status - statusQuantity - trackingInfo properties: status: type: string description: "Specifies the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Shipped`.\n\nExample(s):
\nShipped\n" enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund example: Shipped asn: type: object description: 'Specifies an object for advance ship notice (ASN) information. ' required: - packageASN properties: packageASN: type: string description: | Specifies the package advance ship notice (ASN). Example(s):
1061414119283746 example: '1061414119283746' palletASN: type: string description: | Specifies the pallet advance ship notice (ASN). Example(s):
10614141192837465 example: '10614141192837465' statusQuantity: type: object description: 'Specifies an object for details about the status quantity update. ' required: - unitOfMeasurement - amount properties: unitOfMeasurement: type: string description: "Specifies the unit of measurement for the status quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Specifies the amount or value of the status quantity. Always use `1`. Example(s):
1 example: '1' trackingInfo: type: object description: 'Specifies an object for tracking information, to include package shipment and tracking updates. ' required: - shipDateTime - carrierName - methodCode - trackingNumber properties: shipDateTime: type: string format: date-time description: "Specifies a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Specifies an object for information about package carriers. ' properties: otherCarrier: type: string description: "Specifies a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Specifies the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Specifies the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value example: Standard trackingNumber: type: string description: "Specifies the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Specifies the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com responses: '200': description: Successful Operation content: application/json: schema: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' "/v3/orders/{purchaseOrderId}/cancel": post: tags: - DSV Orders operationId: postCancelOrderLines summary: Walmart Cancel Order Lines description: "

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_CANCEL_DISCONTINUE\n* SUPPLIER_CANCEL_UNRECOGNIZED\n" parameters: - in: path name: purchaseOrderId required: true schema: type: string description: | Specifies an identifier associated with the purchase order. This value is used to query a purchase order. Example(s):
2581154514813 example: '2581154514813' - in: query name: shipNode required: true schema: type: string description: | Specifies the distribution facility distributor identifier. This 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. Example(s):
123456701 example: '123456701' - in: header name: Accept required: false schema: type: string description: | Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: | Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the 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: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: | Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… - in: header name: Content-Type required: true schema: type: string description: "Specifies the format of request and response body data. \n\nIt specifies if the payload is JSON, XML, form data, or other data type. \nSetting `Content-Type` appropriately is essential when exchanging formatted data with APIs.\n\nValid values are:\n\n| Value | Meaning |\n| --- | --- |\n| application/xml | XML format for request and response body data. |\n| application/json | JSON format for request and response body data. |\n" example: application/xml requestBody: description: Request fields content: applications/json: schema: type: object required: - orderLines properties: orderLines: type: object description: 'Specifies an object for a list of order lines in the order. ' required: - orderLine properties: orderLine: type: array description: 'Specifies an array of objects for purchase order line information for each item. ' items: type: object required: - lineNumber - orderLineStatuses properties: lineNumber: type: string description: 'Specifies the line number associated with the details for the individual item in the purchase order. ' example: '1' orderLineStatuses: type: object description: "Specifies an object that lists statuses for order lines. \n" required: - orderLineStatus properties: orderLineStatus: type: array description: "Specifies an array of objects for details about individual order line status. \n" items: type: object required: - status - cancellationReason - statusQuantity properties: status: type: string description: "Specifies the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Cancelled`.\n\nExample(s):
\nCancelled\n" enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund example: Cancelled cancellationReason: type: string description: "Specifies the reason for cancellation.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUPPLIER_CANCEL | Canceled by supplier. |\n| SUPPLIER_CANCEL_CUSTOMER_REQUEST | Canceled by supplier at customer request. |\n| SUPPLIER_CANCEL_BACKORDER | Canceled by supplier as backorder. |\n| SUPPLIER_CANCEL_DISCONTINUE | Canceled by supplier as discontinued. |\n| SUPPLIER_CANCEL_UNRECOGNIZED | Canceled by supplier as unrecognized. |\n\nExample(s):
\nSUPPLIER_CANCEL\n" example: SUPPLIER_CANCEL enum: - SUPPLIER_CANCEL - SUPPLIER_CANCEL_CUSTOMER_REQUEST - SUPPLIER_CANCEL_BACKORDER - SUPPLIER_CANCEL_DISCONTINUE - SUPPLIER_CANCEL_UNRECOGNIZED statusQuantity: type: object description: 'Specifies an object for details about the status quantity update. ' required: - unitOfMeasurement - amount properties: unitOfMeasurement: type: string description: "Specifies the unit of measurement for the status quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Specifies the amount or value of the status quantity. Always use `1`. Example(s):
1 example: '1' responses: '200': description: Successful Operation content: application/json: schema: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' "/v3/orders/{purchaseOrderId}/acknowledge": post: tags: - DSV Orders operationId: postAcknowledgeOrders summary: Walmart Acknowledge Orders description: "

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 `Acknowledged` state can be re-acknowledged. \nThis is desirable, for example, when resolving an error response from a previous API call. \nOrders with line items that are shipped or canceled should not be re-acknowledged.\n" parameters: - in: path name: purchaseOrderId required: true schema: type: string description: | Specifies an identifier associated with the purchase order. This value is used to query a purchase order. Example(s):
2581154514813 example: '2581154514813' - in: query name: shipNode required: true schema: type: string description: | Specifies the distribution facility distributor identifier. This 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. Example(s):
123456701 example: '123456701' - in: header name: Accept required: false schema: type: string description: | Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: | Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the 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: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: | Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… - in: header name: Content-Type required: true schema: type: string description: "Specifies the format of request and response body data. \n\nIt specifies if the payload is JSON, XML, form data, or other data type. \nSetting `Content-Type` appropriately is essential when exchanging formatted data with APIs.\n\nValid values are:\n\n| Value | Meaning |\n| --- | --- |\n| application/xml | XML format for request and response body data. |\n| application/json | JSON format for request and response body data. |\n" example: application/xml responses: '200': description: Successful Operation content: application/json: schema: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' "/v3/orders": get: tags: - DSV Orders operationId: getAllOrders summary: Walmart Retrieve All Orders description: "

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" parameters: - in: query name: shipNode required: true schema: type: string 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" example: '123456701' - in: query name: limit required: false schema: type: string description: "Specifies the number of orders to be returned. \n\nThe value cannot be larger than 200.\n\nExample(s):
\n100\n" example: '100' - in: query name: sku required: false schema: type: string description: | Specifies the stock keeping unit (SKU) item identifier. This identifier is specified by the drop ship vendor (DSV) and used by the vendor in the specification file to refer to each item. The 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. Example(s): 06194456252572 example: '06194456252572' - in: query name: customerOrderId required: false schema: type: string description: | Specifies an identifier associated with the sales orders to retrieve or filter the orders. Example(s):
6101730068963 example: '6101730068963' - in: query name: purchaseOrderId required: false schema: type: string description: "Specifies an identifier associated with the purchase order. \n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" example: '2581154514813' - in: query name: status required: false schema: type: string 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" example: Created - in: query name: createdStartDate required: false schema: type: string 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" example: '2023-03-16T10:30:15Z' - in: query name: createdEndDate required: false schema: type: string 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" example: '2023-03-19T10:30:15Z' - in: query name: fromExpectedShipDate required: false schema: type: string 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" example: '2023-03-20T10:30:15Z' - in: query name: toExpectedShipDate required: false schema: type: string 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" example: '2023-03-21T10:30:15Z' - in: query name: productInfo required: false schema: type: string description: | Specifies the image URL and product weight in the response, if available. If `true`, the image URL and product weight are provided in the response. If `false`, the image URL and product weight are not provided in the response. The value defaults to `false`. Example(s):
false example: 'false' - in: header name: Accept required: false schema: type: string description: | Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: | Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the 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: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: | Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… responses: '200': description: Successful Operation content: application/json: schema: type: object properties: meta: type: object description: 'Indicates an object for metadata about the list. ' properties: totalCount: type: integer format: int32 description: | Indicates the total number of purchase orders. Example(s):
44 example: 44 limit: type: integer format: int32 description: "Indicates the number of puchase orders on the current search results page. \n\nExample(s):
\n2\n" example: 2 nextCursor: type: string description: "Indicates the value set to get the next set of purchase orders, when more than 200 orders are retrieved. \n\nExample(s):
\n?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252\n" example: "?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252" elements: type: object description: 'Indicates an object for elements of the list. ' properties: order: type: array description: 'Indicates an array of objects for the orders. ' items: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderDate: type: string format: date-time description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG example: list: meta: totalCount: 44 limit: 2 nextCursor: "?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252" elements: order: - purchaseOrderId: '2581154514813' customerOrderId: '6101730068963' customerEmailId: AA136A58DEBE43ACA52007CF9E960994@relay.walmart.com orderDate: 1513840399000 buyerId: 1f2f70fb-e99a-45a1-aaa8-fe7c58074af3 mart: Walmart.com isGuest: false shippingInfo: phone: '6505852323' estimatedDeliveryDate: 1514566800000 estimatedShipDate: 1514487600000 methodCode: Standard postalAddress: name: Yana335ACCEPT PGOMS address1: 850 Cherry Ave address2: city: San Bruno state: CA postalCode: '94066' country: USA addressType: OFFICE orderLines: orderLine: - lineNumber: '1' item: productName: Photo Necktie (Printed on 2 Sides) sku: PRGift;4040{IS imageUrl: https://i5.walmartimages.com/asr/7924b94b-49fa-4050-8e62-2364d07d0068_1.6ef0f115abba4f27b7c5e785c2bac517.jpeg weight: value: '0.438' unit: Pounds charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 24.96 tax: taxName: Tax1 taxAmount: currency: USD amount: 2.18 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 2.99 tax: orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1514426146000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: trackingInfo: refund: originalCarrierMethod: '20' referenceLineId: '123456' fulfillment: fulfillmentOption: S2H shipMethod: STANDARD storeId: offerId: 123456789123456789ABC pickUpDateTime: 1514480400000 pickUpBy: - purchaseOrderId: '1581154359749' customerOrderId: '6251732862080' customerEmailId: 2B8BE7C05D014AC7B42459631625972F@relay.walmart.com orderDate: 1513812227000 buyerId: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: Walmart.com isGuest: false shippingInfo: phone: '4083251200' estimatedDeliveryDate: 1514826000000 estimatedShipDate: 1514574000000 methodCode: Standard postalAddress: name: Dee Vee address1: 1200 Sequoia address2: city: Fremont state: CA postalCode: '94536' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Photo Necktie (Printed on 2 Sides) sku: PRGift;4040{IS imageUrl: https://i5.walmartimages.com/asr/90fdc3a0-3a08-4f6e- 8e6f-7b311d200a6d_1.d1398498fffad3feac2053ed7272a3f1.jpeg weight: value: '1.1' unit: Pounds charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 24.96 tax: taxName: Tax1 taxAmount: currency: USD amount: 2.31 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 2.99 tax: orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1514496679000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: trackingInfo: refund: originalCarrierMethod: '20' referenceLineId: '123456' fulfillment: fulfillmentOption: S2H shipMethod: STANDARD storeId: offerId: 123456789123456789ABC pickUpDateTime: 1514480400000 pickUpBy: "/v3/orders/{purchaseOrderId}": get: tags: - DSV Orders operationId: getAnOrder summary: Walmart Retrieve a Single Order description: |

GET /v3/orders/{purchaseOrderId}

This request retrieves order detail as defined by a specific `purchaseOrderId` and `shipNode`. Only orders created in last 180 days can be fetched. parameters: - in: path name: purchaseOrderId required: true schema: type: string description: | Specifies an identifier associated with the purchase order. This value is used to query a purchase order. Example(s):
2581154514813 example: '2581154514813' - in: query name: shipNode required: true schema: type: string description: | Specifies the distribution facility distributor identifier. This 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. Example(s):
123456701 example: '123456701' - in: query name: productInfo required: false schema: type: string description: | Specifies the image URL and product weight in the response, if available. If `true`, the image URL and product weight are provided in the response. If `false`, the image URL and product weight are not provided in the response. The value defaults to `true`. Example(s):
false example: 'false' - in: header name: Accept required: false schema: type: string description: | Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: | Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the 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: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: | Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… responses: '200': description: Successful Operation content: application/json: schema: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' example: order: purchaseOrderId: '1581564396843' customerOrderId: '3001859598500' customerEmailId: D5AFD31C627A45F3A93041FD557F94C4@relay.walmart.com orderDate: 1517252660000 buyerId: 43538435-de77-44c7-b606-ad9a8ff1d8f8 mart: Walmart.com isGuest: false shippingInfo: phone: '2566519197' estimatedDeliveryDate: 1518454800000 estimatedShipDate: 1518109200000 methodCode: Standard postalAddress: name: whitney feathers address1: 4100 Cloverdale Dr NW address2: city: Huntsville state: AL postalCode: '35805' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: High-Quality 8 x 10 Prints sku: 8x10{IS imageUrl: https://i5.walmartimages.com/asr/7924b94b-49fa-4050-8e62-2364d07d0068_1.6ef0f115abba4f27b7c5e785c2bac517.jpeg weight: value: '0.438' unit: Pounds charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 1.79 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.15 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 1.75 tax: orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1542069814000 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: trackingInfo: shipDateTime: 1540845015000 carrierName: otherCarrier: carrier: UPS methodCode: Standard carrierMethodCode: trackingNumber: '3445435443441221' trackingURL: http://www.fedex.com refund: refundId: refundComments: refundCharges: refundCharge: - refundReason: Quality -> Missing Parts / Instructions charge: chargeType: PRODUCT chargeName: Quality -> Missing Parts / Instructions chargeAmount: currency: USD amount: -0.01 tax: originalCarrierMethod: '22' referenceLineId: '123456' fulfillment: fulfillmentOption: S2H shipMethod: STANDARD storeId: pickUpDateTime: 1518120000000 pickUpBy: "/v3/orders/released": get: tags: - DSV Orders operationId: getAllReleasedOrders summary: Walmart Retrieve All Released Orders description: "

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 orders will return an error.\n" parameters: - in: query name: shipNode required: true schema: type: string 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" example: '123456701' - in: query name: limit required: false schema: type: string description: "Specifies the number of orders to be returned. \n\nThe value cannot be larger than 200.\n\nExample(s):
\n100\n" example: '100' - in: query name: sku required: false schema: type: string description: | Specifies the stock keeping unit (SKU) item identifier. This identifier is specified by the drop ship vendor (DSV) and used by the vendor in the specification file to refer to each item. The 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. Example(s): 06194456252572 example: '06194456252572' - in: query name: customerOrderId required: false schema: type: string description: | Specifies an identifier associated with the sales orders to retrieve or filter the orders. Example(s):
6101730068963 example: '6101730068963' - in: query name: purchaseOrderId required: false schema: type: string description: "Specifies an identifier associated with the purchase order. \n\nThis value is used to query a purchase order.\n\nExample(s):
\n2581154514813\n" example: '2581154514813' - in: query name: createdStartDate required: false schema: type: string 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" example: '2023-03-16T10:30:15Z' - in: query name: createdEndDate required: false schema: type: string 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" example: '2023-03-19T10:30:15Z' - in: query name: fromExpectedShipDate required: false schema: type: string 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" example: '2023-03-20T10:30:15Z' - in: query name: toExpectedShipDate required: false schema: type: string 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" example: '2023-03-21T10:30:15Z' - in: query name: productInfo required: false schema: type: string description: | Specifies the image URL and product weight in the response, if available. If `true`, the image URL and product weight are provided in the response. If `false`, the image URL and product weight are not provided in the response. The value defaults to `false`. Example(s):
false example: 'false' - in: header name: Accept required: false schema: type: string description: | Specifies the data type expected in a response sent from the server. Valid values are: | Value | Meaning | | --- | --- | | application/xml | XML format for data returned in response. | | application/json | JSON format for data returned in response. | example: application/xml - in: header name: WM_CONSUMER.CHANNEL.TYPE required: false schema: type: string description: | Specifies an identifier that tracks the consumer request by channel. Use the consumer channel type received during onboarding. See the 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: "Specifies an identifier for each API call and is used to track and debug issues.\n\n This may be any value, but cannot be null or omitted. \n" example: 6474-a253 - in: header name: WM_SEC.ACCESS_TOKEN required: true schema: type: string description: | Specifies the access token retrieved in the Create Access Token request. This value is required for token-based authentication. example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM… responses: '200': description: Successful Operation content: application/json: schema: type: object properties: meta: type: object description: 'Indicates an object for metadata about the list. ' properties: totalCount: type: integer format: int32 description: | Indicates the total number of purchase orders. Example(s):
44 example: 44 limit: type: integer format: int32 description: "Indicates the number of puchase orders on the current search results page. \n\nExample(s):
\n2\n" example: 2 nextCursor: type: string description: "Indicates the value set to get the next set of purchase orders, when more than 200 orders are retrieved. \n\nExample(s):
\n?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252\n" example: "?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252" elements: type: object description: 'Indicates an object for elements of the list. ' properties: order: type: array description: 'Indicates an array of objects for the orders. ' items: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderDate: type: string format: date-time description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG example: list: meta: totalCount: 3 limit: 10 nextCursor: elements: order: - purchaseOrderId: '1581154359749' customerOrderId: '6251732862080' customerEmailId: 2B8BE7C05D014AC7B42459631625972F@relay.walmart.com orderDate: 1513812227000 buyerId: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: Walmart.com isGuest: false shippingInfo: phone: '4083251200' estimatedDeliveryDate: 1514826000000 estimatedShipDate: 1514574000000 methodCode: Standard postalAddress: name: Dee Vee address1: 1200 Sequoia address2: city: Fremont state: CA postalCode: '94536' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Photo Necktie (Printed on 2 Sides) sku: PRGift;4040{IS imageUrl: https://i5.walmartimages.com/asr/90fdc3a0-3a08-4f6e-8e6f-7b311d200a6d_1.d1398498fffad3feac2053ed7272a3f1.jpeg weight: value: '1.1' unit: Pounds charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 24.96 tax: taxName: Tax1 taxAmount: currency: USD amount: 2.31 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 2.99 tax: orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1514496679000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: trackingInfo: refund: originalCarrierMethod: '20' referenceLineId: '123456' fulfillment: fulfillmentOption: S2H shipMethod: STANDARD storeId: pickUpDateTime: 1514480400000 pickUpBy: - purchaseOrderId: '1581154359744' customerOrderId: '6251732362974' customerEmailId: 2B8BE7C05D014AC7B42459631625972F@relay.walmart.com orderDate: 1513810988000 buyerId: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: Walmart.com isGuest: false shippingInfo: phone: '4083251200' estimatedDeliveryDate: 1514826000000 estimatedShipDate: 1514574000000 methodCode: Standard postalAddress: name: Dee Vee address1: 1200 Sequoia address2: city: Fremont state: CA postalCode: '94536' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Photo Necktie (Printed on 2 Sides) sku: PRGift;4040{IS imageUrl: https://i5.walmartimages.com/asr/7924b94b-49fa-4050-8e62-2364d07d0068_1.6ef0f115abba4f27b7c5e785c2bac517.jpeg weight: value: '0.438' unit: Pounds charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 24.96 tax: taxName: Tax1 taxAmount: currency: USD amount: 2.31 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 2.99 tax: orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1514496672000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: trackingInfo: refund: originalCarrierMethod: '20' referenceLineId: '123456' fulfillment: fulfillmentOption: S2H shipMethod: STANDARD storeId: pickUpDateTime: 1514480400000 pickUpBy: - purchaseOrderId: '2581154514815' customerOrderId: '6101730368463' customerEmailId: 2B8BE7C05D014AC7B42459631625972F@relay.walmart.com orderDate: 1513809053000 buyerId: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: Walmart.com isGuest: false shippingInfo: phone: '4083251200' estimatedDeliveryDate: 1514566800000 estimatedShipDate: 1514487600000 methodCode: Standard postalAddress: name: Dee Vee address1: 1200 Sequoia address2: city: Fremont state: CA postalCode: '94536' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Photo Necktie (Printed on 2 Sides) sku: PRGift;4040{IS imageUrl: https://i5.walmartimages.com/asr/7924b94b-49fa-4050-8e62-2364d07d0068_1.6ef0f115abba4f27b7c5e785c2bac517.jpeg weight: value: '0.438' unit: Pounds charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 24.96 tax: taxName: Tax1 taxAmount: currency: USD amount: 2.31 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 2.99 tax: orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1514426147000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: trackingInfo: refund: originalCarrierMethod: '20' referenceLineId: '123456' fulfillment: fulfillmentOption: S2H shipMethod: STANDARD storeId: offerId: 123456789123456789ABC pickUpDateTime: 1514480400000 pickUpBy: components: schemas: postShipOrderLines-request: type: object required: - orderLines properties: orderLines: type: object description: 'Specifies an object for a list of order lines in the order. ' required: - orderLine properties: orderLine: type: array description: 'Specifies an array of objects for purchase order line information for each item. ' items: type: object required: - lineNumber - orderLineStatuses properties: lineNumber: type: string description: 'Specifies the line number associated with the details for the individual item in the purchase order. ' example: '1' orderLineStatuses: type: object description: "Specifies an object that lists statuses for order lines. \n" required: - orderLineStatus properties: orderLineStatus: type: array description: "Specifies an array of objects for details about individual order line status. \n" items: type: object required: - status - statusQuantity - trackingInfo properties: status: type: string description: "Specifies the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Shipped`.\n\nExample(s):
\nShipped\n" enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund example: Shipped asn: type: object description: 'Specifies an object for advance ship notice (ASN) information. ' required: - packageASN properties: packageASN: type: string description: | Specifies the package advance ship notice (ASN). Example(s):
1061414119283746 example: '1061414119283746' palletASN: type: string description: | Specifies the pallet advance ship notice (ASN). Example(s):
10614141192837465 example: '10614141192837465' statusQuantity: type: object description: 'Specifies an object for details about the status quantity update. ' required: - unitOfMeasurement - amount properties: unitOfMeasurement: type: string description: "Specifies the unit of measurement for the status quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Specifies the amount or value of the status quantity. Always use `1`. Example(s):
1 example: '1' trackingInfo: type: object description: 'Specifies an object for tracking information, to include package shipment and tracking updates. ' required: - shipDateTime - carrierName - methodCode - trackingNumber properties: shipDateTime: type: string format: date-time description: "Specifies a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Specifies an object for information about package carriers. ' properties: otherCarrier: type: string description: "Specifies a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Specifies the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Specifies the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value example: Standard trackingNumber: type: string description: "Specifies the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Specifies the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com postShipOrderLines-200-response: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' cancelOrderLines-request: type: object required: - orderLines properties: orderLines: type: object description: 'Specifies an object for a list of order lines in the order. ' required: - orderLine properties: orderLine: type: array description: 'Specifies an array of objects for purchase order line information for each item. ' items: type: object required: - lineNumber - orderLineStatuses properties: lineNumber: type: string description: 'Specifies the line number associated with the details for the individual item in the purchase order. ' example: '1' orderLineStatuses: type: object description: "Specifies an object that lists statuses for order lines. \n" required: - orderLineStatus properties: orderLineStatus: type: array description: "Specifies an array of objects for details about individual order line status. \n" items: type: object required: - status - cancellationReason - statusQuantity properties: status: type: string description: "Specifies the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Cancelled`.\n\nExample(s):
\nCancelled\n" enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund example: Cancelled cancellationReason: type: string description: "Specifies the reason for cancellation.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUPPLIER_CANCEL | Canceled by supplier. |\n| SUPPLIER_CANCEL_CUSTOMER_REQUEST | Canceled by supplier at customer request. |\n| SUPPLIER_CANCEL_BACKORDER | Canceled by supplier as backorder. |\n| SUPPLIER_CANCEL_DISCONTINUE | Canceled by supplier as discontinued. |\n| SUPPLIER_CANCEL_UNRECOGNIZED | Canceled by supplier as unrecognized. |\n\nExample(s):
\nSUPPLIER_CANCEL\n" example: SUPPLIER_CANCEL enum: - SUPPLIER_CANCEL - SUPPLIER_CANCEL_CUSTOMER_REQUEST - SUPPLIER_CANCEL_BACKORDER - SUPPLIER_CANCEL_DISCONTINUE - SUPPLIER_CANCEL_UNRECOGNIZED statusQuantity: type: object description: 'Specifies an object for details about the status quantity update. ' required: - unitOfMeasurement - amount properties: unitOfMeasurement: type: string description: "Specifies the unit of measurement for the status quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Specifies the amount or value of the status quantity. Always use `1`. Example(s):
1 example: '1' cancelOrderLines-200-response: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' postAcknowledgeOrders-200-response: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' getAllOrders-200-response: type: object properties: meta: type: object description: 'Indicates an object for metadata about the list. ' properties: totalCount: type: integer format: int32 description: | Indicates the total number of purchase orders. Example(s):
44 example: 44 limit: type: integer format: int32 description: "Indicates the number of puchase orders on the current search results page. \n\nExample(s):
\n2\n" example: 2 nextCursor: type: string description: "Indicates the value set to get the next set of purchase orders, when more than 200 orders are retrieved. \n\nExample(s):
\n?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252\n" example: "?limit=2&hasMoreElements=true&soIndex=44&poIndex=2&sellerId=0&status=Created&createdStartDate=2017-07-27&createdEndDate=2018-12-05T10:18:45.557Z&shipNode=837252&vendorId=837252" elements: type: object description: 'Indicates an object for elements of the list. ' properties: order: type: array description: 'Indicates an array of objects for the orders. ' items: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderDate: type: string format: date-time description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG getAnOrder-200-response: type: object properties: purchaseOrderId: type: string description: "Indicates an identifier associated with the supplier's purchase order. \n\nExample(s):
\n2581154514813\n" example: '2581154514813' customerOrderId: type: string description: "Indicates an identifier associated with the sales order for a specified customer. \n\nExample(s):
\n6251732862080\n" example: '6251732862080' customerEmailId: type: string description: "Indicates the email address of the customer for the sales order. \n\nExample(s):
\njordan.SmithWMT@gmail.com\n" example: jordan.SmithWMT@gmail.com orderType: type: string description: "Indicates if the order is a regular order or replacement order. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| REGULAR | Indicates a regular order. |\n| REPLACEMENT | Indicates a replacement order. | \n\nThis value is provided in response only if query parameter `replacementInfo=true`.\n\nExample(s):
\nREGULAR\n" example: REGULAR originalCustomerOrderId: type: string description: | Indicates the customer order identifier associated with the original customer order on which the replacement is created. Example(s):
BCA1732862080 example: BCA1732862080 orderDate: type: integer format: int64 description: "Indicates the date-timestamp of when the customer submitted the sales order. \n\nExample(s):
\n1513812227000\n" example: 1513812227000 buyerId: type: string format: uuid description: | Indicates an identiifer associated with the specific buyer. Example(s):
fbbd8041-5d0c-4533-b95a-adc84c4f1a10 example: fbbd8041-5d0c-4533-b95a-adc84c4f1a10 mart: type: string description: | Indicates mart information. Example(s):
walmart.com example: walmart.com isGuest: type: boolean description: "Indicates a guest customer.\n\nIf `true`, the customer is a guest customer. \n\nIf `false`, the customer is not a guest customer. \n\nExample(s):
\nfalse\n" example: false shippingInfo: type: object description: 'Indicates an object for shipping information (provided by the customer to the supplier). ' properties: phone: type: string description: | Indicates the customer phone number. Example(s):
6505852323 example: '6505852323' estimatedDeliveryDate: type: string format: date-time description: | Indicates the estimated time and date for the delivery of the item, in format: yyyy-MM-ddThh:MM:ssZ. Example(s):
2023-06-15T06:00:00Z example: '2023-06-15T06:00:00Z' estimatedShipDate: type: string format: date-time description: "Indicates the estimated time and date when the item will be shipped, in format: yyyy-MM-ddThh:MM:ssZ \n\nExample(s):
\n2023-06-16T06:00:00Z\n" example: '2023-06-16T06:00:00Z' methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value postalAddress: type: object description: "Indicates an object for elements of the customer postal address. \n" properties: name: type: string description: | Indicates the name associated with the shipment. Example(s):
Jordan Smith example: Jordan Smith address1: type: string description: "Indicates the first line of the shipping address. \n\nExample(s):
\n1357 Main St\n" example: 1357 Main St address2: type: string description: | Indicates the second line of the shipping address. Example(s):
Suite 2B example: Suite 2B city: type: string description: "Indicates the city of the shipping address. \n\nExample(s):
\nFremont\n" example: Fremont state: type: string description: "Indicates the state of the shipping address. \n\nExample(s):
\nCA
\nTN
\nKY\n" example: CA postalCode: type: string description: "Indicates the ZIP Code™ of the shipping address. \n\nExample(s):
\n94536\n" example: '94536' country: type: string description: "Indicates the country of the shipping address. \n\nExample(s):
\nUSA\n" example: USA addressType: type: string description: | Indicates the address type. Example(s):
RESIDENTIAL example: RESIDENTIAL orderLines: type: object description: 'Indicates an object for a list of order lines in the order. ' properties: orderLine: type: array description: 'Indicates an array of objects for purchase order line information for each item. ' items: type: object properties: lineNumber: type: string description: 'Indicates the line number associated with the details for the individual item in the purchase order. ' example: '1' item: type: object description: 'Indicates an object for item information on the order line. ' properties: productName: type: string description: "Indicates the name of the product associated with the line item. \n\nExample(s):
\nKenmore CF1
\n2086883 Canister Secondary Filter Generic 2 Pack\n" example: Photo Necktie (Printed on 2 Sides) sku: type: string description: | Indicates the stock keeping unit (SKU) item identifier. This is a product identifier provided by the drop ship vendor (DSV) to identify each item. Example(s):
1487132332472 example: '1487132332472' charges: type: object description: 'Indicates an object for information relating to the charge for the order line. ' properties: charge: type: array description: "Indicates an array of objects for a list of elements that make up a charge. \n" items: type: object properties: chargeType: type: string description: "Indicates the charge type for line items.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n\nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderLineQuantity: type: object description: "Indicates an object for details about the status update. \n" properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' statusDate: type: string format: date-time description: "Indicates the date-timestamp for the most recent order status. \n\nExample(s):
\n1514426146000\n" example: '1514426146000' orderLineStatuses: type: object description: "Indicates an object that lists statuses for order lines. \n" properties: orderLineStatus: type: array description: "Indicates an array of objects for details about individual order line status. \n" items: type: object properties: status: type: string description: "Indicates the status of the 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| Refund | The purchase order line has been refunded. |\n\nThe `status` value should be `Created`.\n\nExample(s):
\nCreated\n" example: Created enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund statusQuantity: type: object description: 'Indicates an object for status quantity. ' properties: unitOfMeasurement: type: string description: "Indicates the unit of measurement for the order line quantity.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| EACH | Each unit of measurement |\n| EA | Each unit of measurement |\n\nExample(s):
\nEACH\n" enum: - EACH - EA example: EACH amount: type: string description: | Indicates the numeric amount for the order line quantity. Always use `1`. Example(s):
1 example: '1' cancellationReason: type: string description: "Indicates the cancellation reason for canceled orders. \n\nExample(s):
\nWrong item\n" example: Wrong item trackingInfo: type: object description: 'Indicates an object for tracking information, to include package shipment and tracking updates. ' properties: shipDateTime: type: string format: date-time description: "Indicates a date-timestamp for when the date the package was shipped, in UTC format. \n\nExample(s):
\n1513840399000\n" example: '1513840399000' carrierName: type: object description: 'Indicates an object for information about package carriers. ' properties: otherCarrier: type: string description: "Indicates a secondary or \"other\" package shipment carrier name. \n\nWhen `otherCarrier` is used, `trackingURL` is required. \n\nExample(s):
\nUSPS\n" example: USPS carrier: type: string enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL - LS - UDS - UPSMI - FDX - FEDEXSP description: "Indicates the package shipment carrier.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| UPS | United Postal Service |\n| USPS | United States Postal Service |\n| FedEx | Federal Express |\n| Airborne | Airborne |\n| OnTrac | OnTrac |\n| DHL | DHL Ecommerce - US |\n| LS | LaserShip |\n| UDS | United Delivery Service |\n| UPSMI | UPS Main Innovations |\n| FDX | FedEx |\n| FEDEXSP | FedEx SmartPost |\n\nExample(s):
\nUPS
\nUSPS
\nFedEx\n" example: USPS methodCode: type: string description: "Indicates the shipping method code.\n\nThe value can be one of the following: `Standard`, `Express`, `OneDay`, or `Freight`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| Standard | Standard shipping method. |\n| Express | Express shipping method. |\n| OneDay | One-day shipping method. |\n| Freight | Freight shipping method. |\n| WhiteGlove | White glove shipping method. |\n| Value | Value shipping method. |\n\nExample(s):
\nStandard
\nExpress
\nOneDay
\nFreight\n" example: Standard enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: "Indicates the shipment tracking number. \n\nExample(s):
\n13579086421357908642\n" example: '13579086421357908642' trackingUrl: type: string description: "Indicates the URL for tracking the shipment. \n\nIf `otherCarrier` is used, `trackingUrl` is required.\n\nExample(s):
\nwww.genericshipmentcompany.tracking.com\n" example: www.genericshipmentcompany.tracking.com refund: type: object description: "Indicates an object for details about any refund on the order. \n" properties: refundId: type: string description: "Indicates the refund identifier. \n\nExample(s):
\n135790\n" example: '135790' refundComments: type: string description: "Indicates comments associated with the refund. \n\nExample(s):
\nBilling error\n" example: Billing error refundCharges: type: object description: "Indicates an object for refund charges. \n" properties: refundCharge: type: array description: "Indicates an array of objects for information about a refund charge. \n" items: type: object properties: refundReason: type: string description: "Indicates the refund reason. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| BillingError | Refunded due to billing error |\n| TaxExemptCustomer | Refunded due to customer having tax exempt status |\n| ItemNotAsAdvertised | Refunded due to the item received not being as advertised |\n\nExample(s):
\nBillingError\n" example: BillingError enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Finance -> Goodwill - Finance -> Rollback - Missing Parts / Instructions - Buyer canceled - Customer returned item - General adjustment - Merchandise not received - Quality -> Missing Parts / Instructions - Shipping & Delivery -> Damaged - Shipping & Delivery -> Shipping Price Discrepancy - Others charge: type: object description: "Indicates an object for elements that make up a charge. \n" properties: chargeType: type: string description: "Indicates the charge type for line items.\n \nValid values are: \n \n| Value | Meaning |\n| --- | --- |\n| PRODUCT | Indicates the product charges for the specified line item in purchase order. |\n| SHIPPING | Indicates the shipping charges for the specified purchase order line item. Walmart only supports UTC `shipDateTime`. |\n \nFor more about charge types, reference the Drop Ship Vendor (DSV) Order Charge Types section in the DSV Orders guide.\n\nExample(s):
\nPRODUCT\n" example: PRODUCT chargeName: type: string description: "Indicates the charge name associated with the charge type. \n\nIf `PRODUCT`, the charge name is Item Price. \n\nIf `SHIPPING`, the charge name is Shipping. \n\nExample(s):
\nItem Price
\nShipping\n" example: Item Price chargeAmount: type: object description: "Indicates an object for charge amount information. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 tax: type: object description: 'Indicates an object for tax information for the charge, including `taxName` and `taxAmount`. ' properties: taxName: type: string description: | Indicates the name associated with the tax. Example(s):
Sales Tax example: Sales Tax taxAmount: type: object description: "Indicates an object for details about the amount of the tax charge. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 originalCarrierMethod: type: string description: "Indicates the original carrier method. \n\nExample(s):
\n20\n" example: '20' referenceLineId: type: string description: "Indicates the reference line identifier. \n\nExample(s):
\n135642\n" example: '135642' fulfillment: type: object description: "Indicates an object for fulfillment information. \n" properties: fulfillmentOption: type: string description: "Indicates the fulfillment option, such as ship to home (S2H). \n\nExample(s):
\nS2H\n" example: S2H shipMethod: type: string description: "Indicates the shipping method.\n\nThe value can be one of the following: `STANDARD`, `EXPRESS`, `ONEDAY`, or `FREIGHT`.\n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| STANDARD | Standard shipping method. |\n| EXPRESS | Express shipping method. |\n| ONEDAY | One-day shipping method. |\n| FREIGHT | Freight shipping method. |\n| WHITEGLOVE | White glove shipping method. |\n| VALUE | Value shipping method. |\n" example: STANDARD storeId: type: string description: | Indicates the external identifier of the client store. Example(s):
9221 example: '9221' offerId: type: string description: "Indicates the offer identifier. \n\nExample(s):
\n1357908642DFE\n" example: 1357908642DFE pickUpDateTime: type: string format: date-time description: "Indicates the date-timestamp of order pickup. \n\nExample(s):
\n1514480400000\n" example: '1514480400000' pickUpBy: type: string description: "Indicates the date-timestamp of when the order must be picked up by. \n\nExample(s):
\n1514480500000\n" example: '1514480500000' intentToCancel: type: string description: "Indicates the intent to cancel. \n\nExample(s):
\nIntent\n" example: Intent configId: type: string description: "Indicates the configuration identifier. \n\nExample(s):
\n13579GLG\n" example: 13579GLG paymentTypes: type: array description: 'Indicates an array of strings for payment types. ' items: type: string orderSummary: type: object description: 'Indicates an object for order summary information. ' properties: totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 orderSubTotals: type: array description: "Indicates an array of objects for order subtotals. \n" items: type: object properties: subTotalType: type: string description: "Indicates the subtotal type. \n\nExample(s):
\nSUM\n" example: SUM totalAmount: type: object description: "Indicates an object for total amount. \n" properties: currency: type: string description: "Indicates the type of currency (in the three-letter ISO 4217 currency code) for the charge.\n\nValue values include, but are not limited to: \n\n| Value | Meaning |\n| --- | --- |\n| CAD | Canadian Dollar |\n| GBP | Great Britain Pound |\n| USD | United States Dolllar |\n\nReference the ISO 4217 standard for a complete listing of three-letter currency codes. \n\nExample(s):
\nUSD
\nGBP
\nCAD\n" example: USD amount: type: number description: "Indicates the numeric amount for the charge. \n\nExample(s):
\n9.99\n" example: 9.99 pickupPersons: type: array description: "Indicates an array of objects for a list of pickup persons. \n" items: type: object properties: name: type: object description: "Indicates an object for pickup person name. \n" properties: completeName: type: string description: "Indicates the complete name of the pickup person. \n\nExample(s):
\nMr. Jordan Allan Smith, Jr.\n" example: Mr. Jordan Allan Smith, Jr. firstName: type: string description: "Indicates the first name of the pickup person. \n\nExample(s):
\nJordan\n" example: Jordan middleName: type: string description: "Indicates the middle name of the pickup person. \n\nExample(s):
\nAllan\n" example: Allan lastName: type: string description: "Indicates the last name of the pickup person. \n\nExample(s):
\nSmith\n" example: Smith generalSuffix: type: string description: "Indicates the general suffix of the pickup person. \n\nExample(s):
\nPhD\n" example: PhD maturitySuffix: type: string description: "Indicates the maturity suffix of the pickup person. \n\nExample(s):
\nJr
\nSr
\nII
\nIII\n" example: Jr titleOfRespect: type: string description: | Indicates the title of respect of the pickup person. Example(s):
Mr
Mrs
Miss
Ms
Mx example: Mr empty: type: boolean description: | Indicates if the name information for the pickup person is empty. If `true`, the information is empty. If `false`, the information is not empty. Example(s):
false example: false phone: type: object description: 'Indicates an object for information associated with the pickup person phone number. ' properties: id: type: string format: uuid description: | Indicates the identifier for the pickup person phone number. Example(s):
550e8411-e29b-41d4-a716-446655440000 example: 550e8411-e29b-41d4-a716-446655440000 areaCode: type: string description: | Indicates the area code for the pickup person phone number. Example(s):
615 example: '615' extension: type: string description: | Indicates the extension for the pickup person phone number. Example(s):
408 example: '408' completeNumber: type: string description: | Indicates the complete number for the pickup person phone number. Example(s):
4085551357 example: '4085551357' type: type: string description: "Indicates the type of phone number that is associated with the pickup person. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| MOBILE | Mobile or cellular phone number |\n| HOME | Home phone or landline number |\n| WORK | Work phone number |\n\nExample(s):
\nMOBILE
\nHOME
\nWORK\n" enum: - MOBILE - HOME - WORK example: MOBILE subscriberNumber: type: string description: "Indicates the subscriber number associated with the pickup person phone number. \n\nExample(s):
\n5551357\n" example: '5551357' countryCode: type: string description: "Indicates the country code associated with the pickup person phone number. \n\nValid values include: \n\n| Value | Meaning |\n| --- | --- |\n| 1 | USA |\n| 44 | United Kingdom |\n| 86 | China |\n| 91 | India |\n\nExample(s):
\n1\n" example: '1' phoneValidity: type: object description: "Indicates an object for phone validity informtaion, like validation type and status. \n" properties: validationType: type: string description: "Indicates the validation type for phone validity. \n\nValid values are: \n\n| Value | Meaning |\n| SMS | Short messaging service validation type. |\n| IVR | Interactive voice response validation type. |\n| CALL | Standard call validation type. |\n| UNKNOWN | Unknown validation type. |\n\nExample(s):
\nSMS\n" example: SMS enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string description: "Indicates the validation status. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SUCCESS | Indicates a successful validation status. |\n| FAILURE | Indicates a failed validation status. |\n| SKIPPED | Indicates a skipped validation status. |\n| UNKNOWN | Indicates an unknown validation status. |\n\nExample(s):
\nSUCCESS\n" example: SUCCESS enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time description: "Indicates the date-timestamp of the validated date. \n\nExample(s):
\n1513812227000\n" example: '1513812227000' validatedBy: type: string description: "Indicates the user who performed the validation. \n\nExample(s):
\nJAS
\nr0t05pj\n" shipNode: type: object description: 'Indicates an object detailing ship node information. ' properties: type: type: string description: "Indicates the ship node type. \n\nValid values are: \n\n| Value | Meaning |\n| --- | --- |\n| SellerFulfilled | Ship node for items fulfilled by seller. |\n| WFSFulfilled | Ship node for items fulfilled by Walmart Fulfillment Services (WFS). |\n| 3PLFulfillled | Ship node for items fulfilled by third party logistics (3PL). |\n\nExample(s):
\nSellerFulfilled\n" example: SellerFulfilled name: type: string description: "Indicates the ship node name. \n\nExample(s):
\nNorth Facility\n" example: North Facility id: type: string description: "Indicates the ship node identifer. \n\nExample(s):
\n135\n" example: '135' x-tagGroups: - name: 1P Suppliers DSV Orders Reference tags: - DSV Orders tags: - name: DSV Orders