--- updatedAt: 2026-08-03T18:13:11.000Z --- # Shipping Updates

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


*** ### Process Mode The `processMode` parameter enables sellers to track and update shipment information after the order has already shipped. It differentiates between the initial shipment and subsequent shipment updates. This parameter is optional. If not provided, the update is treated as a regular shipment update. The following table describes the `processMode` parameter: | Description | Required | | --------------------------------------------- | -------- | | Allows tracking of order shipment information | Yes | [block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "version": "1.0", "title": "Order Management", "description": "The Walmart Order Management APIs help Sellers to manage customer’s Sales Orders and to stay up-to-date on orders fulfillment, which orders to fulfill, and when to fulfill them." }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false, "explorer-enabled": true }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" } ], "paths": { "/v3/ca/orders/{purchaseOrderId}/shipping": { "post": { "tags": [ "Orders" ], "summary": "Shipping Updates", "description": "

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


", "operationId": "shippingUpdatesCA", "parameters": [ { "name": "purchaseOrderId", "in": "path", "description": "The purchase order ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "description": "A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "WM_QOS.CORRELATION_ID", "description": "A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID", "required": true, "schema": { "type": "string" }, "example": "b3261d2d-028a-4ef7-8602-633c23200af6" }, { "in": "header", "name": "WM_SVC.NAME", "description": "Walmart Service Name", "required": true, "schema": { "type": "string" }, "example": "Walmart Service Name" }, { "name": "WM_SEC.TIMESTAMP", "in": "header", "description": "The Epoch timestamp", "required": true, "schema": { "type": "string" }, "example": "1443748249449" }, { "name": "WM_SEC.AUTH_SIGNATURE", "in": "header", "description": "The vendor's digital signature, generated by running the JAR file or custom generation code", "required": true, "schema": { "type": "string" }, "example": "9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=" }, { "name": "WM_CONSUMER.ID", "in": "header", "description": "A unique ID required to access the API", "required": true, "schema": { "type": "string" }, "example": "Get the Consumer ID from Developer Center after logging in" } ], "x-readme": { "code-samples": [ { "language": "curl", "code": "curl -X 'POST' 'https://marketplace.walmartapis.com/v3/ca/orders/2e3e3e/shipping' \n -H 'accept: application/xml' \n -H 'WM_CONSUMER.CHANNEL.TYPE: test' \n -H 'WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6' \n -H 'WM_SVC.NAME: Walmart Service Name' \n -H 'WM_SEC.TIMESTAMP: 1443748249449' \n -H 'WM_SEC.AUTH_SIGNATURE: 9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=' -H 'WM_CONSUMER.ID: Get the Consumer ID from Developer Center after logging in' \n -H 'Content-Type: application/xml' \n -d 'stringAFCREATEDstringstringEACHstring2025-03-18T07:59:56.239ZstringUPSStandardstringstringstringstring2025-03-18T07:59:56.239Z'", "name": "xml payload for example 1" } ] }, "requestBody": { "description": "File fields", "content": { "application/xml": { "schema": { "required": [ "orderLines" ], "type": "object", "properties": { "orderLines": { "required": [ "orderLine" ], "type": "object", "properties": { "orderLine": { "type": "array", "description": "Information about one order line shipment", "items": { "required": [ "lineNumber", "orderLineStatuses", "shipFromCountry" ], "type": "object", "properties": { "lineNumber": { "type": "string", "description": "orderLine number" }, "shipFromCountry": { "type": "string", "description": "The ship from country is associated with the details for each individual item in the purchase order", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "orderLineStatuses": { "required": [ "orderLineStatus" ], "type": "object", "properties": { "orderLineStatus": { "type": "array", "description": "Details about the Order Line status", "items": { "required": [ "status", "statusQuantity", "trackingInfo" ], "type": "object", "properties": { "status": { "type": "string", "description": "Use 'Shipped'", "enum": [ "CREATED", "ACKNOWLEDGED", "SHIPPED", "CANCELLED", "REFUND" ] }, "asn": { "required": [ "packageASN" ], "type": "object", "properties": { "packageASN": { "type": "string" }, "palletASN": { "type": "string" } } }, "statusQuantity": { "required": [ "amount", "unitOfMeasurement" ], "type": "object", "properties": { "unitOfMeasurement": { "type": "string", "description": "Unit of quantity", "enum": [ "EACH", "EA" ] }, "amount": { "type": "string", "description": "The quantity of the unit of measurement for the item." } }, "description": "Details about the status update" }, "trackingInfo": { "required": [ "carrierName", "methodCode", "shipDateTime", "trackingNumber" ], "type": "object", "properties": { "shipDateTime": { "type": "string", "description": "The date the package was shipped", "format": "date-time" }, "carrierName": { "type": "object", "properties": { "otherCarrier": { "type": "string", "description": "Other carrier name" }, "carrier": { "type": "string", "description": "The package shipment carrier", "enum": [ "UPS", "USPS", "FedEx", "CPC", "PCLINT", "DHL", "GLB", "PURINTL_SWWGROUND", "FEDEX_SWWEXPRESS", "17Track", "ASL", "CANPAR", "CEVA", "LOOMIS", "SAMEDAY", "SWYFT", "TFORCE", "UBI", "JIAYOU", "LETTERMAIL" ] } }, "description": "Information about the package carrier(s)" }, "methodCode": { "type": "string", "description": "The shipping method. Can be one of the following: Standard, Express, Oneday, or Freight", "enum": [ "Standard", "Express", "OneDay", "Freight", "WhiteGlove", "Value" ] }, "trackingNumber": { "type": "string", "description": "The shipment tracking number required for all non-Lettermail shipments" }, "trackingURL": { "type": "string", "description": "The URL for tracking the shipment" }, "packageStatus": { "type": "string", "description": "Status of the shipment package" }, "shipmentNo": { "type": "string", "description": "The shipment number. This will be same for all packages in a shipment" }, "actualDeliveryDateTime": { "type": "string", "description": "Delivery datetime of the shipment package", "format": "date-time" } } } }, "description": "Details about the Order Line status" } } }, "description": "A list of status updates for that orderLine, including shipping status updates" } }, "description": "Information about one order line shipment" } } }, "description": "List of orderLines in the shipment" } }, "description": "Information about a shipment", "xml": { "name": "orderShipment" } }, "example": "\n\n \n \n 2\n CA\n \n \n Shipped\n \n Each\n 1\n \n \n 2016-06-27T05:30:15.000Z\n \n FedEx\n \n Standard\n 12333634122\n http://www.fedex.com\n \n \n \n \n \n" } }, "required": true }, "responses": { "200": { "description": "Successful Operation", "content": { "application/xml": { "schema": { "required": [ "customerEmailId", "customerOrderId", "orderDate", "orderLines", "purchaseOrderId", "shippingInfo" ], "type": "object", "properties": { "purchaseOrderId": { "type": "string", "description": "A unique ID associated with the seller's purchase order" }, "customerOrderId": { "type": "string", "description": "A unique ID associated with the sales order for specified customer" }, "customerEmailId": { "type": "string", "description": "The email address of the customer for the sales order" }, "orderDate": { "type": "string", "description": "The date the customer submitted the sales order", "format": "date-time" }, "shippingInfo": { "required": [ "estimatedDeliveryDate", "estimatedShipDate", "methodCode", "phone", "postalAddress" ], "type": "object", "properties": { "phone": { "type": "string", "description": "The customer's phone number" }, "estimatedDeliveryDate": { "type": "string", "description": "The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: '2016-06-15T06:00:00Z'", "format": "date-time" }, "estimatedShipDate": { "type": "string", "description": "The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: '2016-06-15T06:00:00Z'", "format": "date-time" }, "methodCode": { "type": "string", "description": "The shipping method. Can be one of the following: Standard, Express, Oneday, or Freight", "enum": [ "Standard", "Express", "OneDay", "Freight", "WhiteGlove", "Value" ] }, "postalAddress": { "required": [ "address1", "city", "country", "name", "postalCode", "state" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name for the shipment" }, "address1": { "type": "string", "description": "The first line of the shipping address" }, "address2": { "type": "string", "description": "The second line of the shipping address" }, "city": { "type": "string", "description": "The city of the shipping address" }, "state": { "type": "string", "description": "The state of the shipping address" }, "postalCode": { "type": "string", "description": "The zip code of the shipping address" }, "country": { "type": "string", "description": "The country of the shipping address" }, "addressType": { "type": "string", "description": "The address type, example: 'RESIDENTIAL'" } }, "description": "Elements of the customer's postal address" } }, "description": "The shipping information provided by the customer to the seller" }, "orderLines": { "type": "object", "properties": { "orderLine": { "type": "array", "description": "Purchase Order line information for each item", "items": { "required": [ "charges", "item", "lineNumber", "orderLineQuantity", "orderLineStatuses", "statusDate" ], "type": "object", "properties": { "lineNumber": { "type": "string", "description": "The line number associated with the details for each individual item in the purchase order" }, "shipFromCountry": { "type": "string", "description": "The ship from country is associated with the details for each individual item in the purchase order", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "item": { "required": [ "productName", "sku" ], "type": "object", "properties": { "productName": { "type": "string", "description": "The name of the product associated with the line item. Example: 'Kenmore CF1' or '2086883 Canister Secondary Filter Generic 2 Pack'" }, "sku": { "type": "string", "description": "An arbitrary alphanumeric unique ID, assigned to each item in the XSD file." } }, "description": "The information for the item on the orderLine" }, "charges": { "type": "object", "properties": { "charge": { "type": "array", "description": "List of elements that make up a charge", "items": { "required": [ "chargeAmount", "chargeName", "chargeType" ], "type": "object", "properties": { "chargeType": { "type": "string", "description": "The charge type for line items can be one of the following: PRODUCT or SHIPPING For details, refer to 'Charge Types'" }, "chargeName": { "type": "string", "description": "If chargeType is PRODUCT, chargeName is Item Price. If chargeType is SHIPPING, chargeName is Shipping" }, "chargeAmount": { "required": [ "amount", "currency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "The type of currency for the charge. Example: USD for US Dollars", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount for that charge. Example: 9.99" } }, "description": "The details for the amount of the tax charge" }, "tax": { "required": [ "taxAmount", "taxName" ], "type": "object", "properties": { "taxName": { "type": "string", "description": "The name associated with the tax. Example: 'Sales Tax'" }, "taxAmount": { "required": [ "amount", "currency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "The type of currency for the charge. Example: USD for US Dollars", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount for that charge. Example: 9.99" } }, "description": "The details for the amount of the tax charge" } }, "description": "Tax information for the charge, including taxName and taxAmount" } } } } }, "description": "Information relating to the charge for the orderLine" }, "orderLineQuantity": { "required": [ "amount", "unitOfMeasurement" ], "type": "object", "properties": { "unitOfMeasurement": { "type": "string", "description": "Unit of quantity", "enum": [ "EACH", "EA" ] }, "amount": { "type": "string", "description": "The quantity of the unit of measurement for the item." } }, "description": "Details about the status update" }, "statusDate": { "type": "string", "description": "The date shown on the recent order status", "format": "date-time" }, "orderLineStatuses": { "type": "object", "properties": { "orderLineStatus": { "type": "array", "description": "Details about the Order Line status", "items": { "required": [ "status", "statusQuantity" ], "type": "object", "properties": { "status": { "type": "string", "description": "Should be 'Created'", "enum": [ "CREATED", "ACKNOWLEDGED", "SHIPPED", "CANCELLED", "REFUND" ] }, "statusQuantity": { "required": [ "amount", "unitOfMeasurement" ], "type": "object", "properties": { "unitOfMeasurement": { "type": "string", "description": "Unit of quantity", "enum": [ "EACH", "EA" ] }, "amount": { "type": "string", "description": "The quantity of the unit of measurement for the item." } }, "description": "Details about the status update" }, "cancellationReason": { "type": "string", "description": "If order is cancelled, cancellationReason will explain the reason" }, "trackingInfo": { "required": [ "carrierName", "methodCode", "shipDateTime", "trackingNumber" ], "type": "object", "properties": { "shipDateTime": { "type": "string", "description": "The date the package was shipped", "format": "date-time" }, "carrierName": { "type": "object", "properties": { "otherCarrier": { "type": "string", "description": "Other carrier name" }, "carrier": { "type": "string", "description": "The package shipment carrier", "enum": [ "UPS", "USPS", "FedEx", "CPC", "PCLINT", "DHL", "GLB", "PURINTL_SWWGROUND", "FEDEX_SWWEXPRESS", "17Track", "ASL", "CANPAR", "CEVA", "LOOMIS", "SAMEDAY", "SWYFT", "TFORCE", "UBI", "JIAYOU", "LETTERMAIL" ] } }, "description": "Information about the package carrier(s)" }, "methodCode": { "type": "string", "description": "The shipping method. Can be one of the following: Standard, Express, Oneday, or Freight", "enum": [ "Standard", "Express", "OneDay", "Freight", "WhiteGlove", "Value" ] }, "trackingNumber": { "type": "string", "description": "The shipment tracking number required for all non-Lettermail shipments" }, "trackingURL": { "type": "string", "description": "The URL for tracking the shipment" }, "packageStatus": { "type": "string", "description": "Status of the shipment package" }, "shipmentNo": { "type": "string", "description": "The shipment number. This will be same for all packages in a shipment" }, "actualDeliveryDateTime": { "type": "string", "description": "Delivery datetime of the shipment package", "format": "date-time" } } }, "shipmentPackages": { "required": [ "shipmentPackage" ], "type": "object", "properties": { "shipmentPackage": { "type": "array", "items": { "required": [ "carrierName", "methodCode", "shipDateTime", "trackingNumber" ], "type": "object", "properties": { "shipDateTime": { "type": "string", "description": "The date the package was shipped", "format": "date-time" }, "carrierName": { "type": "object", "properties": { "otherCarrier": { "type": "string", "description": "Other carrier name" }, "carrier": { "type": "string", "description": "The package shipment carrier", "enum": [ "UPS", "USPS", "FedEx", "CPC", "PCLINT", "DHL", "GLB", "PURINTL_SWWGROUND", "FEDEX_SWWEXPRESS", "17Track", "ASL", "CANPAR", "CEVA", "LOOMIS", "SAMEDAY", "SWYFT", "TFORCE", "UBI", "JIAYOU", "LETTERMAIL" ] } }, "description": "Information about the package carrier(s)" }, "methodCode": { "type": "string", "description": "The shipping method. Can be one of the following: Standard, Express, Oneday, or Freight", "enum": [ "Standard", "Express", "OneDay", "Freight", "WhiteGlove", "Value" ] }, "trackingNumber": { "type": "string", "description": "The shipment tracking number required for all non-Lettermail shipments" }, "trackingURL": { "type": "string", "description": "The URL for tracking the shipment" }, "packageStatus": { "type": "string", "description": "Status of the shipment package" }, "shipmentNo": { "type": "string", "description": "The shipment number. This will be same for all packages in a shipment" }, "actualDeliveryDateTime": { "type": "string", "description": "Delivery datetime of the shipment package", "format": "date-time" } } } } }, "description": "List of information about the shipment packages and tracking updates" } }, "description": "Details about the Order Line status" } } }, "description": "A list of statuses for the Order Line" }, "refund": { "required": [ "refundCharges" ], "type": "object", "properties": { "refundId": { "type": "string" }, "refundComments": { "type": "string" }, "refundCharges": { "type": "object", "properties": { "refundCharge": { "type": "array", "items": { "required": [ "charge", "refundReason" ], "type": "object", "properties": { "refundReason": { "type": "string", "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": { "required": [ "chargeAmount", "chargeName", "chargeType" ], "type": "object", "properties": { "chargeType": { "type": "string", "description": "The charge type for line items can be one of the following: PRODUCT or SHIPPING For details, refer to 'Charge Types'" }, "chargeName": { "type": "string", "description": "If chargeType is PRODUCT, chargeName is Item Price. If chargeType is SHIPPING, chargeName is Shipping" }, "chargeAmount": { "required": [ "amount", "currency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "The type of currency for the charge. Example: USD for US Dollars", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount for that charge. Example: 9.99" } }, "description": "The details for the amount of the tax charge" }, "tax": { "required": [ "taxAmount", "taxName" ], "type": "object", "properties": { "taxName": { "type": "string", "description": "The name associated with the tax. Example: 'Sales Tax'" }, "taxAmount": { "required": [ "amount", "currency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "The type of currency for the charge. Example: USD for US Dollars", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount for that charge. Example: 9.99" } }, "description": "The details for the amount of the tax charge" } }, "description": "Tax information for the charge, including taxName and taxAmount" } } } } } } } } }, "description": "Details about any refund on the order" }, "originalCarrierMethod": { "type": "string" }, "referenceLineId": { "type": "string" }, "fulfillment": { "type": "object", "properties": { "fulfillmentOption": { "type": "string" }, "shipMethod": { "type": "string" }, "storeId": { "type": "string" }, "offerId": { "type": "string" }, "pickUpDateTime": { "type": "string", "format": "date-time" }, "pickUpBy": { "type": "string" } } }, "intentToCancel": { "type": "string" }, "configId": { "type": "string" } }, "description": "Purchase Order line information for each item" } } }, "description": "A list of order lines in the order" } }, "description": "Information about the purchase order" }, "example": "\n\n 2575193093772\n 4021603841173\n mgr@walmartlabs.com\n 2016-05-11T22:55:28.000Z\n \n 6502248603\n 2016-05-20T17:00:00.000Z\n 2016-05-16T17:00:00.000Z\n Standard\n \n Joe Doe PGOMS\n 860 W Cal Ave\n Seat # 860C.2.176\n Sunnyvale\n CA\n 94086\n USA\n RESIDENTIAL\n \n \n \n \n 2\n CA\n \n Garmin Refurbished nuvi 2595LMT 5 GPS w Lifetime Maps and Traffic\n GRMN100201\n \n \n \n PRODUCT\n ItemPrice\n \n USD\n 124.98\n \n \n Tax1\n \n USD\n 10.93\n \n \n \n \n \n EACH\n 1\n \n 2016-06-03T23:44:41.000Z\n \n \n Shipped\n \n EACH\n 1\n \n \n 2016-06-27T05:30:15.000Z\n \n FedEx\n \n Standard\n 12333634122\n http://www.fedex.com\n \n \n \n \n \n" } } } } } } } } ```