openapi: 3.0.1 info: title: Walmart 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. servers: - url: https://marketplace.walmartapis.com description: Production URL - url: https://sandbox.walmartapis.com description: Sandbox URL security: - basicScheme: [] paths: "/v3/orders/{purchaseOrderId}/shipping": post: tags: - Orders summary: Walmart Ship Order Lines description: Updates the status of order lines to Shipped and trigger the charge to the customer. The response to a successful call contains the order with the shipped line items. operationId: shippingUpdates parameters: - name: purchaseOrderId in: path description: purchaseOrderId required: true schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 requestBody: description: File fields content: application/json: schema: type: object properties: orderShipment: required: - orderLines type: object properties: processMode: type: string description: Optional. Use this parameter only to update tracking information after order is shipped. Use 'PARTIAL_UPDATE' as value. Here PARTIAL_UPDATE will indicate that post shipment tracking information needs to be updated orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information about one order line shipment items: required: - lineNumber - orderLineStatuses - sellerOrderId type: object properties: lineNumber: type: string description: The line number associated with the details for each individual item in the purchase order intentToCancelOverride: type: boolean description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer default: false sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates sellerOrderNo: type: string writeOnly: true description: Information about one order line shipment description: List of orderLines in the shipment description: Information about a shipment xml: name: orderShipment example: orderShipment: orderLines: orderLine: - lineNumber: '1' intentToCancelOverride: false sellerOrderId: '92344' orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1580821866000 carrierName: carrier: UPS methodCode: Standard trackingNumber: '22344' trackingURL: http://walmart/tracking/ups?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92345 returnCenterAddress: name: walmart address1: walmart store 2 city: Huntsville state: AL postalCode: '35805' country: USA dayPhone: '12344' emailId: walmart@walmart.com - lineNumber: '2' sellerOrderId: '92344' orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1580821866000 carrierName: carrier: FedEx methodCode: Express trackingNumber: '22344' trackingURL: http://walmart/tracking/fedEx?&type=MP&seller_id=12345&promise_date=03/02/2020&dzip=92840&tracking_numbers=92344 returnCenterAddress: name: walmart address1: walmart store 2 city: Huntsville state: AL postalCode: '35805' country: USA dayPhone: '12344' emailId: walmart@walmart.com application/xml: schema: type: object properties: orderShipment: required: - orderLines type: object properties: processMode: type: string description: Optional. Use this parameter only to update tracking information after order is shipped. Use 'PARTIAL_UPDATE' as value. Here PARTIAL_UPDATE will indicate that post shipment tracking information needs to be updated orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information about one order line shipment items: required: - lineNumber - orderLineStatuses - sellerOrderId type: object properties: lineNumber: type: string description: The line number associated with the details for each individual item in the purchase order intentToCancelOverride: type: boolean description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer default: false sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates sellerOrderNo: type: string writeOnly: true description: Information about one order line shipment description: List of orderLines in the shipment description: Information about a shipment xml: name: orderShipment example: |- 1 false Shipped Each 1 2020-07-17T17:04:42 UPS Standard 1Z97Y4430300463366 required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: order: purchaseOrderId: '1234567891234' customerOrderId: '9876543212345' sellerOrderId: '13233454564657' customerEmailId: customer@walmartlabs.com orderDate: 1478284060000 shippingInfo: phone: '6501234567' estimatedDeliveryDate: 1479798000000 estimatedShipDate: 1478674800000 methodCode: Value postalAddress: name: Jane Doe address1: 123 Main street city: Sunnyvale state: CA postalCode: '94086' country: USA addressType: OFFICE orderLines: orderLine: - lineNumber: '1' item: productName: Kenmore CF-1 or 20-86883 Canister Secondary Filter Generic 2 Pack sku: wei-ASSET-675gku675 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 555 tax: taxName: Tax1 taxAmount: currency: USD amount: 48.56 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1478297929000 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1438163400000 carrierName: carrier: FedEx methodCode: Value trackingNumber: '911001572321619861' trackingURL: http://www.fedex.com/Tracking?action=track=english=us=x=911001572321619861 returnCenterAddress: name: ABC address1: 123 Bridge street city: Huntsville state: AL postalCode: '35805' country: USA dayPhone: '6501234567' emailId: RCemailaddress@company.com application/xml: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: |- 2575193093772 4021603841173 mgr@walmartlabs.com 2016-05-11T22:55:28.000Z 6502248603 2016-05-20T17:00:00.000Z 2016-05-16T17:00:00.000Z Standard Joe Doe PGOMS 860 W Cal Ave Seat # 860C.2.176 Sunnyvale CA 94086 USA RESIDENTIAL 2 Garmin Refurbished nuvi 2595LMT 5 GPS w Lifetime Maps and Traffic GRMN100201 PRODUCT ItemPrice USD 124.98 Tax1 USD 10.93 EACH 1 2016-06-03T23:44:41.000Z Shipped EACH 1 2016-06-27T05:30:15.000Z FedEx Standard 12333634122 http://www.fedex.com "/v3/orders/{purchaseOrderId}/refund": post: tags: - Orders summary: Walmart Refund Order Lines description: Refunds one or more order lines that have been shipped. The response to a successful call contains the order with the refunded line items operationId: refundOrderLines parameters: - name: purchaseOrderId in: path description: purchaseOrderId required: true schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 requestBody: description: File fields content: application/json: schema: type: object properties: orderRefund: required: - orderLines - purchaseOrderId type: object properties: purchaseOrderId: type: string orderLines: required: - orderLine type: object properties: orderLine: type: array items: required: - lineNumber - refunds type: object properties: lineNumber: type: string isFullRefund: type: boolean description: |- Specifies that a full Refund is required to be set as true to do a full refund including all the applicable charges like tax and shipping. If full refund is set as false and full item price is entered in the charge amount field, applicable charges like tax and shipping will also be refunded to perform a full refund. In case of request containing multiple order lines, all order lines should either be of full refund scenario or partial refund but not both. Allowed values are true and false. default: false refunds: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order xml: name: orderRefund example: orderRefund: purchaseOrderId: '2577453162650' orderLines: orderLine: - lineNumber: '4' isFullRefund: false refunds: refund: - refundComments: test test refundCharges: refundCharge: - refundReason: Merchandise not received charge: chargeType: PRODUCT chargeName: Item Price chargeAmount: currency: USD amount: -0.1 tax: taxName: Item Price Tax taxAmount: currency: USD amount: -0.1 application/xml: schema: required: - orderLines - purchaseOrderId type: object properties: purchaseOrderId: type: string orderLines: required: - orderLine type: object properties: orderLine: type: array items: required: - lineNumber - refunds type: object properties: lineNumber: type: string isFullRefund: type: boolean description: |- Specifies that a full Refund is required to be set as true to do a full refund including all the applicable charges like tax and shipping. If full refund is set as false and full item price is entered in the charge amount field, applicable charges like tax and shipping will also be refunded to perform a full refund. In case of request containing multiple order lines, all order lines should either be of full refund scenario or partial refund but not both. Allowed values are true and false. default: false refunds: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order xml: name: orderRefund example: | 2575193093772 1 false test test DamagedItem PRODUCT Item Price USD -10.02 Item Price Tax USD -5.03 TaxExemptCustomer SHIPPING Shipping Price USD -1.02 Shipping Tax USD -0.05 required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: order: purchaseOrderId: '2577573191435' customerOrderId: '5571600820146' customerEmailId: VBayana@walmartlabs.com orderDate: 1476392223000 shippingInfo: phone: '6502248603' estimatedDeliveryDate: 1479798000000 estimatedShipDate: 1476424800000 methodCode: Standard postalAddress: name: Madhukara PGOMS address1: 860 W Cal Ave address2: 'Seat # 860C.2.176' city: Sunnyvale state: CA postalCode: '94086' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Ozark Trail 4-Person Dome Tent sku: NJ_WITHOUT_RCA_003 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 19.99 tax: taxName: Tax1 taxAmount: currency: USD amount: 0 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 2 tax: taxName: Tax2 taxAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1476470187000 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1475008215000 carrierName: carrier: FedEx methodCode: Standard trackingNumber: '3445435443441221' trackingURL: http://www.fedex.com refund: refundCharges: refundCharge: - refundReason: BillingError charge: chargeType: PRODUCT chargeName: Billing Error chargeAmount: currency: USD amount: -19.99 - refundReason: BillingError charge: chargeType: SHIPPING chargeName: Billing Error chargeAmount: currency: USD amount: -2 application/xml: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: |- 2575193093772 4021603841173 mgr@walmartlabs.com 2016-05-11T22:55:28.000Z 6502248603 2016-05-20T17:00:00.000Z 2016-05-16T17:00:00.000Z Standard Joe Doe PGOMS 860 W Cal Ave Seat # 860C.2.176 Sunnyvale CA 94086 USA RESIDENTIAL 2 Garmin Refurbished nuvi 2595LMT 5 GPS w Lifetime Maps and Traffic GRMN100201 PRODUCT ItemPrice USD 124.98 Tax1 USD 10.93 SHIPPING Shipping USD 2.00 Tax2 USD 0.19 EACH 1 2016-06-03T23:48:00.000Z Shipped EACH 1 2016-06-27T05:30:15.000Z FedEx Standard 12333634122 http://www.fedex.com DamagedItem PRODUCT Damaged USD -10.02 Product USD -5.03 TaxExemptCustomer SHIPPING Tax Exempt USD -1.02 Shipping USD -0.05 "/v3/orders/{purchaseOrderId}/cancel": post: tags: - Orders summary: Walmart Cancel Order Lines description: You can cancel one or more order lines. You must include a purchaseOrderId when cancelling an order line. The response to a successful call contains the order with the cancelled line items operationId: cancelOrderLines parameters: - name: purchaseOrderId in: path description: purchaseOrderId required: true schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 requestBody: description: File fields content: application/json: schema: type: object properties: orderCancellation: required: - orderLines type: object properties: orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information to update the orderLine with cancellation details items: required: - lineNumber - orderLineStatuses type: object properties: lineNumber: type: string orderLineStatuses: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status description: Information to update the orderLine with cancellation details description: A list of orderLines to be cancelled description: Container for the cancellation details xml: name: orderCancellation example: orderCancellation: orderLines: orderLine: - lineNumber: '1' orderLineStatuses: orderLineStatus: - status: Cancelled cancellationReason: CUSTOMER_REQUESTED_SELLER_TO_CANCEL statusQuantity: unitOfMeasurement: EA amount: '1' application/xml: schema: required: - orderLines type: object properties: orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information to update the orderLine with cancellation details items: required: - lineNumber - orderLineStatuses type: object properties: lineNumber: type: string orderLineStatuses: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status description: Information to update the orderLine with cancellation details description: A list of orderLines to be cancelled description: Container for the cancellation details xml: name: orderCancellation example: |- 1 Cancelled CUSTOMER_REQUESTED_SELLER_TO_CANCEL EACH 1 required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: order: purchaseOrderId: '1577914061094' customerOrderId: '5571600820432' customerEmailId: VBayana@walmartlabs.com orderDate: 1476387173000 shippingInfo: phone: '6502248603' estimatedDeliveryDate: 1479798000000 estimatedShipDate: 1476424800000 methodCode: Standard postalAddress: name: Madhukara PGOMS address1: 860 W Cal Ave address2: 'Seat # 860C.2.176' city: Sunnyvale state: CA postalCode: '94086' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Ozark Trail 4-Person Dome Tent sku: NJ_WITHOUT_RCA_003 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 tax: taxName: Tax1 taxAmount: currency: USD amount: 0 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 0 tax: taxName: Tax2 taxAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1481755720000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' "/v3/orders/{purchaseOrderId}/acknowledge": post: tags: - Orders summary: Walmart Acknowledge Orders description: You can use this API to acknowledge an entire order, including all of its order lines. The response to a successful call contains the acknowledged order. operationId: acknowledgeOrders parameters: - name: purchaseOrderId in: path description: purchaseOrderId required: true schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 responses: '200': description: Successful Operation content: application/json: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: order: purchaseOrderId: '1796277083022' customerOrderId: '5281956426648' customerEmailId: 3A31739D8B0A45A1B23F7F8C81C8747F@relay.walmart.com orderDate: 1568466571000 shippingInfo: phone: '3155598681' estimatedDeliveryDate: 1569438000000 estimatedShipDate: 1568700000000 methodCode: Value postalAddress: name: Kathryn Cole address1: 3258BWarners rd address2: Garage city: Warners state: NY postalCode: '13164' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '4' item: productName: Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag sku: test1 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 10 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.8 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568753156000 orderLineStatuses: orderLineStatus: - status: Acknowledged statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1568919600000 application/xml: schema: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: |- 1796277083022 5281956426648 3A31739D8B0A45A1B23F7F8C81C8747F@relay.walmart.com 2019-09-14T13:09:31.000Z 3155598681 2019-09-25T19:00:00.000Z 2019-09-17T06:00:00.000Z Value Kathryn Cole 3258BWarners rd Garage Warners NY 13164 USA RESIDENTIAL 4 Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag test1 PRODUCT ItemPrice USD 10.00 Tax1 USD 0.80 EACH 1 2019-09-17T20:45:56.000Z Acknowledged EACH 1 S2H VALUE 2019-09-19T19:00:00.000Z "/v3/orders": get: tags: - Orders summary: Walmart All Orders description: |- Retrieves the details of all the orders for specified search criteria. Only orders created in last 180 days and a maximum of 20000 orders can be fetched at a time. Attempting to download more than 20000 orders will return an error. operationId: getAllOrders parameters: - name: sku in: query description: A seller-provided Product ID required: false schema: type: string - name: customerOrderId in: query description: The customer order ID required: false schema: type: string - name: purchaseOrderId in: query description: The purchase order ID. One customer may have multiple purchase orders. required: false schema: type: string - name: status in: query description: 'Status of purchase order line. Valid statuses are: Created, Acknowledged, Shipped, Delivered and Cancelled.' required: false schema: type: string - name: createdStartDate in: query description: 'Fetches all purchase orders that were created after this date. Default is current date - 7 days. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ).' required: false schema: type: string - name: createdEndDate in: query description: 'Fetches all purchase orders that were created before this date. Default is current date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ).' required: false schema: type: string - name: fromExpectedShipDate in: query description: 'Fetches all purchase orders that have order lines with an expected ship date after this date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ)' required: false schema: type: string - name: toExpectedShipDate in: query description: 'Fetches all purchase orders that have order lines with an expected ship date before this date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ)' required: false schema: type: string - name: lastModifiedStartDate in: query description: 'Fetches all purchase orders that were modified after this date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ).' required: false schema: type: string - name: lastModifiedEndDate in: query description: 'Fetches all purchase orders that were modified before this date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ).' required: false schema: type: string - name: limit in: query description: The number of orders to be returned. Cannot be larger than 200. required: false schema: type: string default: '100' - name: productInfo in: query description: Provides the image URL and product weight in response, if available. Allowed values are true or false. required: false schema: type: string default: 'false' - name: shipNodeType in: query description: Specifies the type of shipNode. Allowed values are SellerFulfilled(Default), WFSFulfilled and 3PLFulfilled. required: false schema: type: string default: SellerFulfilled - name: shippingProgramType in: query description: Specifies the type of program. Allowed value is TWO_DAY, ONE_DAY. required: false schema: type: string - name: replacementInfo in: query description: Provides additional attributes - originalCustomerOrderID, orderType - related to Replacement order, in response, if available. Allowed values are true or false. required: false schema: type: string default: 'false' - name: orderType in: query description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. required: false schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 responses: '200': description: Successful Operation content: application/json: schema: type: object properties: list: required: - elements - meta type: object properties: errors: type: array xml: name: error items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError meta: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list elements: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order description: List of purchase orders in created state xml: name: list example: list: meta: totalCount: 31 limit: 10 nextCursor: "?limit=10&hasMoreElements=true&soIndex=31&poIndex=10&partnerId=100009&sellerId=8&createdStartDate=2013-08-16&createdEndDate=2019-09-17T18:47:03.703Z" elements: order: - purchaseOrderId: '1796277083022' customerOrderId: '5281956426648' customerEmailId: 3A31739D8B0A45A1B23F7F8C81C8747F@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891234' orderDate: 1568466571000 shippingInfo: phone: '3155598681' estimatedDeliveryDate: 1569438000000 estimatedShipDate: 1568700000000 methodCode: Value postalAddress: name: Kathryn Cole address1: 3258BWarners rd address2: Garage city: Warners state: NY postalCode: '13164' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '4' item: productName: Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag sku: test1 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 10 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.8 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568466647000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1568919600000 - purchaseOrderId: '3796235970012' customerOrderId: '5241952426446' customerEmailId: 630083BD274E4FB2968D3166C8336151@relay.walmart.com orderType: REGULAR orderDate: 1568145593000 shippingInfo: phone: '4088592715' estimatedDeliveryDate: 1568919600000 estimatedShipDate: 1568181600000 methodCode: Value postalAddress: name: Steffen Matt address1: 1830 Mason St city: San Francisco state: CA postalCode: '94133' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 tax: taxName: Tax1 taxAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568527247000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1568401200000 - purchaseOrderId: '1796235744850' customerOrderId: '5231951859044' customerEmailId: 04BB1243498A43E9ADC8F1C9EAB622DC@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891235' orderDate: 1568075673000 shippingInfo: phone: '7732831392' estimatedDeliveryDate: 1568919600000 estimatedShipDate: 1568181600000 methodCode: Value postalAddress: name: Dorothy Kelly address1: 5831 N Kilpatrick Ave city: Chicago state: IL postalCode: '60646' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 tax: taxName: Tax1 taxAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568527281000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1568401200000 - purchaseOrderId: '2792525175246' customerOrderId: '5221950975717' customerEmailId: 9CE34D060D4E4A8F9504B70A564E32EB@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891236' orderDate: 1567984818000 shippingInfo: phone: '2564575354' estimatedDeliveryDate: 1568833200000 estimatedShipDate: 1568095200000 methodCode: Value postalAddress: name: Donna Becker address1: 6555 meandering way city: Lakewood ranch state: FL postalCode: '34202' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568440830000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1568314800000 - purchaseOrderId: '4792514745205' customerOrderId: '5211999883559' customerEmailId: FD63F38FD4ED41C6ACAC5A5988888E2B@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891237' orderDate: 1567863035000 shippingInfo: phone: '3053037923' estimatedDeliveryDate: 1568833200000 estimatedShipDate: 1568095200000 methodCode: Value postalAddress: name: Vivian Katzaroff address1: 945 Bay Dr apt 5 city: Miami Beach state: FL postalCode: '33141' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '2' item: productName: Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag sku: test1 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568441164000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1568314800000 - purchaseOrderId: '3796091528503' customerOrderId: '5101992777190' customerEmailId: 630083BD274E4FB2968D3166C8336151@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891238' orderDate: 1566937111000 shippingInfo: phone: '4088592715' estimatedDeliveryDate: 1567796400000 estimatedShipDate: 1566972000000 methodCode: Value postalAddress: name: Steffen Matt address1: 1830 Mason St city: San Francisco state: CA postalCode: '94133' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 tax: taxName: Tax1 taxAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1567317665000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1567191600000 - purchaseOrderId: '3796050123784' customerOrderId: '5061989889122' customerEmailId: 630083BD274E4FB2968D3166C8336151@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891239' orderDate: 1566600846000 shippingInfo: phone: '4088592715' estimatedDeliveryDate: 1567710000000 estimatedShipDate: 1566885600000 methodCode: Value postalAddress: name: Steffen Matt address1: 1830 Mason St city: San Francisco state: CA postalCode: '94133' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 9.99 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.85 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1566933889000 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1566933169000 carrierName: otherCarrier: USPS Marketplace methodCode: Value trackingNumber: '9400100000000000000000' trackingURL: http://walmart.narvar.com/walmart/tracking/usps?&type=MP&seller_id=8&promise_date=09/05/2019&dzip=94133&tracking_numbers=9400100000000000000000 fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1567105200000 - purchaseOrderId: '2792360062965' customerOrderId: '5061989884505' customerEmailId: 630083BD274E4FB2968D3166C8336151@relay.walmart.com orderType: REGULAR orderDate: 1566600299000 shippingInfo: phone: '4088592715' estimatedDeliveryDate: 1567710000000 estimatedShipDate: 1566885600000 methodCode: Value postalAddress: name: Steffen Matt address1: 1830 Mason St city: San Francisco state: CA postalCode: '94133' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 9.99 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.85 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1566601276000 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1566600700000 carrierName: carrier: USPS methodCode: Value trackingNumber: '9400100000000000000000' trackingURL: http://walmart.narvar.com/walmart/tracking/usps?&type=MP&seller_id=8&promise_date=09/05/2019&dzip=94133&tracking_numbers=9400100000000000000000 fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1567105200000 - purchaseOrderId: '2792338900105' customerOrderId: '5021986553201' customerEmailId: 6941EFC46C6541D0B8FE5914873EF869@relay.walmart.com orderType: REGULAR orderDate: 1566261956000 shippingInfo: phone: '4089130712' estimatedDeliveryDate: 1567105200000 estimatedShipDate: 1566367200000 methodCode: Value postalAddress: name: Sunitha Murthy address1: 9400 w parmer ln address2: 'Apt # 1027' city: Austin state: TX postalCode: '78717' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Qwik Time QT5 Quartz Metronome sku: TEST-02 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 9.99 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.62 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1566331993000 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1566331824000 carrierName: carrier: UPS methodCode: Value trackingNumber: '123456789' trackingURL: http://walmart.narvar.com/walmart/tracking/ups?&type=MP&seller_id=8&promise_date=08/29/2019&dzip=78717&tracking_numbers=123456789 fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1566586800000 - purchaseOrderId: '2792163543930' customerOrderId: '4851974348317' customerEmailId: 8244CABDE158461D9BF57F92BDD147D6@relay.walmart.com orderType: REGULAR orderDate: 1564794937000 shippingInfo: phone: '5019411012' estimatedDeliveryDate: 1565895600000 estimatedShipDate: 1565150400000 methodCode: Value postalAddress: name: Debbie Chandler address1: 1012 Campground Road city: Cabot state: AR postalCode: '72023' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '3' item: productName: Motorola TurboPower 15 USB-C / Type C car charger - Turbo Power for Moto Z, Z2, Z3, Z4, X4, G7, G6, G6 Plus [Not for G6 Play] (Retail Box) sku: AC004 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 0 tax: taxName: Tax1 taxAmount: currency: USD amount: 0 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1565496044000 orderLineStatuses: orderLineStatus: - status: Cancelled statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1565377200000 application/xml: schema: type: object properties: list: required: - elements - meta type: object properties: errors: type: array xml: name: error items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError meta: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list elements: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order description: List of purchase orders in created state xml: name: list example: |- 31 10 ?limit=10&hasMoreElements=true&soIndex=31&poIndex=10&partnerId=100009&sellerId=8&createdStartDate=2013-08-16&createdEndDate=2019-09-17T18:47:03.703Z 1796277083022 5281956426648 3A31739D8B0A45A1B23F7F8C81C8747F@relay.walmart.com REPLACEMENT 1234567891234 2019-09-14T13:09:31.000Z 3155598681 2019-09-25T19:00:00.000Z 2019-09-17T06:00:00.000Z Value Kathryn Cole 3258BWarners rd Garage Warners NY 13164 USA RESIDENTIAL 4 Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag test1 PRODUCT ItemPrice USD 10.00 Tax1 USD 0.80 EACH 1 2019-09-14T13:10:47.000Z Created EACH 1 S2H VALUE 2019-09-19T19:00:00.000Z 3796235970012 5241952426446 630083BD274E4FB2968D3166C8336151@relay.walmart.com REGULAR 2019-09-10T19:59:53.000Z 4088592715 2019-09-19T19:00:00.000Z 2019-09-11T06:00:00.000Z Value Steffen Matt 1830 Mason St San Francisco CA 94133 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 0.00 Tax1 USD 0.00 EACH 1 2019-09-15T06:00:47.000Z Cancelled EACH 1 S2H VALUE 2019-09-13T19:00:00.000Z 1796235744850 5231951859044 04BB1243498A43E9ADC8F1C9EAB622DC@relay.walmart.com REPLACEMENT 1234567891235 2019-09-10T00:34:33.000Z 7732831392 2019-09-19T19:00:00.000Z 2019-09-11T06:00:00.000Z Value Dorothy Kelly 5831 N Kilpatrick Ave Chicago IL 60646 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 0.00 Tax1 USD 0.00 EACH 1 2019-09-15T06:01:21.000Z Cancelled EACH 1 S2H VALUE 2019-09-13T19:00:00.000Z 2792525175246 5221950975717 9CE34D060D4E4A8F9504B70A564E32EB@relay.walmart.com REPLACEMENT 1234567891236 2019-09-08T23:20:18.000Z 2564575354 2019-09-18T19:00:00.000Z 2019-09-10T06:00:00.000Z Value Donna Becker 6555 meandering way Lakewood ranch FL 34202 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 0.00 EACH 1 2019-09-14T06:00:30.000Z Cancelled EACH 1 S2H VALUE 2019-09-12T19:00:00.000Z 4792514745205 5211999883559 FD63F38FD4ED41C6ACAC5A5988888E2B@relay.walmart.com REPLACEMENT 1234567891237 2019-09-07T13:30:35.000Z 3053037923 2019-09-18T19:00:00.000Z 2019-09-10T06:00:00.000Z Value Vivian Katzaroff 945 Bay Dr apt 5 Miami Beach FL 33141 USA RESIDENTIAL 2 Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag test1 PRODUCT ItemPrice USD 0.00 EACH 1 2019-09-14T06:06:04.000Z Cancelled EACH 1 S2H VALUE 2019-09-12T19:00:00.000Z 3796091528503 5101992777190 630083BD274E4FB2968D3166C8336151@relay.walmart.com REPLACEMENT 1234567891238 2019-08-27T20:18:31.000Z 4088592715 2019-09-06T19:00:00.000Z 2019-08-28T06:00:00.000Z Value Steffen Matt 1830 Mason St San Francisco CA 94133 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 0.00 Tax1 USD 0.00 EACH 1 2019-09-01T06:01:05.000Z Cancelled EACH 1 S2H VALUE 2019-08-30T19:00:00.000Z 3796050123784 5061989889122 630083BD274E4FB2968D3166C8336151@relay.walmart.com REPLACEMENT 1234567891239 2019-08-23T22:54:06.000Z 4088592715 2019-09-05T19:00:00.000Z 2019-08-27T06:00:00.000Z Value Steffen Matt 1830 Mason St San Francisco CA 94133 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 9.99 Tax1 USD 0.85 EACH 1 2019-08-27T19:24:49.000Z Shipped EACH 1 2019-08-27T19:12:49.000Z USPS Marketplace Value 9400100000000000000000 http://walmart.narvar.com/walmart/tracking/usps?&type=MP&seller_id=8&promise_date=09/05/2019&dzip=94133&tracking_numbers=9400100000000000000000 S2H VALUE 2019-08-29T19:00:00.000Z 2792360062965 5061989884505 630083BD274E4FB2968D3166C8336151@relay.walmart.com REGULAR 2019-08-23T22:44:59.000Z 4088592715 2019-09-05T19:00:00.000Z 2019-08-27T06:00:00.000Z Value Steffen Matt 1830 Mason St San Francisco CA 94133 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 9.99 Tax1 USD 0.85 EACH 1 2019-08-23T23:01:16.000Z Shipped EACH 1 2019-08-23T22:51:40.000Z USPS Value 9400100000000000000000 http://walmart.narvar.com/walmart/tracking/usps?&type=MP&seller_id=8&promise_date=09/05/2019&dzip=94133&tracking_numbers=9400100000000000000000 S2H VALUE 2019-08-29T19:00:00.000Z 2792338900105 5021986553201 6941EFC46C6541D0B8FE5914873EF869@relay.walmart.com REGULAR 2019-08-20T00:45:56.000Z 4089130712 2019-08-29T19:00:00.000Z 2019-08-21T06:00:00.000Z Value Sunitha Murthy 9400 w parmer ln Apt # 1027 Austin TX 78717 USA RESIDENTIAL 1 Qwik Time QT5 Quartz Metronome TEST-02 PRODUCT ItemPrice USD 9.99 Tax1 USD 0.62 EACH 1 2019-08-20T20:13:13.000Z Shipped EACH 1 2019-08-20T20:10:24.000Z UPS Value 123456789 http://walmart.narvar.com/walmart/tracking/ups?&type=MP&seller_id=8&promise_date=08/29/2019&dzip=78717&tracking_numbers=123456789 S2H VALUE 2019-08-23T19:00:00.000Z 2792163543930 4851974348317 8244CABDE158461D9BF57F92BDD147D6@relay.walmart.com REGULAR 2019-08-03T01:15:37.000Z 5019411012 2019-08-15T19:00:00.000Z 2019-08-07T04:00:00.000Z Value Debbie Chandler 1012 Campground Road Cabot AR 72023 USA RESIDENTIAL 3 Motorola TurboPower 15 USB-C / Type C car charger - Turbo Power for Moto Z, Z2, Z3, Z4, X4, G7, G6, G6 Plus [Not for G6 Play] (Retail Box) AC004 PRODUCT ItemPrice USD 0.00 Tax1 USD 0.00 EACH 1 2019-08-11T04:00:44.000Z Cancelled EACH 1 S2H VALUE 2019-08-09T19:00:00.000Z "/v3/orders/{purchaseOrderId}": get: tags: - Orders summary: Walmart an Order description: Retrieves an order detail for a specific purchaseOrderId operationId: getAnOrder parameters: - name: purchaseOrderId in: path description: purchaseOrderId required: true schema: type: string - name: productInfo in: query description: Provides the image URL and product weight in response, if available. Allowed values are true or false. required: false schema: type: string default: 'false' - name: replacementInfo in: query description: Provides additional attributes - originalCustomerOrderID, orderType - related to Replacement order, in response, if available. Allowed values are true or false. required: false schema: type: string default: 'false' - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 responses: '200': description: Successful Operation content: application/json: 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 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order examples: ORDER: value: order: purchaseOrderId: '1815367951431' customerOrderId: '4372135469400' customerEmailId: 7D9F02968955480499C84C5871AD1401@relay.walmart.com orderDate: 1623796407000 shippingInfo: phone: '3143450432' estimatedDeliveryDate: 1624647600000 estimatedShipDate: 1623906000000 methodCode: Value postalAddress: name: Donald Ashley address1: 6600 gazebo drive city: Cedar hill state: MO postalCode: '63016' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Mac Sports Heavy Duty Steel Double Decker Collapsible Yard Cart Wagon, Purple sku: YHY-FN25200B2 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 5 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.34 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1623835855623 orderLineStatuses: orderLineStatus: - status: Shipped statusQuantity: unitOfMeasurement: EACH amount: '1' trackingInfo: shipDateTime: 1623835855000 carrierName: carrier: USPS methodCode: Value trackingNumber: '435678956435467' trackingURL: https://www.walmart.com/tracking?tracking_id=435678956435467&order_id=1815367951431 fulfillment: fulfillmentOption: S2H shipMethod: VALUE pickUpDateTime: 1624647600000 shipNode: type: SellerFulfilled ATTRIBUTES: value: order: purchaseOrderId: '1796277083022' customerOrderId: '5281956426648' customerEmailId: 3A31739D8B0A45A1B23F7F8C81C8747F@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891234' orderDate: 1568466571000 shippingInfo: phone: '3155598681' estimatedDeliveryDate: 1569438000000 estimatedShipDate: 1568700000000 methodCode: Value postalAddress: name: Kathryn Cole address1: 3258BWarners rd address2: Garage city: Warners state: NY postalCode: '13164' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '4' item: productName: Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag sku: test1 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 10 tax: taxName: Tax1 taxAmount: currency: USD amount: 0.8 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1568466647000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' cancellationReason: xyz trackingInfo: shipDateTime: 1241715945678 carrierName: otherCarrier: xyz carrier: FED_EX methodCode: Standard carrierMethodCode: 19 trackingNumber: '001792410114462199' trackingURL: http://www.fedex.com/Tracking?action=track=english=us=x=001792410114462199 returnCenterAddress: name: xyz address1: xyz address2: xyz city: Sunnyvale state: CA postalCode: '123' country: CA dayPhone: '9999999' emailId: xyz@walmart.com refund: refundId: '123' refundComments: xyz refundCharges: refundCharge: - refundReason: INCORRECT_ITEM_RECEIVED charge: chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 798 tax: taxName: Tax1 taxAmount: currency: USD amount: 798 fulfillment: fulfillmentOption: S2H shipMethod: VALUE storeId: xyz pickUpDateTime: 1568919600000 pickUpBy: xyz shippingProgramType: THREE_TO_FIVE_DAY shipNode: type: 3PLFulfilled name: xyz id: '123' 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 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order example: | 1815367951431 4372135469400 7D9F02968955480499C84C5871AD1401@relay.walmart.com 2021-06-15T22:33:27.000Z 3143450432 2021-06-25T19:00:00.000Z 2021-06-17T05:00:00.000Z Value Donald Ashley 6600 gazebo drive Cedar hill MO 63016 USA RESIDENTIAL 1 Mac Sports Heavy Duty Steel Double Decker Collapsible Yard Cart Wagon, Purple YHY-FN25200B2 PRODUCT ItemPrice USD 5.00 Tax1 USD 0.34 EACH 1 2021-06-16T09:30:55.623Z Shipped EACH 1 2021-06-16T09:30:55.000Z USPS Value 435678956435467 https://www.walmart.com/tracking?tracking_id=435678956435467&order_id=1815367951431 S2H VALUE 2021-06-25T19:00:00.000Z SellerFulfilled "/v3/orders/released": get: tags: - Orders summary: Walmart All Released Orders description: |- Retrieves all the orders with line items that are in the "created" status, that is, these orders have been released from the Walmart Order Management System to the seller for processing. The released orders are the orders that are ready for a seller to fulfill. Only orders created in last 180 days and a maximum of 20000 orders can be fetched at a time. Attempting to download more than 20000 orders will return an error. operationId: getAllReleasedOrders parameters: - name: createdStartDate in: query description: 'Fetches all purchase orders that were created after this date. Default is current date - 7 days. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ).' required: false schema: type: string - name: createdEndDate in: query description: 'Fetches all purchase orders that were created before this date. Default is current date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ).' required: false schema: type: string - name: limit in: query description: The number of orders to be returned. Cannot be larger than 200. required: false schema: type: string default: '100' - name: productInfo in: query description: Provides the image URL and product weight in response, if available. Allowed values are true or false. required: false schema: type: string default: 'false' - name: shipNodeType in: query description: Specifies the type of shipNode. Allowed values are SellerFulfilled(Default), WFSFulfilled and 3PLFulfilled. required: false schema: type: string default: SellerFulfilled - name: sku in: query description: A seller-provided Product ID required: false schema: type: string - name: customerOrderId in: query description: The customer order ID required: false schema: type: string - name: purchaseOrderId in: query description: The purchase order ID. One customer may have multiple purchase orders. required: false schema: type: string - name: fromExpectedShipDate in: query description: 'Fetches all purchase orders that have order lines with an expected ship date after this date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ)' required: false schema: type: string - name: toExpectedShipDate in: query description: 'Fetches all purchase orders that have order lines with an expected ship date before this date. Use either UTC or ISO 8601 formats. Date example: ''2020-03-16''(yyyy-MM-dd). Date with Timestamp example: ''2020-03-16T10:30:15Z''(yyyy-MM-dd''T''HH:mm:ssZ)' required: false schema: type: string - name: shippingProgramType in: query description: Specifies the type of program. Allowed value is TWO_DAY, ONE_DAY. required: false schema: type: string - name: replacementInfo in: query description: Provides additional attributes - originalCustomerOrderID, orderType - related to Replacement order, in response, if available. Allowed values are true or false. required: false schema: type: string default: 'false' - name: orderType in: query description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. required: false schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - 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: false 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 responses: '200': description: Successful Operation content: application/json: schema: type: object properties: list: required: - elements - meta type: object properties: errors: type: array xml: name: error items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError meta: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list elements: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order description: List of purchase orders in created state xml: name: list example: list: meta: totalCount: 78449 limit: 10 nextCursor: "?limit=10&hasMoreElements=true&soIndex=78449&poIndex=10&partnerId=100009&sellerId=8&status=Created&createdStartDate=2013-08-16&createdEndDate=2019-10-24T17:41:15.701Z" elements: order: - purchaseOrderId: '4792982839409' customerOrderId: '5681962097195' customerEmailId: 9336DEB95193429EA032F07770C3E48A@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891234' orderDate: 1571903550000 shippingInfo: phone: '7992381678' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137n address1: 13227 City Square Dr city: Jacksonville state: CA postalCode: '12901' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '3' item: productName: Dummystresstest_MP_Home_29 sku: StressTestHome_29 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 tax: taxName: Tax1 taxAmount: currency: USD amount: 7.92 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903748000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '2792982839545' customerOrderId: '5681963507621' customerEmailId: 608603150B4049338B773566484C0591@relay.walmart.com orderType: REGULAR orderDate: 1571903539000 shippingInfo: phone: '7998673792' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137n address1: 2200 Wheatsheaf Ln city: Philadelphia state: CA postalCode: '28078' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '11' item: productName: Dummystresstest_MP_Home_55 sku: StressTestHome_55 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903763000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '2792982839414' customerOrderId: '5681962895313' customerEmailId: BC058103AF6C400E99FDEC95795F16AF@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891235' orderDate: 1571903538000 shippingInfo: phone: '7998211844' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778912575r SLast1340778912575r address1: 444 Castro St city: Mountain View state: CA postalCode: '94041' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '4' item: productName: Dummystresstest_MP_Home_13 sku: StressTestHome_13 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 tax: taxName: Tax1 taxAmount: currency: USD amount: 8.89 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903747000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '4792982839305' customerOrderId: '5681962393943' customerEmailId: B100013EF5B6415E97F13A1E2F76D33E@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891236' orderDate: 1571903537000 shippingInfo: phone: '7997281822' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778914882k SLast1340778914882k address1: 444 Castro St city: Mountain View state: CA postalCode: '94041' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '4' item: productName: Dummystresstest_MP_Home_31 sku: StressTestHome_31 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 tax: taxName: Tax1 taxAmount: currency: USD amount: 8.9 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903746000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '4792982839157' customerOrderId: '5681962094947' customerEmailId: F26C0523EB674390ABD87D8148A9CF9A@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891237' orderDate: 1571903536000 shippingInfo: phone: '7994363541' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137nt address1: 14507 Plank Rd city: Baker state: CA postalCode: '70714' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '3' item: productName: Dummystresstest_MP_Home_55 sku: StressTestHome_55 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903732000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '4792982839565' customerOrderId: '5681963200599' customerEmailId: B442C0D25766479DA1D98D0BEE18AA4E@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891238' orderDate: 1571903536000 shippingInfo: phone: '7997678284' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137nt address1: 925 Keyser Ave city: Natchitoches state: CA postalCode: '43311' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '3' item: productName: Dummystresstest_MP_Home_55 sku: StressTestHome_55 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 tax: taxName: Tax1 taxAmount: currency: USD amount: 7.18 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903765000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '4792982839536' customerOrderId: '5681963403079' customerEmailId: C087D231D7F846C3BBE04B1AC869F3FB@relay.walmart.com orderType: REPLACEMENT originalCustomerOrderID: '1234567891239' orderDate: 1571903535000 shippingInfo: phone: '7998487320' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137n address1: 100 Mcginnis Dr city: Wayne state: CA postalCode: '33323' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '4' item: productName: Dummystresstest_MP_Home_32 sku: StressTestHome_32 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903762000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '3796673088300' customerOrderId: '5681962299170' customerEmailId: A78E13850B234D4599FD6B42DB0EFB19@relay.walmart.com orderType: REGULAR orderDate: 1571903535000 shippingInfo: phone: '7999539847' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137nt address1: 4542 Kenowa Ave Sw city: Grandville state: CA postalCode: '33155' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '3' item: productName: Dummystresstest_MP_Home_55 sku: StressTestHome_55 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903716000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '1796673088779' customerOrderId: '5681963402652' customerEmailId: B7F3DF65F7DB47CD9F4108B5C2BA89BF@relay.walmart.com orderDate: 1571903535000 orderType: REGULAR shippingInfo: phone: '7995572470' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778269137n SLast1340778269137n address1: 1450 Johns Lake Rd city: Clermont state: CA postalCode: '30529' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '3' item: productName: Dummystresstest_MP_Home_13 sku: StressTestHome_13 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903748000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} - purchaseOrderId: '4792982839704' customerOrderId: '5681962096403' customerEmailId: B100013EF5B6415E97F13A1E2F76D33E@relay.walmart.com orderType: REGULAR orderDate: 1571903535000 shippingInfo: phone: '7997281822' estimatedDeliveryDate: 1572375600000 estimatedShipDate: 1572069600000 methodCode: Express postalAddress: name: SFirst1340778914882k SLast1340778914882k address1: 444 Castro St city: Mountain View state: CA postalCode: '94041' country: USA addressType: RESIDENTIAL orderLines: orderLine: - lineNumber: '1' item: productName: Dummystresstest_MP_Home_31 sku: StressTestHome_31 charges: charge: - chargeType: PRODUCT chargeName: ItemPrice chargeAmount: currency: USD amount: 99 tax: taxName: Tax1 taxAmount: currency: USD amount: 8.91 - chargeType: SHIPPING chargeName: Shipping chargeAmount: currency: USD amount: 60 orderLineQuantity: unitOfMeasurement: EACH amount: '1' statusDate: 1571903807000 orderLineStatuses: orderLineStatus: - status: Created statusQuantity: unitOfMeasurement: EACH amount: '1' fulfillment: fulfillmentOption: S2H shipMethod: EXPEDITED pickUpDateTime: 1572289200000 shipNode: {} application/xml: schema: type: object properties: list: required: - elements - meta type: object properties: errors: type: array xml: name: error items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError meta: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list elements: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order description: List of purchase orders in created state xml: name: list example: |- 78449 10 ?limit=10&hasMoreElements=true&soIndex=78449&poIndex=10&partnerId=100009&sellerId=8&status=Created&createdStartDate=2013-08-16&createdEndDate=2019-10-24T17:41:15.701Z 4792982839409 5681962097195 9336DEB95193429EA032F07770C3E48A@relay.walmart.com REPLACEMENT 1234567891234 2019-10-24T07:52:30.000Z 7992381678 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137n 13227 City Square Dr Jacksonville CA 12901 USA RESIDENTIAL 3 Dummystresstest_MP_Home_29 StressTestHome_29 PRODUCT ItemPrice USD 99.00 Tax1 USD 7.92 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:55:48.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 2792982839545 5681963507621 608603150B4049338B773566484C0591@relay.walmart.com REGULAR 2019-10-24T07:52:19.000Z 7998673792 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137n 2200 Wheatsheaf Ln Philadelphia CA 28078 USA RESIDENTIAL 11 Dummystresstest_MP_Home_55 StressTestHome_55 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:56:03.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 2792982839414 5681962895313 BC058103AF6C400E99FDEC95795F16AF@relay.walmart.com REPLACEMENT 1234567891235 2019-10-24T07:52:18.000Z 7998211844 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778912575r SLast1340778912575r 444 Castro St Mountain View CA 94041 USA RESIDENTIAL 4 Dummystresstest_MP_Home_13 StressTestHome_13 PRODUCT ItemPrice USD 99.00 Tax1 USD 8.89 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:55:47.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 4792982839305 5681962393943 B100013EF5B6415E97F13A1E2F76D33E@relay.walmart.com REPLACEMENT 1234567891236 2019-10-24T07:52:17.000Z 7997281822 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778914882k SLast1340778914882k 444 Castro St Mountain View CA 94041 USA RESIDENTIAL 4 Dummystresstest_MP_Home_31 StressTestHome_31 PRODUCT ItemPrice USD 99.00 Tax1 USD 8.90 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:55:46.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 4792982839157 5681962094947 F26C0523EB674390ABD87D8148A9CF9A@relay.walmart.com REPLACEMENT 1234567891237 2019-10-24T07:52:16.000Z 7994363541 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137nt 14507 Plank Rd Baker CA 70714 USA RESIDENTIAL 3 Dummystresstest_MP_Home_55 StressTestHome_55 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:55:32.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 4792982839565 5681963200599 B442C0D25766479DA1D98D0BEE18AA4E@relay.walmart.com REPLACEMENT 1234567891238 2019-10-24T07:52:16.000Z 7997678284 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137nt 925 Keyser Ave Natchitoches CA 43311 USA RESIDENTIAL 3 Dummystresstest_MP_Home_55 StressTestHome_55 PRODUCT ItemPrice USD 99.00 Tax1 USD 7.18 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:56:05.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 1796673089007 5681962798220 7DF73CDD9E134A8C9E5096111698FE5B@relay.walmart.com REPLACEMENT 1234567891239 2019-10-24T07:52:15.000Z 7993811707 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137n 2765 10Th Ave N Palm Springs CA 27612 USA RESIDENTIAL 2 Dummystresstest_MP_Home_29 StressTestHome_29 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 55.00 EACH 1 2019-10-24T07:56:20.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 13 Dummystresstest_MP_Home_29 StressTestHome_29 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 55.00 EACH 1 2019-10-24T07:56:20.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 3796673088300 5681962299170 A78E13850B234D4599FD6B42DB0EFB19@relay.walmart.com REGULAR 2019-10-24T07:52:15.000Z 7999539847 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137nt 4542 Kenowa Ave Sw Grandville CA 33155 USA RESIDENTIAL 3 Dummystresstest_MP_Home_55 StressTestHome_55 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:55:16.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 1796673088779 5681963402652 B7F3DF65F7DB47CD9F4108B5C2BA89BF@relay.walmart.com REGULAR 2019-10-24T07:52:15.000Z 7995572470 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137n 1450 Johns Lake Rd Clermont CA 30529 USA RESIDENTIAL 3 Dummystresstest_MP_Home_13 StressTestHome_13 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:55:48.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z 4792982839536 5681963403079 C087D231D7F846C3BBE04B1AC869F3FB@relay.walmart.com REGULAR 2019-10-24T07:52:15.000Z 7998487320 2019-10-29T19:00:00.000Z 2019-10-26T06:00:00.000Z Express SFirst1340778269137n SLast1340778269137n 100 Mcginnis Dr Wayne CA 33323 USA RESIDENTIAL 4 Dummystresstest_MP_Home_32 StressTestHome_32 PRODUCT ItemPrice USD 99.00 SHIPPING Shipping USD 60.00 EACH 1 2019-10-24T07:56:02.000Z Created EACH 1 S2H EXPEDITED 2019-10-28T19:00:00.000Z components: schemas: CarrierNameType: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) ChargeType: 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge ChargesType: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Information relating to the charge for the orderLine FulfillmentType: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information GetOrderResponse: type: object properties: order: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order GetOrderResponseRecord: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order ItemType: 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine MoneyType: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 MoneyTypeV2: 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 OrderLineStatusType: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status OrderLineStatusesType: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line OrderLineType: 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item OrderLinesType: type: object properties: orderLine: type: array description: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order OrderSubTotal: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal OrderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary PersonName: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean Phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address PhoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation PickupPerson: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson PostalAddressType: required: - address1 - city - country - name - postalCode - state type: object properties: name: type: string description: The name for the person/place of shipping address 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 QuantityType: 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 RefundChargeType: required: - charge - refundReason type: object properties: refundReason: type: string enum: - BillingError - TaxExemptCustomer - ItemNotAsAdvertised - IncorrectItemReceived - CancelledYetShipped - ItemNotReceivedByCustomer - IncorrectShippingPrice - DamagedItem - DefectiveItem - CustomerChangedMind - CustomerReceivedItemLate - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge RefundChargesType: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge RefundType: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order ReturnCenterAddressType: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified ShipNodesType: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode ShippingInfoType: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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 TaxType: 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 TrackingInfoType: required: - carrierName - methodCode - shipDateTime - trackingNumber type: object properties: shipDateTime: type: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates WeightType: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. AsnType: required: - packageASN type: object properties: packageASN: type: string palletASN: type: string CurrentTrackingInfoType: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. OrderShipment: type: object properties: orderShipment: required: - orderLines type: object properties: processMode: type: string description: Optional. Use this parameter only to update tracking information after order is shipped. Use 'PARTIAL_UPDATE' as value. Here PARTIAL_UPDATE will indicate that post shipment tracking information needs to be updated orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information about one order line shipment items: required: - lineNumber - orderLineStatuses - sellerOrderId type: object properties: lineNumber: type: string description: The line number associated with the details for each individual item in the purchase order intentToCancelOverride: type: boolean description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer default: false sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates sellerOrderNo: type: string writeOnly: true description: Information about one order line shipment description: List of orderLines in the shipment description: Information about a shipment xml: name: orderShipment OrderShipmentRecord: required: - orderLines type: object properties: processMode: type: string description: Optional. Use this parameter only to update tracking information after order is shipped. Use 'PARTIAL_UPDATE' as value. Here PARTIAL_UPDATE will indicate that post shipment tracking information needs to be updated orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information about one order line shipment items: required: - lineNumber - orderLineStatuses - sellerOrderId type: object properties: lineNumber: type: string description: The line number associated with the details for each individual item in the purchase order intentToCancelOverride: type: boolean description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer default: false sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates sellerOrderNo: type: string writeOnly: true description: Information about one order line shipment description: List of orderLines in the shipment description: Information about a shipment xml: name: orderShipment ShipLineStatusType: required: - status - statusQuantity - trackingInfo type: object properties: status: type: string description: Use 'Shipped' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status ShipLineStatusesType: 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates ShippingLineType: required: - lineNumber - orderLineStatuses - sellerOrderId type: object properties: lineNumber: type: string description: The line number associated with the details for each individual item in the purchase order intentToCancelOverride: type: boolean description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer default: false sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates sellerOrderNo: type: string writeOnly: true description: Information about one order line shipment ShippingLinesType: required: - orderLine type: object properties: orderLine: type: array description: Information about one order line shipment items: required: - lineNumber - orderLineStatuses - sellerOrderId type: object properties: lineNumber: type: string description: The line number associated with the details for each individual item in the purchase order intentToCancelOverride: type: boolean description: Needs to be passed as true during shipping as an acknowledgment for orders which are intent to cancel by the customer default: false sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters 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 - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified currentTrackingInfo: type: object properties: trackingNumber: type: string description: The shipment tracking number description: Once the shipment is done, to update tracking details in the PO, you must pass the tracking number to be updated under the new currentTrackingInfo field. description: Details about the Order Line status description: A list of status updates for that orderLine, including shipping status updates sellerOrderNo: type: string writeOnly: true description: Information about one order line shipment description: List of orderLines in the shipment OrderRefund: required: - orderLines - purchaseOrderId type: object properties: purchaseOrderId: type: string orderLines: required: - orderLine type: object properties: orderLine: type: array items: required: - lineNumber - refunds type: object properties: lineNumber: type: string isFullRefund: type: boolean description: |- Specifies that a full Refund is required to be set as true to do a full refund including all the applicable charges like tax and shipping. If full refund is set as false and full item price is entered in the charge amount field, applicable charges like tax and shipping will also be refunded to perform a full refund. In case of request containing multiple order lines, all order lines should either be of full refund scenario or partial refund but not both. Allowed values are true and false. default: false refunds: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order xml: name: orderRefund RefundLineType: required: - lineNumber - refunds type: object properties: lineNumber: type: string isFullRefund: type: boolean description: |- Specifies that a full Refund is required to be set as true to do a full refund including all the applicable charges like tax and shipping. If full refund is set as false and full item price is entered in the charge amount field, applicable charges like tax and shipping will also be refunded to perform a full refund. In case of request containing multiple order lines, all order lines should either be of full refund scenario or partial refund but not both. Allowed values are true and false. default: false refunds: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order RefundLinesType: required: - orderLine type: object properties: orderLine: type: array items: required: - lineNumber - refunds type: object properties: lineNumber: type: string isFullRefund: type: boolean description: |- Specifies that a full Refund is required to be set as true to do a full refund including all the applicable charges like tax and shipping. If full refund is set as false and full item price is entered in the charge amount field, applicable charges like tax and shipping will also be refunded to perform a full refund. In case of request containing multiple order lines, all order lines should either be of full refund scenario or partial refund but not both. Allowed values are true and false. default: false refunds: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order RefundsType: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order OrderRefund_json: type: object properties: orderRefund: required: - orderLines - purchaseOrderId type: object properties: purchaseOrderId: type: string orderLines: required: - orderLine type: object properties: orderLine: type: array items: required: - lineNumber - refunds type: object properties: lineNumber: type: string isFullRefund: type: boolean description: |- Specifies that a full Refund is required to be set as true to do a full refund including all the applicable charges like tax and shipping. If full refund is set as false and full item price is entered in the charge amount field, applicable charges like tax and shipping will also be refunded to perform a full refund. In case of request containing multiple order lines, all order lines should either be of full refund scenario or partial refund but not both. Allowed values are true and false. default: false refunds: required: - refund type: object properties: refund: type: array items: 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order xml: name: orderRefund CancelLineStatusType: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update CancelLineStatusesType: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status CancelLineType: required: - lineNumber - orderLineStatuses type: object properties: lineNumber: type: string orderLineStatuses: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status description: Information to update the orderLine with cancellation details CancelLinesType: required: - orderLine type: object properties: orderLine: type: array description: Information to update the orderLine with cancellation details items: required: - lineNumber - orderLineStatuses type: object properties: lineNumber: type: string orderLineStatuses: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status description: Information to update the orderLine with cancellation details description: A list of orderLines to be cancelled OrderCancellation: required: - orderLines type: object properties: orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information to update the orderLine with cancellation details items: required: - lineNumber - orderLineStatuses type: object properties: lineNumber: type: string orderLineStatuses: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status description: Information to update the orderLine with cancellation details description: A list of orderLines to be cancelled description: Container for the cancellation details xml: name: orderCancellation OrderCancellationResponse: type: object properties: orderCancellation: required: - orderLines type: object properties: orderLines: required: - orderLine type: object properties: orderLine: type: array description: Information to update the orderLine with cancellation details items: required: - lineNumber - orderLineStatuses type: object properties: lineNumber: type: string orderLineStatuses: required: - orderLineStatus type: object properties: orderLineStatus: type: array description: List of details about the cancellation status update items: required: - cancellationReason - status - statusQuantity type: object properties: status: type: string description: Use 'Cancelled' enum: - Created - Acknowledged - Shipped - Delivered - Cancelled - Refund cancellationReason: type: string description: |- Reason for cancellation. Example: 'CUSTOMER_REQUESTED_SELLER_TO_CANCEL'. Cancellation reason should not be "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" for non intent to cancel orders' Cancellation reason should not be "SELLER_CANCEL_FRAUD_STOP_SHIPMENT" for non fraudulent orders. If you suspect fraud, contact Walmart Risk Prevention Team (MPFraudReq@customercare.walmart.com). Include PO details and reason you suspect the order. We will contact you in 2-4 hours. If your suspicion of fraud is proven, we will cancel the order and notify you. enum: - CUSTOMER_REQUESTED_SELLER_TO_CANCEL - SELLER_CANCEL_PRICING_ERROR - SELLER_CANCEL_OUT_OF_STOCK - SELLER_CANCEL_FRAUD_STOP_SHIPMENT - SELLER_CANCEL_ADDRESS_NOT_SERVICEABLE 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 description: List of details about the cancellation status update description: A list of statuses which should contain the new cancellation status description: Information to update the orderLine with cancellation details description: A list of orderLines to be cancelled description: Container for the cancellation details xml: name: orderCancellation Cause: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause ElementsType: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order GatewayError: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError MetaType: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list PurchaseOrderTypeV3: type: object properties: list: required: - elements - meta type: object properties: errors: type: array xml: name: error items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError meta: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list elements: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order description: List of purchase orders in created state xml: name: list PurchaseOrderTypeV3List: required: - elements - meta type: object properties: errors: type: array xml: name: error items: required: - code type: object properties: code: type: string field: type: string description: type: string info: type: string severity: type: string enum: - INFO - WARN - ERROR category: type: string enum: - APPLICATION - SYSTEM - REQUEST - DATA causes: type: array xml: wrapped: true items: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause errorIdentifiers: type: object additionalProperties: type: object component: type: string type: type: string serviceName: type: string gatewayErrorCategory: type: string enum: - INTERNAL_DATA_ERROR - EXTERNAL_DATA_ERROR - SYSTEM_ERROR xml: name: GatewayError meta: type: object properties: totalCount: type: integer description: Total no of purchase orders. format: int32 limit: type: integer description: Number of purchase orders in the current page. format: int32 nextCursor: type: string description: String to be used as query parameter for getting next set of purchase orders, when more than 200 orders are retrieved. description: Meta data about the list elements: type: object properties: order: type: array description: Purchase Order List items: 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 orderType: type: string description: Specifies if the order is a regular order or replacement order. Possible values are REGULAR or REPLACEMENT. Provided in response only if query parameter replacementInfo=true. originalCustomerOrderID: type: string description: 'customer order ID of the original customer order on which the replacement is created. ' orderDate: type: integer description: The date the customer submitted the sales order format: int64 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order description: Information about the purchase order description: List of purchase orders in created state xml: name: list Order: 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 buyerId: type: string description: Unique ID associated with the specified buyer format: uuid mart: type: string description: Mart information isGuest: type: boolean description: Indicates a guest customer shippingInfo: required: - estimatedDeliveryDate - estimatedShipDate - methodCode - phone - postalAddress type: object properties: phone: type: string description: The customer's phone number estimatedDeliveryDate: type: integer description: 'The estimated time and date for the delivery of the item. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 estimatedShipDate: type: integer description: 'The estimated time and date when the item will be shipped. Format: yyyy-MM-ddThh:MM:ssZ Example: ''2020-06-15T06:00:00Z''' format: int64 methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value 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 person/place of shipping address 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: A list of order lines in the order 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 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 item file condition: type: string description: Information about the condition of the product. imageUrl: type: string description: Optional. Web URL for the image of the item. weight: required: - unit - value type: object properties: value: type: string description: Numerical amount of weight parameter. unit: type: string description: 'Standard value of measurement of the item. Example: ''Pounds''' description: Optional. Weight information for the item. description: The information for the item on the orderLine charges: type: object properties: charge: type: array description: Information relating to the charge for the orderLine 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge 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: integer description: The date shown on the recent order status format: int64 orderLineStatuses: type: object properties: orderLineStatus: type: array description: Detail List of Order Line status items: required: - status - statusQuantity type: object properties: status: type: string description: Should be 'Created' enum: - Created - Acknowledged - Shipped - Delivered - 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: integer description: The date the package was shipped format: int64 carrierName: type: object properties: otherCarrier: type: string description: Other carrier name, When otherCarrier is used, trackingUrl must also be provided carrier: type: string description: 'The package shipment carrier. Valid entries are: UPS, USPS, FedEx, Airborne, OnTrac, DHL Ecommerce - US, DHL, LS (LaserShip), UDS (United Delivery Service), UPSMI (UPS Mail Innovations), FDX, PILOT, ESTES, SAIA, FDS Express, Seko Worldwide, HIT Delivery, FEDEXSP (FedEx SmartPost), RL Carriers, Metropolitan Warehouse & Delivery, China Post, YunExpress,Yellow Freight Sys, AIT Worldwide Logistics, Chukou1, Sendle, Landmark Global, Sunyou, Yanwen, 4PX, GLS, OSM Worldwide, FIRST MILE, AM Trucking, CEVA, India Post, SF Express, CNE, TForce Freight, AxleHire, LSO, Royal Mail, ABF Freight System, WanB, Roadrunner Freight, Meyer Distribution, AAA Cooper, Canada Post, Southeastern Freight Lines, Japan Post, Correos de Mexico, XPO Logistics, JD Logistics, YDH, JCEX, Flyt, Deutsche Post, Better Trucks, Asendia, SFC, UBI, ePost Global, YF Logistics, RXO, Estes Express, Shypmax, WIN.IT America, PITT OHIO, PostNord Sweden, Equick, Whistl, Tusou, Shiprocket, DTDC, PTS.' enum: - UPS - USPS - FedEx - Airborne - OnTrac - DHL Ecommerce - US - DHL - LS - UDS - UPSMI - FDX - PILOT - ESTES - SAIA - FDS Express - Seko Worldwide - HIT Delivery - FEDEXSP - RL Carriers - Metropolitan Warehouse & Delivery - China Post - YunExpress - Yellow Freight Sys - AIT Worldwide Logistics - Chukou1 - Sendle - Landmark Global - Sunyou - Yanwen - 4PX - GLS - OSM Worldwide - FIRST MILE - AM Trucking - CEVA - India Post - SF Express - CNE - TForce Freight - AxleHire - LSO - Royal Mail - ABF Freight System - WanB - Roadrunner Freight - Meyer Distribution - AAA Cooper - Canada Post - Southeastern Freight Lines - Japan Post - Correos de Mexico - XPO Logistics - JD Logistics - YDH - JCEX - Flyt - Deutsche Post - Better Trucks - Asendia - SFC - UBI - ePost Global - YF Logistics - RXO - Estes Express - Shypmax - WIN.IT America - PITT OHIO - PostNord Sweden - Equick - Whistl - Tusou - Shiprocket - DTDC - PTS description: Information about the package carrier(s) methodCode: type: string description: 'The shipping method. Can be one of the following: Standard, Express, OneDay, WhiteGlove, Value or Freight' enum: - Standard - Express - OneDay - Freight - WhiteGlove - Value trackingNumber: type: string description: The shipment tracking number trackingURL: type: string description: The URL for tracking the shipment. This parameter is mandatory if the otherCarrier parameter is used description: List of information about the package shipment and tracking updates returnCenterAddress: required: - address1 - city - country - postalCode - state type: object properties: name: type: string description: The name for the person/place of return address address1: type: string description: The first line of the return address address2: type: string description: The second line of the return address city: type: string description: The city of the return address state: type: string description: The state of the return address postalCode: type: string description: The zip code of the return address country: type: string description: The country of the return address dayPhone: type: string description: Phone of the center where the package shipment is returned emailId: type: string description: Email of the center where the package shipment is returned description: Gives Sellers the ability to specify the RC center address during fulfillment; any returns created for the PO will always be returned to the RC address specified description: Detail List of Order Line status description: A list of statuses for the Order Line returnOrderId: type: string description: Id of the return order created in case of a full refund 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 - Missing Parts / Instructions - Finance -> Goodwill - Finance -> Rollback - 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 ItemPrice. If chargeType is PRODUCT and includes a chargeName as SubscriptionDiscount, these are subscription orders with a discount. 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: List of elements that make up a charge description: Details about any partial refund on the order originalCarrierMethod: type: string description: Ship method stamped at order line level when order is placed referenceLineId: type: string description: Reference line Id fulfillment: type: object properties: fulfillmentOption: type: string description: 'Example : S2H, S2S, etc.' shipMethod: type: string description: 'Example : Value, Expedited, Standard, Rush, etc.' storeId: type: string description: Store Id pickUpDateTime: type: integer description: Gives pick up datetime information format: int64 pickUpBy: type: string description: Gives pick up by information shippingProgramType: type: string description: Gives shipping program information. Examples TWO_DAY, THREE_DAY description: fulfillment information serialNumbers: type: array description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance items: type: string description: Unique identifier assigned by a manufacturer to an individual item, to uniquely identify it. This number helps with record-keeping, accuracy and compliance intentToCancel: type: string configId: type: string description: Sets ConfigID for Personalised orders sellerOrderId: type: string description: A unique ID associated with the sales order for specified Seller; gives Sellers the ability to print their own custom order ID on the return label; limit of 30 characters description: Purchase Order line information for each item description: A list of order lines in the order paymentTypes: type: array description: Payment Types xml: wrapped: true items: type: string description: Payment Types xml: name: paymentType orderSummary: type: object properties: totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 orderSubTotals: type: array xml: wrapped: true items: type: object properties: subTotalType: type: string totalAmount: required: - currencyAmount - currencyUnit type: object properties: currencyAmount: type: number currencyUnit: type: string 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 xml: name: orderSubTotal description: Order Summary xml: name: orderSummary pickupPersons: type: array description: List of pickup persons xml: wrapped: true items: type: object properties: name: type: object properties: completeName: type: string firstName: type: string middleName: type: string lastName: type: string generalSuffix: type: string maturitySuffix: type: string titleOfRespect: type: string empty: type: boolean phone: type: object properties: id: type: string format: uuid areaCode: type: string extension: type: string completeNumber: type: string type: type: string enum: - MOBILE - HOME - WORK subscriberNumber: type: string countryCode: type: string phoneValidity: type: object properties: validationType: type: string xml: name: type enum: - SMS - IVR - CALL - UNKNOWN validationStatus: type: string xml: name: status enum: - SUCCESS - FAILURE - SKIPPED - UNKNOWN validatedDate: type: string format: date-time xml: name: validatedOn validatedBy: type: string xml: name: phoneValidity namespace: com.walmart.services.common.model.address.validation xml: name: phone namespace: com.walmart.services.common.model.address description: List of pickup persons xml: name: pickupPerson shipNode: type: object properties: type: type: string description: Specifies the type of shipNode. Allowed values are SellerFulfilled, WFSFulfilled and 3PLFulfilled. name: type: string id: type: string description: Specifies the type of shipNode description: Information about the purchase order xml: name: order parameters: authorization: name: Authorization in: header description: Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. required: true schema: type: string example: Basic YzcyOTFjNmItNzI5MC00.... accessToken: name: WM_SEC.ACCESS_TOKEN in: header description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... channelType: name: WM_CONSUMER.CHANNEL.TYPE in: header description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding required: false schema: type: string correlationId: name: WM_QOS.CORRELATION_ID in: header 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 svcName: name: WM_SVC.NAME in: header description: Walmart Service Name required: true schema: type: string example: Walmart Service Name accept: name: Accept in: header description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json content-type: name: Content-Type in: header description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json tags: - name: Orders