openapi: 3.0.1 info: title: Walmart Fulfillment Management description: With Walmart Fulfillment Services, you can focus on sales while we expertly take care of fast shipping, seamless returns, and customer service. Simply send your inventory to Walmart fulfillment centers, where we will store your products securely and prepare them swiftly for shipping when an order is placed. servers: - url: https://marketplace.walmartapis.com description: Production URL - url: https://sandbox.walmartapis.com description: Sandbox URL security: - basicScheme: [] paths: "/v3/fulfillment/shipment-quantities": put: tags: - Fulfillment summary: Walmart Update Shipment Quantities description: "Seller can modify the shipment quantity before the Shipment arrives at the WFS FCs. Seller cannot modify the shipment quantity when Shipment Status = Receiving in Progress, Closed, and Cancelled. \n Seller will need to provide new quantities for each SKU to update. Seller will only be able to add up to 6 units per SKU but can reduce to 0 units to remove any SKU from a shipment. Seller cannot change all SKUs’ quantity to 0 – they must cancel the entire Inbound Order. " externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2885" operationId: updateShipmentQuantity parameters: - 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: Request fields content: application/json: schema: required: - inboundOrderId - shipmentId type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying inbound shipment orderItems: maxItems: 5000 minItems: 1 type: array description: update shipment qty line items xml: wrapped: true items: required: - sku - updatedShipmentQty type: object properties: sku: type: string description: Seller Item ID updatedShipmentQty: minimum: 0 type: integer description: updated quantity format: int32 description: update shipment qty line items example: inboundOrderId: '123543' shipmentId: '1234' orderItems: - sku: WILL-SL969 updatedShipmentQty: 11 required: true responses: '200': description: Successful Operation content: application/json: schema: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse example: status: OK "/v3/items/onhold/search": post: tags: - Fulfillment summary: Walmart Hazmat Items on Hold description: Use this API to see a list of items that are on hold for hazmat compliance review, including items with an In Review, Action Needed, and Prohibited status. Also use this API to review your Action Needed error descriptions and understand how to correct them for further assessment. operationId: wercsFeedback parameters: - 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 - in: header name: Accept description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json requestBody: description: Request fields content: application/json: schema: type: object properties: query: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string | gtin | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits. | string enum: - sku - gtin value: type: string filters: type: array items: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | status | Item status | string enum: - status op: type: string enum: - equals values: type: array items: type: string enum: - PROHIBITED - IN_REVIEW - ACTION_NEEDED sort: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | createdAt | when the item is last submitted/updated by Seller | string | updatedAt | when the item is last updated by Seller/Walmart | string | enum: - createdAt - updatedAt order: type: string enum: - ASC - DESC example: query: field: gtin value: '06154035330299' filters: - field: status op: equals values: - PROHIBITED - IN_REVIEW - ACTION_NEEDED sort: field: updatedAt order: DESC required: true responses: '200': description: Successful Operation content: application/json: schema: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse example: status: OK header: {} payload: nextCursor: "?limit=1&offset=1" totalItems: 207 actionNeeded: 4 inReview: 203 prohibited: 0 items: - gtin: '00051494401255' productName: INNATE Response Formulas, Men Over 40 One Daily Iron Free, Multivitamin, Vegetarian, Non-GMO, 60 tablets (60 Servings category: Medicine & Supplements subCategory: medicine_and_supplements status: ACTION_NEEDED sku: SD-IR-40125 createdAt: 1611140177328 updatedAt: 1629992924901 primaryImage: http://images.salsify.com/image/upload/s--7e1VLU2_--/otf4q0dplsg9yjzkxkfe.jpg errors: - code: ERR_EXT_DATA_4001029 field: batteryTechnologyType description: This item may contain a lithium or lead acid battery that requires additional compliance information, please check the 'Battery Type' field. severity: ERROR category: REQUEST "/v3/fulfillment/shipment-tracking": post: tags: - Fulfillment summary: Walmart Update Shipment Tracking description: "The purpose of this service is to capture tracking information from sellers.\nFor small parcel shipments, sellers must provide the tracking info including carrier name and tracking numbers. WFS will use the data to capture updated expected delivery date to adjust the fulfillment inbound capacity to avoid any receiving delays. \nSeller will also be able to view the updated expected delivery date through the Seller Center UI or calling the Get Inbound Shipment Items API." externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2934" operationId: updateShipmentTrackingDetails parameters: - 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: Request fields content: application/json: schema: required: - carrierName - shipmentId type: object properties: shipmentId: type: string carrierName: type: string trackingInfo: maxItems: 100 minItems: 1 type: array xml: wrapped: true items: type: string example: shipmentId: '12345' carrierName: UPS trackingInfo: - '123' - 456-1 - 789-2 required: true responses: '200': description: Successful Operation content: application/json: schema: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse example: status: OK "/v3/fulfillment/shipment-label": post: tags: - Fulfillment summary: Walmart Create Inbound Shipment Label description: "The purpose of this service is to generate WFS Receiving Labels in various formats for receiving purposes. Please note this is not a carrier label; these labels are required for the FC to identify the Inbound Order and Shipment ID they are receiving against.Receiving labels are customizable: \n1. 3 size and format options are available to choose from through the LabelSize and LabelFormat fields:\n\t - 4 in. x 6 in. (PDF).\n\t - 4 in. x 3 1/3 in. (PDF).\n\t - 4 in. x 6 in. (ZPL).\n2. Provide the type of the label (box or pallet) in the LoadType field and the number of the labels needed in the Count field.\n3. Print the WFS receiving label.\n4. Affix the WFS receiving labels to the boxes/ pallets.\n\nIf none of the above optional inputs are provided, a blank 4 in. x 6 in. PDF format label will be generated. Sellers must work with the warehouse/supplier to provide the required details before sending any Shipments to WFS FCs:\n1. Print the WFS receiving label.\n2. Fill out the FILL OUT section based on the seller’s packing situation. For example, if a seller plans to ship 3 boxes to the WFS fulfillment center, print out 3 labels and fill out BOX 1 of 3, 2 of 3, and 3 of 3 in the FILL OUT section.\n3. Circle one shipment type in the CIRCLE ONE section. For example, if there are different SKUs in the box, circle MIXED SKUS in the CIRCLE ONE section.\n4. Affix the WFS receiving labels to the boxes/ pallets.\n" operationId: createInboundShipmentLabelV2 parameters: - 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: Request fields content: application/json: schema: required: - shipmentId type: object properties: shipmentId: type: string labelSize: type: string labelFormat: type: string loadTypes: type: array xml: wrapped: true items: type: object properties: count: type: integer format: int32 loadType: type: string required: true responses: '200': description: Successful Operation content: application/pdf: schema: type: string "/v3/fulfillment/orders-fulfillments": post: tags: - Fulfillment summary: Walmart Create Customer Order description: The API is used to create customer fulfilment orders by the seller for Walmart Multichannel Solutions flow. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#10520" operationId: createFulfillment parameters: - 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: Request fields content: application/json: schema: required: - header - payload type: object properties: header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: required: - customer - orderChannelId - orderItems - orderPlacedTime - sellerOrderId type: object properties: orderChannelId: type: string description: Unique ID identifying channels from where the orders have been generated. This ID is generated by Walmart at the time of on-boarding onto multichannel program and this cannot be a random number sellerOrderId: maxLength: 18 minLength: 0 pattern: "^[A-Za-z0-9\\s]+$" type: string description: 'Unique ID identifying customer order request. Only alphanumeric values are accepted. Preferred to attach seller short name as prefix. For example: ''seller001''' orderPlacedTime: type: string description: 'Order placed time at respective channels. Format: ''2022-03-25T21:58:30.143Z''' format: date-time needsConfirmation: type: boolean description: 'Flag to identify if confirmation is needed. Currently supported: ''false''' partialFulfillments: type: boolean description: 'Flag to identify if partial fulfilment is allowed. Currently supported: ''false''' customer: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details description: Customer details orderItems: type: array description: Order items details items: required: - chargeDetails - itemDetail - qty - sellerLineId - shippingTo type: object properties: fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type: ''DELIVERY''' sellerLineId: maxLength: 6 minLength: 1 type: string description: Unique Id for each line item, preferred sequence 1,2,3... itemDetail: required: - sku type: object properties: sku: maxLength: 50 minLength: 1 type: string description: The identifier of the item in seller system (vendor sku) description: maxLength: 256 minLength: 1 type: string description: Description of the item description: Details of an item qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 4 minLength: 1 type: string description: 'Sales unit measure. Currently supported type : ''EACH''' measurementValue: minimum: 1 exclusiveMinimum: false type: number description: Requested Quantity Information of an item description: Item quantity details shippingMethod: type: string description: 'Shipping method of an order. Currently supported type: ''EXPEDITED'', ''STANDARD''' enum: - EXPEDITED - STANDARD - RUSH shippingTo: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details address: required: - city - country - line1 - state - zip type: object properties: line1: maxLength: 120 minLength: 1 type: string description: First line of the address line2: maxLength: 120 minLength: 1 type: string description: Second line of the address city: maxLength: 32 minLength: 1 type: string description: City where the address is located in state: maxLength: 2 minLength: 1 type: string description: 'State (two letter) code where the address is located in, for example: ''MI''' country: maxLength: 3 minLength: 1 type: string description: 'Country code where the address is located in, for example: ''USA''' zip: maxLength: 5 minLength: 1 type: string description: 'ZIP or postal code where the address is located in, for example: ''48083''' addressType: type: string description: 'The address type. Currently supported: ''RESIDENTIAL''' description: Customer address details description: Shipping address details chargeDetails: type: array description: Item charge details xml: wrapped: true items: required: - chargeCategory - chargeName - chargePerUnit type: object properties: chargeCategory: type: string description: 'Charge category, for example: ''PRODUCT''' chargeName: type: string description: 'Name of the charge, for example: ''Sale Price''' chargePerUnit: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details taxDetails: type: object properties: taxPerLine: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details description: Tax details description: Item charge details description: Order items details description: request payload example: header: headerAttributes: buId: '0' martId: '202' payload: orderChannelId: Enter the orderChannelId sellerOrderId: Enter a unique orderId orderPlacedTime: 'Enter order placed time, format : 2022-03-25T21:58:30.143Z' needsConfirmation: false partialFulfillments: false customer: contact: name: firstName: Enter Customer firstName lastName: Enter Customer lastName phone: Enter Customer phone number email: Enter Customer email orderItems: - sellerLineId: 1, increment for the next line fulfillmentType: DELIVERY shippingMethod: EXPEDITED itemDetail: sku: Enter sku of the item description: Enter item description qty: unitOfMeasure: EACH measurementValue: 2 shippingTo: contact: name: firstName: 'Enter delivery info : firstName' lastName: 'Enter delivery info : lastName' phone: 'Enter delivery info : phone number' address: line1: Enter delivery address line1 line2: Enter delivery address line2 city: Enter delivery city state: Enter delivery state country: USA zip: Enter delivery zip code addressType: RESIDENTIAL chargeDetails: - chargeCategory: PRODUCT chargeName: Sale Price chargePerUnit: currencyAmount: 0 currencyUnit: USD taxDetails: taxPerLine: currencyAmount: 0 currencyUnit: USD required: true responses: '200': description: Successful Request Creation content: application/json: schema: type: object properties: status: type: string description: status header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: type: object properties: requestId: type: string description: Unique ID identifying each request description: response payload example: status: ACCEPTED header: headerAttributes: buId: '0' martId: '202' payload: requestId: 594ef12e-0d0f-402d-aab9-3f7ca06b0ed8 "/v3/fulfillment/orders-fulfillments/fetchOrderPromiseOptions": post: tags: - Fulfillment summary: Walmart Fetch Delivery Promise Details description: This request provides fulfillment and delivery promise information for all valid item/offer to seller. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#12154" operationId: promiseFulfillments parameters: - 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: Request fields content: application/json: schema: required: - header type: object properties: header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: required: - destinations - offerSelections type: object properties: destinations: type: array description: Customer order destination details. xml: wrapped: true items: required: - address - fulfillmentType type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. offerSelections: type: array description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. xml: wrapped: true items: required: - offers type: object properties: offers: type: array description: Offer details. List of an items/vendor sku. xml: wrapped: true items: required: - lineId - requestedQuantity - salesUnit - sku type: object properties: sku: type: string description: The identifier of the item in seller system (vendor sku). lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. description: Offer details. List of an items/vendor sku. description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. description: Request payload. example: header: headerAttributes: martId: '202' buId: '0' payload: destinations: - address: city: Milpitas addressType: RESIDENTIAL postalCode: '95035' addressLineOne: 261 Odyssey Ln addressLineTwo: '222' isPOBox: false countryCode: US stateCode: CA fulfillmentType: DELIVERY offerSelections: - offers: - sku: OMP-B01-L lineId: 249ac8e1-e6c2-4806-81a5-54215eb16b00 salesUnit: Each requestedQuantity: measurementValue: 1 unitOfMeasure: EA required: true responses: '200': description: Successful operation. content: application/json: schema: type: object properties: status: type: string description: Response status. header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: type: object properties: offers: type: array description: Offer details indicating available quantity vs required quantify for offer items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Available Quantity Information of an item. requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' sku: type: string description: The identifier of the item in seller system (vendor sku). description: Offer details indicating available quantity vs required quantify for offer destinations: type: array description: Customer order destination details. items: type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. fulfillmentPlans: type: array description: Fulfillment plans details. items: type: object properties: fulfillmentModules: type: array description: Fulfillment module details. items: type: object properties: name: type: string description: 'Fulfillment module name. For example : ''UNSCHEDULED_DELIVERY and ERROR''' fulfillmentGroups: type: array description: Fulfillment Group details. items: type: object properties: fulfillmentOptions: type: array description: Fulfillment options details. items: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. description: Fulfillment Group details. description: Fulfillment module details. description: Fulfillment plans details. description: Response payload. example: status: ACCEPTED header: headerAttributes: buId: '0' martId: '202' payload: offers: - availableQuantity: measurementValue: 52 unitOfMeasure: EA requestedQuantity: measurementValue: 1 unitOfMeasure: EA lineId: 249ac8e1-e6c2-4806-81a5-54215eb16b00 salesUnit: Each sku: OMP-B01-L destinations: - address: city: Milpitas addressType: RESIDENTIAL postalCode: '95035' addressLineOne: 261 Odyssey Ln addressLineTwo: '222' isPOBox: false countryCode: US stateCode: CA fulfillmentType: DELIVERY fulfillmentPlans: - fulfillmentModules: - fulfillmentGroups: - fulfillmentOptions: - fulfillments: - lineItemAttributesList: - availableQuantity: measurementValue: 52 unitOfMeasure: EA fulfillmentChannel: - WFS_FULFILLED lineId: 249ac8e1-e6c2-4806-81a5-54215eb16b00 sla: tier: TWO_DAY speed: EXPEDITED accessMode: mode: NATIONAL_CARRIER fulfillmentTime: date: minPromiseDate: '2023-02-27' maxPromiseDate: '2023-02-27' fulfillmentId: a269374b-0c07-4008-8b5c-6831cbb2c112 nodeType: FC fulfillmentMode: UNSCHEDULED accessType: DELIVERY_ADDRESS fulfillmentType: DELIVERY name: UNSCHEDULED_DELIVERY "/v3/fulfillment/orders-fulfillments/cancel": post: tags: - Fulfillment summary: Walmart Cancel Customer Order description: The API is used to cancel the customer fulfilment orders created in the previous flow. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#10523" operationId: cancelFulfillment parameters: - 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: Request fields content: application/json: schema: required: - header type: object properties: header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: required: - orderItems - sellerOrderId type: object properties: sellerOrderId: type: string orderItems: type: array xml: wrapped: true items: required: - qty - sellerLineId type: object properties: sellerLineId: maxLength: 32 minLength: 1 type: string qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 32 minLength: 1 type: string measurementValue: minimum: 1 exclusiveMinimum: false type: number description: request payload example: header: headerAttributes: buId: '0' martId: '202' payload: sellerOrderId: '301878911210253' orderItems: - sellerLineId: '1232456' qty: unitOfMeasure: EACH measurementValue: 2 required: true responses: '200': description: Successful Request Creation content: application/json: schema: type: object properties: status: type: string description: status header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: type: object properties: requestId: type: string description: Unique ID identifying each request description: response payload example: status: ACCEPTED header: headerAttributes: buId: '0' martId: '202' payload: requestId: 594ef12e-0d0f-402d-aab9-3f7ca06b0ed7 "/v3/fulfillment/inbound-shipments": get: tags: - Fulfillment summary: Walmart Get Shipments description: After Sellers create an Inbound Order successfully, the response from Create Inbound Shipments API will tell whether the order can be sent in a single shipment to one WFS fulfillment center or needs to be split into multiple shipments to different fulfillment centers. To retrieve the Shipment level info, please call the Get Inbound Shipments API externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2855" operationId: getInboundShipments parameters: - name: offset in: query description: offset is the number of records you wish to skip before selecting records. required: false schema: type: string default: '0' - name: limit in: query description: The number of Purchase Orders to be returned. required: false schema: type: string default: '10' - name: inboundOrderId in: query description: Unique ID identifying inbound shipment request. required: false schema: type: string - name: shipmentId in: query description: Unique ID identifying each shipment. required: false schema: type: string - name: status in: query description: Current shipment status required: false schema: type: string - name: fromCreateDate in: query description: Shipment create date starting range required: false schema: type: string - name: toCreateDate in: query description: Shipment create date starting end range 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: headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 payload: type: array description: response payload items: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying inbound shipment shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller status: type: string description: Current status of the shipment createdDate: type: string description: creation date for shipment format: date-time shipmentUnits: type: integer description: Total number of units in the shipment format: int32 receivedUnits: type: integer description: Total number of units recived in FC for the shipment format: int32 expectedDeliveryDate: type: string description: expected delivery date provided by seller format: date-time updatedExpectedDeliveryDate: type: string description: update expected delivery date based on network capacity format: date-time actualDeliveryDate: type: string description: Actual delivery date of the shipment at FC format: date-time trackingNo: type: array description: Tracking info for the shipment items: type: string description: Tracking info for the shipment carrierName: type: string description: Carrier of the shipment description: response payload example: headers: limit: 10 offset: 0 totalCount: 177 payload: - inboundOrderId: may-5-test-2 shipmentId: '0066618GDM' shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: AWAITING_DELIVERY createdDate: '2021-05-17T19:02:30.467Z' shipmentUnits: 1 receivedUnits: 0 expectedDeliveryDate: '2021-05-22T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-06-01T23:59:00.000Z' trackingNo: - '787439195645' - '787439195174' carrierName: WFS-FEDEX - inboundOrderId: may-21-test9 shipmentId: '0061782GDM' shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: CANCELLED createdDate: '2021-05-06T17:49:54.743Z' shipmentUnits: 0 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-20T00:00:00.000Z' - inboundOrderId: may-21-test8 shipmentId: '0061779GDM' shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: CANCELLED createdDate: '2021-05-06T17:42:42.577Z' shipmentUnits: 0 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-06-01T23:59:00.000Z' trackingNo: - '787450289224' carrierName: WFS-FEDEX - inboundOrderId: may-21-test7 shipmentId: 0061763GDM shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: CANCELLED createdDate: '2021-05-06T16:54:47.310Z' shipmentUnits: 0 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-20T00:00:00.000Z' - inboundOrderId: may-21-test6 shipmentId: 0061752GDM shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: CANCELLED createdDate: '2021-05-06T16:31:22.383Z' shipmentUnits: 0 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-20T00:00:00.000Z' - inboundOrderId: may-21-test-3 shipmentId: 0061726GDM shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: PENDING_SHIPMENT_DETAILS createdDate: '2021-05-06T15:09:35.797Z' shipmentUnits: 1 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-20T00:00:00.000Z' - inboundOrderId: may-21-test-2 shipmentId: 0061712GDM shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: PENDING_SHIPMENT_DETAILS createdDate: '2021-05-06T14:31:32.280Z' shipmentUnits: 3 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-20T00:00:00.000Z' - inboundOrderId: may-21-test-1 shipmentId: 0061665GDM shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: PENDING_SHIPMENT_DETAILS createdDate: '2021-05-06T14:23:28.673Z' shipmentUnits: 1 receivedUnits: 0 expectedDeliveryDate: '2021-05-20T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-20T00:00:00.000Z' - inboundOrderId: may-4-test-2 shipmentId: 0060645GDM shipToAddress: fcName: NJ3 addressLine1: 3 Sorbello Way city: Pedricktown stateCode: NJ countryCode: US postalCode: '08067' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: PENDING_SHIPMENT_DETAILS createdDate: '2021-05-05T01:24:25.840Z' shipmentUnits: 1 receivedUnits: 0 expectedDeliveryDate: '2021-05-22T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-22T00:00:00.000Z' - inboundOrderId: may-4-test-1 shipmentId: 0060635GDM movedShipmentId: 0060634GDM shipToAddress: fcName: KY1 addressLine1: 120 Velocity Way. city: Shepherdsville stateCode: KY countryCode: US postalCode: '40165' returnAddress: addressLine1: 860 W California Ave city: Sunnyvale stateCode: '94086' countryCode: CA postalCode: US status: AWAITING_DELIVERY createdDate: '2021-05-04T23:46:18.530Z' shipmentUnits: 1 receivedUnits: 0 expectedDeliveryDate: '2021-05-23T00:00:00.000Z' updatedExpectedDeliveryDate: '2021-05-19T23:59:00.000Z' trackingNo: - '787095506139' carrierName: WFS-FEDEX post: tags: - Fulfillment summary: Walmart Create Inbound Shipment description: |- Once you’ve converted items to WFS, you are ready to start shipping items inbound to Walmart. To do this, you will submit an Inbound shipment request. The Inbound shipment details when you expect to ship product, as well as the items and quantities which will be shipped. Each shipment you send in to WFS should have a corresponding Inbound shipment . In this case, a shipment would be considered a direct truckload, LTL shipment, or set of items shipped via parcel on a given day. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2901" operationId: createShipment parameters: - 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: Request fields content: application/json: schema: required: - inboundOrderId - returnAddress type: object properties: inboundOrderId: maxLength: 100 minLength: 0 type: string description: Unique ID identifying inbound shipment request inboundServices: type: object properties: inventoryTransferService: type: string description: ITS Flag description: Requested inbound services such as ITS returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: maxItems: 5000 minItems: 1 type: array description: inbound shipment request line items xml: wrapped: true items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items example: inboundOrderId: '8778881015027' inboundServices: inventoryTransferService: Y returnAddress: addressLine1: 860 W California Ave addressLine2: '' city: Sunnyvale stateCode: CA countryCode: USA postalCode: '94086' orderItems: - productId: '00894147009695' productType: GTIN sku: WILL-SL969 itemDesc: Blue jeans itemQty: 10 vendorPackQty: 10 innerPackQty: 1 expectedDeliveryDate: '2020-11-21T00:00:00.000Z' required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: status: type: string payload: type: array description: response payload items: type: object properties: shipmentId: type: string description: Unique ID identifying each shipment shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items shipmentItems: type: array description: The items which needs to be send in the shipment items: type: object properties: vendorSku: type: string description: Seller Item ID itemQty: type: integer description: Total number of sellable units format: int32 description: The items which needs to be send in the shipment expectedDeliveryDate: type: string description: expected delivery date for inbounding shipment. Can be different from provided in the rquest based on network capacity format: date-time description: response payload example: status: OK payload: - shipmentId: '0000966GDM' shipToAddress: addressLine1: 120 Velocity Way. city: Shepherdsville stateCode: KY countryCode: US postalCode: '40165' shipmentItems: - vendorSku: WILL-SL969 itemQty: 10 expectedDeliveryDate: '2020-11-21T00:00:00.000Z' "/v3/fulfillment/inbound-preview": post: tags: - Fulfillment summary: Walmart Fetch Inbound Preview description: "The purpose of this service is to give a preview of the estimated Inventory Transfer Service cost and shipment destinations between ITS and self-distribution. \nNote: This API is only available to sellers eligible for the Inventory Transfer Service." externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#12930" operationId: inboundPreview parameters: - 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: Request fields content: application/json: schema: required: - header - payload type: object properties: header: required: - headerAttributes type: object properties: headerAttributes: required: - buId - martId type: object properties: buId: type: string description: Business unit identifier and must be 0 for US market. xml: wrapped: true martId: type: string description: Market identifier and must be 0 for US market. xml: wrapped: true description: Multi Tenant header attributes description: Request Multi Tenant Header Wrapper payload: required: - inboundOrderId - orderItems - returnAddress type: object properties: inboundOrderId: maxLength: 50 minLength: 0 type: string description: Unique identifier used for shipments returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: maxItems: 5000 minItems: 1 type: array description: List of Order Items xml: wrapped: true items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items description: Request Payload example: header: headerAttributes: buId: '0' martId: '0' payload: inboundOrderId: WFS_P132398111-ITS1011 returnAddress: addressLine1: 860 W California Ave addressLine2: '' city: Sunnyvale stateCode: CA countryCode: US postalCode: '94086' orderItems: - productId: '06484856148873' productType: GTIN sku: SKU-06476211912694 itemDesc: tennis ball itemQty: 5 vendorPackQty: 5 innerPackQty: 1 expectedDeliveryDate: '2023-05-25T15:33:33-07:00' addOnServices: - serviceType: LABEL required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: status: type: string description: Response status. payload: type: array description: Response payload. items: type: object properties: inboundOrderId: type: string description: Unique shipment identifier previews: type: array description: List of preview responses items: type: object properties: previewType: type: string description: Use "inbound" if you are using WFS Inventory Transfer Service (ITS). Use "selfMirroring" if you are not using ITS and shipping directly to Walmart fulfillment centers. preview: type: array description: Preview items: type: object properties: shipNode: type: string description: Ship Node isSortable: type: boolean description: Flag indicating if the dimensions of the item make it sortable isNonSortable: type: boolean description: Flag indicating if the dimensions of the item make it non-sortable nodeType: type: string description: 'Node Type: FC/ICC' shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items totalNetTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated shipmentItems: type: array description: Shipment items items: type: object properties: vendorSku: type: string description: Vendor SKU productType: type: string description: 'Product type: GTIN/UPC/EAN' productId: type: string description: Unique product identifier itemQty: type: integer description: Item quantity format: int32 netTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated description: Shipment items description: Preview description: List of preview responses description: Response payload. example: status: OK payload: - inboundOrderId: WFS_P132398111-ITS1011 previews: - previewType: inbound preview: - shipNode: '4093' isSortable: true isNonSortable: false nodeType: ICC shipToAddress: fcName: LAX2T addressLine1: 6720 Kimball Ave city: Chino stateCode: CA countryCode: US postalCode: '91708' totalNetTransferCharge: 1.25 currencyUnit: USD shipmentItems: - vendorSku: SKU-06476211912694 productType: GTIN productId: '06484856148873' itemQty: 5 netTransferCharge: 1.25 currencyUnit: USD - previewType: selfMirroring preview: - shipNode: '7441' isSortable: true isNonSortable: false nodeType: FC shipToAddress: fcName: ORD1s addressLine1: 3501 Brandon Road city: Joliet stateCode: IL countryCode: US postalCode: '60436' shipmentItems: - vendorSku: SKU-06476211912694 productType: GTIN productId: '06484856148873' itemQty: 4 - shipNode: '8103' isSortable: true isNonSortable: false nodeType: FC shipToAddress: fcName: LAX1 addressLine1: 6750 Kimball Avenue city: Chino stateCode: CA countryCode: US postalCode: '91708' shipmentItems: - vendorSku: SKU-06476211912694 productType: GTIN productId: '06484856148873' itemQty: 1 "/v3/fulfillment/carrier-rate-quotes": get: tags: - Fulfillment summary: Walmart Get Carrier Rate Quote description: The purpose of this service is to get the carrier rate quotes for WFS Preferred Carrier Program - FedEx parcel solution, when inbounding seller items from seller pickup point to Walmart fulfillment centers. operationId: getCarrierRateQuote parameters: - name: shipmentId in: path description: Unique ID identifying each shipment. required: true schema: type: string - name: mode in: path description: Shipment type. 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: shipmentId: type: string quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time quoteCreationDate: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string rateQuote: type: object properties: quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string currency: type: string discountCharge: type: number format: float netCharge: type: number format: float surchargeType: type: string surchargeValue: type: string totalBillingWeight: type: number format: float status: type: string transitDays: type: string effectiveDate: type: string format: date-time expiryDate: type: string format: date-time mode: type: string sellerFreightClassCode: type: string freightCharge: type: number format: float fuelCharge: type: number format: float totalWeight: type: number format: float totalVolume: type: number format: float equipmentTypeCode: type: string serviceCode: type: string numberOfPallets: type: integer format: int32 nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float minimumCharge: type: number format: float declaredValue: type: string mixedSKUs: type: integer format: int32 singleSKUs: type: integer format: int32 freightReadyDate: type: string format: date-time shipmentPackages: type: array items: required: - height - length - lengthUOM - packageSequenceNumber - weight - weightUOM - width type: object properties: packageSequenceNumber: type: integer format: int32 weight: minimum: -1 type: number format: float weightUOM: type: string length: minimum: -1 type: number format: float height: minimum: -1 type: number format: float width: minimum: -1 type: number format: float lengthUOM: type: string labelInformation: type: object properties: labelData: type: string labelFormat: type: string trackingCode: type: string referenceTrackingCode: type: string epTrackerId: type: string shipmentId: type: string packageAsn: type: string masterTrackingCode: type: string master: type: boolean billingWeight: type: number format: float netCharge: type: number format: float nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float packageType: type: string noOfPackages: type: integer format: int32 stackable: type: boolean originLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string destinationLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string returnLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string post: tags: - Fulfillment summary: Walmart Create Carrier Rate Quote description: |- The purpose of this service is to get the carrier rate quotes for WFS Preferred Carrier Program - FedEx parcel solution, when inbounding seller items from seller pickup point to Walmart fulfillment centers. For the shipments sent by FedEx small parcel, you can ship packages up to 150 lb, up to 108" in length, and 165" in length plus girth. (Girth is 2x width + 2x height.). You can ship up to 200 packages per shipment. operationId: createCarrierRateQuotes parameters: - 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: Request fields content: application/json: schema: required: - customer - destinationLocation - mode - originLocation - returnLocation - shipmentId - shipmentPackages - shipmentSource type: object properties: shipmentId: type: string shipmentSource: type: string pickupFromDateTime: type: string format: date-time pickupToDateTime: type: string format: date-time deliveryFromDateTime: type: string format: date-time deliveryToDateTime: type: string format: date-time customer: required: - customerId - customerName type: object properties: customerId: type: string customerName: type: string originLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string destinationLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string returnLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string shipmentPackages: maxItems: 5000 minItems: 1 type: array items: required: - height - length - lengthUOM - packageSequenceNumber - weight - weightUOM - width type: object properties: packageSequenceNumber: type: integer format: int32 weight: minimum: -1 type: number format: float weightUOM: type: string length: minimum: -1 type: number format: float height: minimum: -1 type: number format: float width: minimum: -1 type: number format: float lengthUOM: type: string labelInformation: type: object properties: labelData: type: string labelFormat: type: string trackingCode: type: string referenceTrackingCode: type: string epTrackerId: type: string shipmentId: type: string packageAsn: type: string masterTrackingCode: type: string master: type: boolean billingWeight: type: number format: float netCharge: type: number format: float nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float packageType: type: string noOfPackages: type: integer format: int32 stackable: type: boolean mode: type: string default: PARCEL freightClass: type: string declaredValue: type: integer format: int32 loadTypes: type: array items: required: - count - loadType type: object properties: count: type: string loadType: type: string required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: shipmentId: type: string shipmentNumber: type: string rateQuotes: type: array items: type: object properties: quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string currency: type: string discountCharge: type: number format: float netCharge: type: number format: float surchargeType: type: string surchargeValue: type: string totalBillingWeight: type: number format: float status: type: string transitDays: type: string effectiveDate: type: string format: date-time expiryDate: type: string format: date-time mode: type: string sellerFreightClassCode: type: string freightCharge: type: number format: float fuelCharge: type: number format: float totalWeight: type: number format: float totalVolume: type: number format: float equipmentTypeCode: type: string serviceCode: type: string numberOfPallets: type: integer format: int32 nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float minimumCharge: type: number format: float declaredValue: type: string mixedSKUs: type: integer format: int32 singleSKUs: type: integer format: int32 freightReadyDate: type: string format: date-time "/v3/fulfillment/carrier-rate-quote/confirm": post: tags: - Fulfillment summary: Walmart Confirm Carrier Rate Quote description: The purpose of this service is for seller to confirm and accept the estimated carrier shipping charges, when choosing to use WFS Preferred Carrier Program - FedEx parcel to inbound inventory to Walmart fulfillment centers. operationId: confirmCarrierRateQuote parameters: - 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: Request fields content: application/json: schema: required: - shipmentId type: object properties: shipmentId: type: string required: true responses: '200': description: Successful Operation content: application/json: schema: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse "/v3/fulfillment/carrier-label/{shipmentId}": post: tags: - Fulfillment summary: Walmart Print Carrier Label description: "The purpose of this service is for sellers to print carrier shipping label. \n\nTo print carrier shipping label, please first specify a Ship Date. Note, carrier allows to select a ship date 10 days in advance." operationId: printCarrierLabel parameters: - name: shipmentId in: path description: Unique ID identifying each shipment. 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: content: application/json: schema: required: - shipDate type: object properties: shipDate: type: string format: date-time required: true responses: '200': description: Successful Operation content: application/pdf: schema: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse "/v3/feeds": post: tags: - Fulfillment summary: Walmart Convert Items for Wfs description: |- This API is used for converting existing Marketplace items to be WFS eligible. Once you’ve created a Marketplace item, each item must be converted to WFS by providing additional details that are not required during the item setup process. This item conversion process can be completed by uploading the Convert Spec excel file via Seller Center, or can be completed using the API documented here. Directions on how to convert your item to be eligible for Walmart Fulfillment Services can be found here: https://sellerhelp.walmart.com/s/guide?article=000009206 Additional details on hazmat item compliance requirements can be found here: https://sellerhelp.walmart.com/seller/s/guide?article=000009156 To download the schema, please refer to the Overview section externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2391" operationId: convertItemForWfs parameters: - name: feedType in: query description: Includes details of each entity in the feed. Do not set this parameter to true. required: true schema: type: string default: OMNI_WFS - 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: content: application/json: schema: required: - file type: object properties: file: type: string description: Feed file to upload format: binary examples: json1: value: SupplierItemFeedHeader: subCategory: baby_clothing sellingChannel: fbw processMode: REPLACE locale: en version: '1.4' subset: EXTERNAL SupplierItem: - Visible: Baby Clothing: clothingSize: S color: - Pink countryOfOriginTextiles: USA smallPartsWarnings: - 0 - No warning applicable mainImageUrl: https://i5-qa.walmartimages.com/asr/549ecbe9-c874-475b-87d8-5e4cb19934ec.8f5d70e62bd0bb8abc6772c9ef1694e0.jpeg prop65WarningText: Warning seasonYear: 2020 manufacturer: Generic Orderable: productIdentifiers: productId: '05923239836453' productIdType: GTIN batteryTechnologyType: Does Not Contain a Battery electronicsIndicator: 'No' endDate: '2040-01-01T00:00:00.000Z' price: 10 chemicalAerosolPesticide: 'No' sku: '05923239836453' stateRestrictions: - stateRestrictionsText: None brand: Goodlife productName: Goodlife Corona_merge_split_19 startDate: '2020-06-15T00:00:00.000Z' TradeItem: countryOfOriginAssembly: - US - United States innerPack: innerPackWidth: 2 innerPackHeight: 3 qtySellableItemsInnerPack: 1 innerPackGTIN: '05923239836453' innerPackWeight: 2 innerPackDepth: 1 sku: '05923239836453' orderableGTIN: '05923239836453' multipart/form-data: schema: required: - file type: object properties: file: type: string description: Feed file to upload format: binary examples: json1: value: SupplierItemFeedHeader: subCategory: baby_clothing sellingChannel: fbw processMode: REPLACE locale: en version: '1.4' subset: EXTERNAL SupplierItem: - Visible: Baby Clothing: clothingSize: S color: - Pink countryOfOriginTextiles: USA smallPartsWarnings: - 0 - No warning applicable mainImageUrl: https://i5-qa.walmartimages.com/asr/549ecbe9-c874-475b-87d8-5e4cb19934ec.8f5d70e62bd0bb8abc6772c9ef1694e0.jpeg prop65WarningText: Warning seasonYear: 2020 manufacturer: Generic Orderable: productIdentifiers: productId: '05923239836453' productIdType: GTIN batteryTechnologyType: Does Not Contain a Battery electronicsIndicator: 'No' endDate: '2040-01-01T00:00:00.000Z' price: 10 chemicalAerosolPesticide: 'No' sku: '05923239836453' stateRestrictions: - stateRestrictionsText: None brand: Goodlife productName: Goodlife Corona_merge_split_19 startDate: '2020-06-15T00:00:00.000Z' TradeItem: countryOfOriginAssembly: - US - United States innerPack: innerPackWidth: 2 innerPackHeight: 3 qtySellableItemsInnerPack: 1 innerPackGTIN: '05923239836453' innerPackWeight: 2 innerPackDepth: 1 sku: '05923239836453' orderableGTIN: '05923239836453' responses: '200': description: Successful Operation content: application/json: schema: type: object properties: feedId: type: string description: A unique ID, returned from the Bulk Upload API, used for tracking the feed file additionalAttributes: type: object nullable: true errors: type: object nullable: true example: feedId: FFE538D9B25A4000AD2A067ACEDCF4C4@AUoBAQA "/v3/report/wfs/getInventoryHealthReport": get: tags: - Fulfillment summary: Walmart Get Wfs Inventory Health Report description: Returns all the information associated with Seller's items that are set up on Walmart Fulfillment Services (WFS) platform. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2935" operationId: getInventoryHealthReport parameters: - 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/octet-stream: schema: type: string description: |- The data will be returned in a .csv file in your folder. The response to a successful call includes a header as an attachment called Content-Disposition. The Content-Disposition header contains the name of the report. As an example, attachment: filename=WFSInventoryHealthReport_2021-07-15T06_42_13.766Z.csv. The title includes the timestamp when the file was generated. The attachment contains the report in a csv format. The java code example demonstrates the use of the header and the body when processing the response The report is regenerated periodically. We recommend that you not retrieve the report more frequently than once every one hour. "/v3/fulfillment/orders-fulfillments/status": get: tags: - Fulfillment summary: Walmart Get Fulfillment Orders Status description: The API provides the list of customer fulfillment orders with corresponding details. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#10819" operationId: getFulfillmentOrdersStatus parameters: - name: limit in: query description: Limiting the number of records fetched. Valid range is from 1 to 50 inclusive. required: false schema: type: string - name: offset in: query description: Setting an offset to skip records. Valid range is from 0 to 50000 inclusive. required: false schema: type: string - name: orderNumber in: query description: Search the order based on an order number. required: false schema: type: string - name: trackingNumber in: query description: Search the order based on a tracking number. required: false schema: type: string - name: shipmentNumber in: query description: Search the order based on a shipment number. required: false schema: type: string - name: fromOrderDate in: query description: Search the order based on a start date (Date in YYYY-MM-DD format). required: false schema: type: string - name: toOrderDate in: query description: Search the order based on an endDate date (Date in YYYY-MM-DD format). required: false schema: type: string - name: sortOrder in: query description: Order of sorting (asc/desc). required: false schema: type: string default: desc - name: sortBy in: query description: 'Key on which sorting is done (Supported Attributes: orderDate).' 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: status: type: string description: status header: type: object properties: headerAttributes: type: object properties: martId: type: string description: martId passed in header buId: type: string description: buId passed in header pageCount: type: integer description: page count of the orders available with given filters format: int32 totalCount: type: integer description: total count of orders available with given filters format: int32 description: Header attributes description: Meta data of the response payload: type: array description: Order details items: type: object properties: orderChannelId: type: string description: orderChannelId of the order sellerOrderId: type: string description: sellerOrderId of the order orderType: type: string description: order type of the order status: type: string description: status of the order orderDate: type: string description: createDate of the order format: date-time buyerInfo: type: object properties: primaryContact: type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer description: Primary contact of the order description: buyerInfo of the order shipments: type: array description: createDate of the order items: type: object properties: status: type: string description: Shipment status statusDescription: type: string description: Shipment status description purchaseOrderId: type: string description: Shipment purchase Order Id scac: type: string description: Shipment scac trackingNo: type: string description: Shipment tracking number externalTrackingURL: type: string description: Shipment tracking URL shipmentNo: type: string description: Shipment number actualShipmentDate: type: string description: Actual shipment date packageASN: type: string description: Shipment packageASN number carrierDescription: type: string description: Shipment carrier description carrierServiceCode: type: string description: Shipment carrier service code packageId: type: string description: Shipment package Id lastModified: type: string description: Shipment lastModified date shipmentLines: type: array description: Shipment line details items: type: object properties: shipmentLineNo: type: string description: Shipment line number fulfillerLineId: type: string description: Shipment fulfiller LineId quantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Shipment line details shipmentDates: type: array description: Shipment dates items: type: object properties: actualDate: type: string description: Actual delivery date of the order format: date-time dateTypeId: type: string description: Order dateTypeId expectedDate: type: string description: Expected delivery date of the order format: date-time description: Shipment dates description: createDate of the order orderLines: type: array description: order lines details items: type: object properties: fulfillmentType: type: string description: fulfillmentType of the order lastModified: type: string description: Last modified date of the order lines format: date-time shippingMethod: type: string description: Shipping method of the order lines shippingTier: type: string description: Shipping tier of the order lines orderLineQuantityInfo: type: array description: Order line quantity information items: type: object properties: status: type: string description: status of the order line quantity statusDescription: type: string description: status description of the order line quantity statusQuantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Order line quantity information orderProduct: type: object properties: productName: type: string description: Product name of the order description: Product details within order orderedQty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order customerShipToAddress: type: object properties: address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string name: type: object properties: completeName: type: string firstName: type: string lastName: type: string description: Customer name details description: Customer shipping address description: order lines details description: Order details example: status: OK header: headerAttributes: buId: '0' martId: '202' pageCount: 1 totalCount: 1 payload: - sellerOrderId: ptrn20802 orderType: DOMESTIC status: DELIVERED orderDate: '2023-01-01T03:27:51.176Z' buyerInfo: primaryContact: name: firstName: Sonja lastName: Richard Babineaux shipments: - status: DELIVERED statusDescription: Shipment Delivered purchaseOrderId: '2873667778063' scac: Fedex trackingNo: '626969279882' externalTrackingURL: https://www.walmart.com/orders/ptrn20802/track/626969279882 shipmentNo: db1e8da5-fa38-4074-a4d4-9f5da430d4dd actualShipmentDate: '2023-01-02T21:21:22.000Z' packageASN: '55558952333141953386' carrierDescription: Fedex carrierServiceCode: '7610' packageId: '55558952333141953386' lastModified: '2023-01-06T01:08:27.950Z' shipmentLines: - shipmentLineNo: '7101212' fulfillerLineId: '1' quantity: unitOfMeasure: EA measurementValue: 1 shipmentDates: - actualDate: '2023-01-02T21:21:22.000Z' dateTypeId: SHIPMENT expectedDate: '2023-01-03T00:15:00.000Z' - dateTypeId: OPD expectedDate: '2023-01-03T10:27:00.000Z' - actualDate: '2023-01-06T00:59:00.000Z' dateTypeId: DELIVERY expectedDate: '2023-01-06T01:30:00.000Z' orderLines: - fulfillmentType: DELIVERY lastModified: '2023-01-01T03:27:52.529Z' shippingMethod: STANDARD shippingTier: TWO_DAY orderLineQuantityInfo: - status: PROCESSING statusDescription: SUCCESSFULLY_SOURCED statusQuantity: unitOfMeasure: EA measurementValue: 1 orderProduct: productName: London Fog - Missy Sb Double Collar - Black - Large orderedQty: unitOfMeasure: EA measurementValue: 1 shipToAddress: address: addressLineOne: 3657 Country Oaks Loop Unit D addressLineTwo: D addressType: RESIDENTIAL city: Ontario countryCode: US postalCode: '91761' stateOrProvinceName: CA stateOrProvinceCode: CA name: completeName: Sonja Richard Babineaux firstName: Sonja lastName: Richard Babineaux "/v3/fulfillment/label/{shipmentId}": get: tags: - Fulfillment summary: Walmart Create Inbound Shipment Label (deprecated) description: "The purpose of this service is to generate WFS shipping labels in pdf format for receiving purpose. Please note this is not a carrier label; these labels are required for the FC to identify the Inbound Order and Shipment ID they are receiving against. After requesting the shipping label, sellers must work with warehouse/ supplier to follow these steps before sending any Shipments to WFS FCs: \n1. \tPrint the WFS shipping label.\n2. \tFill out the FILL OUT section based on seller’s packing situation. For example, if a seller plans to ship 3 boxes to the WFS fulfillment center, print out 3 labels and fill out BOX 1 of 3, 2 of 3, and 3 of 3 in the FILL OUT section.\n3. \tCircle one shipment type in the CIRCLE ONE section. For example, if there are different SKUs in the box, circle MIXED SKUS in the CIRCLE ONE section.\n4. \tAffix the WFS shipping labels to the boxes/ pallets.\n" operationId: createInboundShipmentLabel parameters: - name: shipmentId in: path description: Unique ID identifying inbound shipment 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/pdf: schema: type: string "/v3/fulfillment/inventory-log": get: tags: - Fulfillment summary: Walmart Get Inventory Log for a Wfs Item description: Returns activity log for any Seller's item that is stored in Walmart Fulfillment Centers (WFS) platform. externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#9927" operationId: getWFSInventoryLog parameters: - name: gtin in: query description: GTIN. required: true schema: type: string - name: shipmentId in: query description: Shipment Id. required: false schema: type: string - name: transactionType in: query description: Transaction Type. required: false schema: type: string - name: transactionLocation in: query description: Transaction Location. required: false schema: type: string - name: startDate in: query description: Inventory log transaction time starting range (Date in YYYY-MM-DD format). required: false schema: type: string - name: endDate in: query description: Inventory log transaction time ending range (Date in YYYY-MM-DD format). required: false schema: type: string - name: sort_by in: query description: 'Sort By Attribute (Supported Attributes: gtin, changedUnits, transactionReasonCode, transactionType, shipmentId).' required: false schema: type: string - name: sort_order in: query description: Sort Order (ASC or DESC). required: false schema: type: string - name: offset in: query description: Offset is the number of records you wish to skip before selecting records. required: false schema: type: string default: '0' - name: limit in: query description: limit is the number of records to be returned. required: false schema: type: string default: '50' - 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: headers: type: object properties: limit: type: integer description: Number of records to be returned format: int32 offset: type: integer description: Number of records you wish to skip before selecting records format: int32 totalCount: type: integer description: Total Count of records this request yields format: int32 description: Headers Section payload: type: object properties: gtin: type: string description: GTIN vendorSku: type: string description: Vendor SKU productName: type: string description: Product Name inventoryLog: type: array description: Inventory Log records items: type: object properties: id: type: string description: Unique Event Id fcName: type: string description: Fulfillment Center Short Name changedUnits: type: integer description: Number of inventory units changed +/- in FC as a result of this transaction format: int32 transactionTime: type: string description: Timestamp of transaction format: date-time transactionLocation: type: string description: Transaction Location transactionReasonCode: type: string description: Transaction Reason Code transactionReasonDesc: type: string description: Transaction Reason Description transactionType: type: string description: Transaction Type shipmentId: type: string description: Shipment Id description: Inventory Log records description: Payload Section "/v3/fulfillment/inbound-shipment-items": get: tags: - Fulfillment summary: Walmart Get Inbound Shipment Items description: "After Sellers create an Inbound Order successfully, the response from Create Inbound Shipments API will tell whether the order can be sent in a single shipment to one WFS fulfillment center or needs to be split into multiple shipments to different fulfillment centers. \nTo retrieve the Shipment level info, please call the Get Inbound Shipments API and to get what needs to be in a specific shipment and SKU level receipt situation, please call the Get Inbound Shipment Items API" externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2862" operationId: getInboundShipmentItems parameters: - name: offset in: query description: offset is the number of records you wish to skip before selecting records. required: false schema: type: string default: '0' - name: limit in: query description: The number of Purchase Orders to be returned. required: false schema: type: string default: '10' - name: shipmentId in: query description: Unique ID identifying each shipment. 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: headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 payload: type: array description: response payload items: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying each shipment gtin: type: string description: Item barcode sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: type: integer description: Total number of sellable units format: int32 vendorPackQty: type: integer description: Total number of cases format: int32 innerPackQty: type: integer description: Total number of sellable units per case format: int32 receivedQty: type: integer description: Qty received in FC format: int32 damagedQty: type: integer description: Qty damaged while receiving in FC format: int32 fillRate: type: number description: Fill rate for this shipment item format: float expectedDeliveryDate: type: string description: expected delivery date provided by seller format: date-time updatedExpectedDeliveryDate: type: string description: update expected delivery date based on network capacity format: date-time shipNodeName: type: string description: FC name description: response payload example: headers: limit: 10 offset: 0 totalCount: 4 payload: - inboundOrderId: '1235113' shipmentId: 4846GDM gtin: '00634482736852' sku: ACDD-WZK73685 itemDesc: Blue Jeans itemQty: 10 vendorPackQty: 0 innerPackQty: 0 receivedQty: 0 damagedQty: 0 fillRate: 0 expectedDeliveryDate: '2020-09-24T00:00:00.000Z' updatedExpectedDeliveryDate: '2020-09-24T00:00:00.000Z' - inboundOrderId: '1235113' shipmentId: 4846GDM gtin: '00812040019191' sku: KALA-WFS-KA-SWG-BL itemDesc: Google mini itemQty: 16 vendorPackQty: 0 innerPackQty: 0 receivedQty: 0 damagedQty: 0 fillRate: 0 expectedDeliveryDate: '2020-09-24T00:00:00.000Z' updatedExpectedDeliveryDate: '2020-09-24T00:00:00.000Z' - inboundOrderId: '1235113' shipmentId: 4846GDM gtin: '00077540052578' sku: NOTN-WFS-10480 itemDesc: Blue Jeans itemQty: 12 vendorPackQty: 0 innerPackQty: 0 receivedQty: 0 damagedQty: 0 fillRate: 0 expectedDeliveryDate: '2020-09-24T00:00:00.000Z' updatedExpectedDeliveryDate: '2020-09-24T00:00:00.000Z' - inboundOrderId: '1235113' shipmentId: 4846GDM gtin: '00636047311207' sku: GLHF-GL1304WMST itemDesc: Blue Jeans itemQty: 14 vendorPackQty: 0 innerPackQty: 0 receivedQty: 0 damagedQty: 0 fillRate: 0 expectedDeliveryDate: '2020-09-24T00:00:00.000Z' updatedExpectedDeliveryDate: '2020-09-24T00:00:00.000Z' "/v3/fulfillment/inbound-shipment-errors": get: tags: - Fulfillment summary: Walmart Get Inbound Shipment Errors description: "After Sellers request to create an Inbound Order, WFS may return error responses with error codes. Type of errors: \n- \tSKUs not in WFS catalog: Sellers need to make sure all SKUs have already been converted and added to the WFS catalog\n- \tMissing required information; \n- \tInvalid Product ID (incorrect number of digits); \n- \tDuplicated Inbound Order ID: Inbound Order ID has already been used before\n- \tDuplicated Product IDs\nMost of these errors can be prevented with a robust API integration that does not allow the mistakes to be made. Seller should update the request based on the error message and re-submit the request.\nPlease note, once the Inbound Order is created successfully after the re-submission, historical errors under the same Inbound Order ID will be removed and no longer accessible. " externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2839" operationId: getInboundOrderErrors parameters: - name: offset in: query description: offset is the number of records you wish to skip before selecting records. required: false schema: type: string default: '0' - name: limit in: query description: The number of Purchase Orders to be returned. required: false schema: type: string default: '10' - name: shipmentId in: query description: Unique ID identifying each shipment. 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: headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 payload: type: array description: response payload items: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment requests createdDate: type: string description: created date for the request format: date-time returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: type: array description: inbound shipment request line items items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items errors: type: array description: Error in inbound shipment creation 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 xml: name: Error description: response payload example: headers: limit: 10 offset: 0 totalCount: 1 payload: - inboundOrderId: test-shipment-1 createdDate: '2020-10-19T01:06:24.207Z' returnAddress: addressLine1: address line 1 city: Sunnyvale stateCode: CA countryCode: US postalCode: '94087' orderItems: - productId: '7036848676 ' productType: UPC sku: sku1 itemDesc: product 1 itemQty: 20 vendorPackQty: 2 innerPackQty: 10 expectedDeliveryDate: '2020-10-27T16:00:00.000Z' - productId: '703684867 ' productType: UPC sku: sku2 itemDesc: product 2 itemQty: 30 vendorPackQty: 3 innerPackQty: 30 expectedDeliveryDate: '2020-10-27T16:00:00.000Z' errors: - code: 400.WSAAS.100 field: orderItems[0].productId description: Product ID with Product Type UPC should be 12 digit info: 'Product ID with Product Type UPC should be 12 digit:703684867609 ' severity: ERROR category: REQUEST - code: 400.WSAAS.100 field: orderItems[1].productId description: Product ID with Product Type UPC should be 12 digit info: 'Product ID with Product Type UPC should be 12 digit:703684867661 ' severity: ERROR category: REQUEST "/v3/fulfillment/inbound-shipments/{inboundOrderId}": delete: tags: - Fulfillment summary: Walmart Cancel Inbound Shipment description: "The purpose of this service is to cancel an inbound order.\nSeller can cancel an Inbound Order before any of its Shipment arrives at the WFS FCs. Seller cannot cancel an Inbound Order if any of its Shipment’s status = Receiving in Progress, Closed, or Cancelled \nSeller can only cancel at the Inbound Order level, not the Shipment level: if an Inbound Order is cancelled, all Shipments on that order will be cancelled." externalDocs: description: View Guide url: "/doc/us/mp/us-mp-fulfillment/#2946" operationId: cancelShipment parameters: - name: inboundOrderId in: path description: Unique ID identifying inbound shipment request 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: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse example: status: OK "/v3/fulfillment/carrier-rate-quote/{shipmentId}": delete: tags: - Fulfillment summary: Walmart Cancel Carrier Rate Quote description: The purpose of this service is for seller to void the carrier shipping charges, within 24 hours after the estimated carrier charges have been accepted by the seller. operationId: voidCarrierRateQuote parameters: - name: shipmentId in: path description: Unique ID identifying each shipment. 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: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse components: schemas: Cause: type: object properties: code: type: string field: type: string type: type: string description: type: string xml: name: Cause Error: 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 xml: name: Error ServiceHeader: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader ServiceResponse: required: - status type: object properties: status: type: string enum: - OK - CREATED - ACCEPTED - NO_CONTENT - PARTIAL - MOVED_PERMANENT - FOUND - SEE_OTHER - NOT_MODIFIED - TEMPORARY_REDIRECT - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - METHOD_NOT_ALLOWED - NOT_ACCEPTABLE - REQUEST_TIMEOUT - CONFLICT - REQUEST_ENTITY_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - FAIL - BAD_GATEWAY - SERVICE_UNAVAILABLE - GATEWAY_TIMEOUT header: type: object properties: headerAttributes: type: object additionalProperties: type: object xml: name: ServiceHeader errors: type: array xml: wrapped: true 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 xml: name: Error payload: type: object xml: name: ServiceResponse InboundShipmentUpdateQtyWrapper: required: - inboundOrderId - shipmentId type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying inbound shipment orderItems: maxItems: 5000 minItems: 1 type: array description: update shipment qty line items xml: wrapped: true items: required: - sku - updatedShipmentQty type: object properties: sku: type: string description: Seller Item ID updatedShipmentQty: minimum: 0 type: integer description: updated quantity format: int32 description: update shipment qty line items OrderItemUpdate: required: - sku - updatedShipmentQty type: object properties: sku: type: string description: Seller Item ID updatedShipmentQty: minimum: 0 type: integer description: updated quantity format: int32 description: update shipment qty line items Filter: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | status | Item status | string enum: - status op: type: string enum: - equals values: type: array items: type: string enum: - PROHIBITED - IN_REVIEW - ACTION_NEEDED Query: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string | gtin | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits. | string enum: - sku - gtin value: type: string Sort: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | createdAt | when the item is last submitted/updated by Seller | string | updatedAt | when the item is last updated by Seller/Walmart | string | enum: - createdAt - updatedAt order: type: string enum: - ASC - DESC WercsFeedbackRequest: type: object properties: query: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string | gtin | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits. | string enum: - sku - gtin value: type: string filters: type: array items: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | status | Item status | string enum: - status op: type: string enum: - equals values: type: array items: type: string enum: - PROHIBITED - IN_REVIEW - ACTION_NEEDED sort: type: object properties: field: type: string description: |- | Attribute | Description | Data Type | --- | ----------- | ------- | createdAt | when the item is last submitted/updated by Seller | string | updatedAt | when the item is last updated by Seller/Walmart | string | enum: - createdAt - updatedAt order: type: string enum: - ASC - DESC TrackingInfoWrapper: required: - carrierName - shipmentId type: object properties: shipmentId: type: string carrierName: type: string trackingInfo: maxItems: 100 minItems: 1 type: array xml: wrapped: true items: type: string LabelV2RequestWrapper: required: - shipmentId type: object properties: shipmentId: type: string labelSize: type: string labelFormat: type: string loadTypes: type: array xml: wrapped: true items: type: object properties: count: type: integer format: int32 loadType: type: string LoadType: type: object properties: count: type: integer format: int32 loadType: type: string CustomerOrderHeader: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId CustomerOrderHeaderAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes CustomerOrderResponseWrapper: type: object properties: requestId: type: string description: Unique ID identifying each request description: response payload CustomerOrderResponseWrapperDTO: type: object properties: status: type: string description: status header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: type: object properties: requestId: type: string description: Unique ID identifying each request description: response payload ChargeDetails: required: - chargeCategory - chargeName - chargePerUnit type: object properties: chargeCategory: type: string description: 'Charge category, for example: ''PRODUCT''' chargeName: type: string description: 'Name of the charge, for example: ''Sale Price''' chargePerUnit: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details taxDetails: type: object properties: taxPerLine: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details description: Tax details description: Item charge details Contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details CreateCustomerOrderRequestPayload: required: - customer - orderChannelId - orderItems - orderPlacedTime - sellerOrderId type: object properties: orderChannelId: type: string description: Unique ID identifying channels from where the orders have been generated. This ID is generated by Walmart at the time of on-boarding onto multichannel program and this cannot be a random number sellerOrderId: maxLength: 18 minLength: 0 pattern: "^[A-Za-z0-9\\s]+$" type: string description: 'Unique ID identifying customer order request. Only alphanumeric values are accepted. Preferred to attach seller short name as prefix. For example: ''seller001''' orderPlacedTime: type: string description: 'Order placed time at respective channels. Format: ''2022-03-25T21:58:30.143Z''' format: date-time needsConfirmation: type: boolean description: 'Flag to identify if confirmation is needed. Currently supported: ''false''' partialFulfillments: type: boolean description: 'Flag to identify if partial fulfilment is allowed. Currently supported: ''false''' customer: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details description: Customer details orderItems: type: array description: Order items details items: required: - chargeDetails - itemDetail - qty - sellerLineId - shippingTo type: object properties: fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type: ''DELIVERY''' sellerLineId: maxLength: 6 minLength: 1 type: string description: Unique Id for each line item, preferred sequence 1,2,3... itemDetail: required: - sku type: object properties: sku: maxLength: 50 minLength: 1 type: string description: The identifier of the item in seller system (vendor sku) description: maxLength: 256 minLength: 1 type: string description: Description of the item description: Details of an item qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 4 minLength: 1 type: string description: 'Sales unit measure. Currently supported type : ''EACH''' measurementValue: minimum: 1 exclusiveMinimum: false type: number description: Requested Quantity Information of an item description: Item quantity details shippingMethod: type: string description: 'Shipping method of an order. Currently supported type: ''EXPEDITED'', ''STANDARD''' enum: - EXPEDITED - STANDARD - RUSH shippingTo: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details address: required: - city - country - line1 - state - zip type: object properties: line1: maxLength: 120 minLength: 1 type: string description: First line of the address line2: maxLength: 120 minLength: 1 type: string description: Second line of the address city: maxLength: 32 minLength: 1 type: string description: City where the address is located in state: maxLength: 2 minLength: 1 type: string description: 'State (two letter) code where the address is located in, for example: ''MI''' country: maxLength: 3 minLength: 1 type: string description: 'Country code where the address is located in, for example: ''USA''' zip: maxLength: 5 minLength: 1 type: string description: 'ZIP or postal code where the address is located in, for example: ''48083''' addressType: type: string description: 'The address type. Currently supported: ''RESIDENTIAL''' description: Customer address details description: Shipping address details chargeDetails: type: array description: Item charge details xml: wrapped: true items: required: - chargeCategory - chargeName - chargePerUnit type: object properties: chargeCategory: type: string description: 'Charge category, for example: ''PRODUCT''' chargeName: type: string description: 'Name of the charge, for example: ''Sale Price''' chargePerUnit: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details taxDetails: type: object properties: taxPerLine: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details description: Tax details description: Item charge details description: Order items details description: request payload CreateCustomerOrderRequestWrapper: required: - header - payload type: object properties: header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: required: - customer - orderChannelId - orderItems - orderPlacedTime - sellerOrderId type: object properties: orderChannelId: type: string description: Unique ID identifying channels from where the orders have been generated. This ID is generated by Walmart at the time of on-boarding onto multichannel program and this cannot be a random number sellerOrderId: maxLength: 18 minLength: 0 pattern: "^[A-Za-z0-9\\s]+$" type: string description: 'Unique ID identifying customer order request. Only alphanumeric values are accepted. Preferred to attach seller short name as prefix. For example: ''seller001''' orderPlacedTime: type: string description: 'Order placed time at respective channels. Format: ''2022-03-25T21:58:30.143Z''' format: date-time needsConfirmation: type: boolean description: 'Flag to identify if confirmation is needed. Currently supported: ''false''' partialFulfillments: type: boolean description: 'Flag to identify if partial fulfilment is allowed. Currently supported: ''false''' customer: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details description: Customer details orderItems: type: array description: Order items details items: required: - chargeDetails - itemDetail - qty - sellerLineId - shippingTo type: object properties: fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type: ''DELIVERY''' sellerLineId: maxLength: 6 minLength: 1 type: string description: Unique Id for each line item, preferred sequence 1,2,3... itemDetail: required: - sku type: object properties: sku: maxLength: 50 minLength: 1 type: string description: The identifier of the item in seller system (vendor sku) description: maxLength: 256 minLength: 1 type: string description: Description of the item description: Details of an item qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 4 minLength: 1 type: string description: 'Sales unit measure. Currently supported type : ''EACH''' measurementValue: minimum: 1 exclusiveMinimum: false type: number description: Requested Quantity Information of an item description: Item quantity details shippingMethod: type: string description: 'Shipping method of an order. Currently supported type: ''EXPEDITED'', ''STANDARD''' enum: - EXPEDITED - STANDARD - RUSH shippingTo: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details address: required: - city - country - line1 - state - zip type: object properties: line1: maxLength: 120 minLength: 1 type: string description: First line of the address line2: maxLength: 120 minLength: 1 type: string description: Second line of the address city: maxLength: 32 minLength: 1 type: string description: City where the address is located in state: maxLength: 2 minLength: 1 type: string description: 'State (two letter) code where the address is located in, for example: ''MI''' country: maxLength: 3 minLength: 1 type: string description: 'Country code where the address is located in, for example: ''USA''' zip: maxLength: 5 minLength: 1 type: string description: 'ZIP or postal code where the address is located in, for example: ''48083''' addressType: type: string description: 'The address type. Currently supported: ''RESIDENTIAL''' description: Customer address details description: Shipping address details chargeDetails: type: array description: Item charge details xml: wrapped: true items: required: - chargeCategory - chargeName - chargePerUnit type: object properties: chargeCategory: type: string description: 'Charge category, for example: ''PRODUCT''' chargeName: type: string description: 'Name of the charge, for example: ''Sale Price''' chargePerUnit: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details taxDetails: type: object properties: taxPerLine: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details description: Tax details description: Item charge details description: Order items details description: request payload CurrencyType: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details CustomerAddress: required: - city - country - line1 - state - zip type: object properties: line1: maxLength: 120 minLength: 1 type: string description: First line of the address line2: maxLength: 120 minLength: 1 type: string description: Second line of the address city: maxLength: 32 minLength: 1 type: string description: City where the address is located in state: maxLength: 2 minLength: 1 type: string description: 'State (two letter) code where the address is located in, for example: ''MI''' country: maxLength: 3 minLength: 1 type: string description: 'Country code where the address is located in, for example: ''USA''' zip: maxLength: 5 minLength: 1 type: string description: 'ZIP or postal code where the address is located in, for example: ''48083''' addressType: type: string description: 'The address type. Currently supported: ''RESIDENTIAL''' description: Customer address details CustomerOrderContactDetails: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details description: Customer details CustomerOrderItem: required: - chargeDetails - itemDetail - qty - sellerLineId - shippingTo type: object properties: fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type: ''DELIVERY''' sellerLineId: maxLength: 6 minLength: 1 type: string description: Unique Id for each line item, preferred sequence 1,2,3... itemDetail: required: - sku type: object properties: sku: maxLength: 50 minLength: 1 type: string description: The identifier of the item in seller system (vendor sku) description: maxLength: 256 minLength: 1 type: string description: Description of the item description: Details of an item qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 4 minLength: 1 type: string description: 'Sales unit measure. Currently supported type : ''EACH''' measurementValue: minimum: 1 exclusiveMinimum: false type: number description: Requested Quantity Information of an item description: Item quantity details shippingMethod: type: string description: 'Shipping method of an order. Currently supported type: ''EXPEDITED'', ''STANDARD''' enum: - EXPEDITED - STANDARD - RUSH shippingTo: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details address: required: - city - country - line1 - state - zip type: object properties: line1: maxLength: 120 minLength: 1 type: string description: First line of the address line2: maxLength: 120 minLength: 1 type: string description: Second line of the address city: maxLength: 32 minLength: 1 type: string description: City where the address is located in state: maxLength: 2 minLength: 1 type: string description: 'State (two letter) code where the address is located in, for example: ''MI''' country: maxLength: 3 minLength: 1 type: string description: 'Country code where the address is located in, for example: ''USA''' zip: maxLength: 5 minLength: 1 type: string description: 'ZIP or postal code where the address is located in, for example: ''48083''' addressType: type: string description: 'The address type. Currently supported: ''RESIDENTIAL''' description: Customer address details description: Shipping address details chargeDetails: type: array description: Item charge details xml: wrapped: true items: required: - chargeCategory - chargeName - chargePerUnit type: object properties: chargeCategory: type: string description: 'Charge category, for example: ''PRODUCT''' chargeName: type: string description: 'Name of the charge, for example: ''Sale Price''' chargePerUnit: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details taxDetails: type: object properties: taxPerLine: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details description: Tax details description: Item charge details description: Order items details CustomerOrderItemQuantityType: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 4 minLength: 1 type: string description: 'Sales unit measure. Currently supported type : ''EACH''' measurementValue: minimum: 1 exclusiveMinimum: false type: number description: Requested Quantity Information of an item description: Item quantity details CustomerOrderName: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer ItemDetail: required: - sku type: object properties: sku: maxLength: 50 minLength: 1 type: string description: The identifier of the item in seller system (vendor sku) description: maxLength: 256 minLength: 1 type: string description: Description of the item description: Details of an item PickupPersonDetails: required: - contact type: object properties: contact: required: - email - name - phone type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer phone: maxLength: 15 minLength: 1 type: string description: Customer phone number email: maxLength: 64 minLength: 1 type: string description: Customer email address description: Customer contact details address: required: - city - country - line1 - state - zip type: object properties: line1: maxLength: 120 minLength: 1 type: string description: First line of the address line2: maxLength: 120 minLength: 1 type: string description: Second line of the address city: maxLength: 32 minLength: 1 type: string description: City where the address is located in state: maxLength: 2 minLength: 1 type: string description: 'State (two letter) code where the address is located in, for example: ''MI''' country: maxLength: 3 minLength: 1 type: string description: 'Country code where the address is located in, for example: ''USA''' zip: maxLength: 5 minLength: 1 type: string description: 'ZIP or postal code where the address is located in, for example: ''48083''' addressType: type: string description: 'The address type. Currently supported: ''RESIDENTIAL''' description: Customer address details description: Shipping address details TaxDetails: type: object properties: taxPerLine: required: - currencyAmount - unit type: object properties: currencyAmount: type: number description: 'Currency amount, preferred value: 0' unit: type: string description: 'Currency unit, for example: ''USD''' xml: name: currencyUnit 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 description: Currency type details description: Tax details AccessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. AvailableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Available Quantity Information of an item. Fulfillment: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. FulfillmentDate: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. FulfillmentGroup: type: object properties: fulfillmentOptions: type: array description: Fulfillment options details. items: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. description: Fulfillment Group details. FulfillmentModule: type: object properties: name: type: string description: 'Fulfillment module name. For example : ''UNSCHEDULED_DELIVERY and ERROR''' fulfillmentGroups: type: array description: Fulfillment Group details. items: type: object properties: fulfillmentOptions: type: array description: Fulfillment options details. items: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. description: Fulfillment Group details. description: Fulfillment module details. FulfillmentOption: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. FulfillmentPlan: type: object properties: fulfillmentModules: type: array description: Fulfillment module details. items: type: object properties: name: type: string description: 'Fulfillment module name. For example : ''UNSCHEDULED_DELIVERY and ERROR''' fulfillmentGroups: type: array description: Fulfillment Group details. items: type: object properties: fulfillmentOptions: type: array description: Fulfillment options details. items: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. description: Fulfillment Group details. description: Fulfillment module details. description: Fulfillment plans details. FulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. LineItemAttributes: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. PromiseAddress: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. PromiseDestinationResponse: type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. PromiseOrderResponsePayload: type: object properties: offers: type: array description: Offer details indicating available quantity vs required quantify for offer items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Available Quantity Information of an item. requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' sku: type: string description: The identifier of the item in seller system (vendor sku). description: Offer details indicating available quantity vs required quantify for offer destinations: type: array description: Customer order destination details. items: type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. fulfillmentPlans: type: array description: Fulfillment plans details. items: type: object properties: fulfillmentModules: type: array description: Fulfillment module details. items: type: object properties: name: type: string description: 'Fulfillment module name. For example : ''UNSCHEDULED_DELIVERY and ERROR''' fulfillmentGroups: type: array description: Fulfillment Group details. items: type: object properties: fulfillmentOptions: type: array description: Fulfillment options details. items: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. description: Fulfillment Group details. description: Fulfillment module details. description: Fulfillment plans details. description: Response payload. PromiseOrderResponseWrapper: type: object properties: status: type: string description: Response status. header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: type: object properties: offers: type: array description: Offer details indicating available quantity vs required quantify for offer items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Available Quantity Information of an item. requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' sku: type: string description: The identifier of the item in seller system (vendor sku). description: Offer details indicating available quantity vs required quantify for offer destinations: type: array description: Customer order destination details. items: type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. fulfillmentPlans: type: array description: Fulfillment plans details. items: type: object properties: fulfillmentModules: type: array description: Fulfillment module details. items: type: object properties: name: type: string description: 'Fulfillment module name. For example : ''UNSCHEDULED_DELIVERY and ERROR''' fulfillmentGroups: type: array description: Fulfillment Group details. items: type: object properties: fulfillmentOptions: type: array description: Fulfillment options details. items: type: object properties: fulfillmentMode: type: string description: 'Fulfillment mode detail. For example : ''UNSCHEDULED''' accessType: type: string description: 'Fulfillment access type. For example : ''DELIVERY_ADDRESS''' fulfillments: type: array description: Fulfillment details. items: type: object properties: fulfillmentId: type: string description: The identifier to identify fulfillment. lineItemAttributesList: type: array description: Line item attribute details. items: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. fulfillmentChannel: type: array description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' items: type: string description: 'Fulfillment channel details. For example : ''WFS_FULFILLED''' lineId: type: string description: The identifier to identify each line, assigned by seller systems. description: Line item attribute details. sla: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. nodeType: type: string description: 'Fulfillment node type details. For example : ''FC''' accessMode: type: object properties: mode: type: string description: 'Fulfillment access mode type. For example : ''NATIONAL_CARRIER''' description: Fulfillment access mode details. fulfillmentTime: type: object properties: date: type: object properties: minPromiseDate: type: string description: Fulfillment minimum promise date detail. format: date-time Fulfillment maximum promise date detail.: type: string format: date-time description: Fulfillment date details. description: Fulfillment time details. errors: type: array description: Error list details. 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 xml: name: Error description: Fulfillment details. fulfillmentType: type: string description: 'Fulfillment type detail. For example : ''DELIVERY''' description: Fulfillment options details. description: Fulfillment Group details. description: Fulfillment module details. description: Fulfillment plans details. description: Response payload. PromiseResponseOffer: type: object properties: availableQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Available Quantity Information of an item. requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' sku: type: string description: The identifier of the item in seller system (vendor sku). description: Offer details indicating available quantity vs required quantify for offer RequestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. ServiceLevelAgreement: type: object properties: tier: type: string description: 'Service level agreement tier details.For example : ''TWO_DAY''' speed: type: string description: 'Ship method details. For example : ''Rush, Expedited, Value and Standard''' description: Fulfillment service level agreement details. OfferSelection: required: - offers type: object properties: offers: type: array description: Offer details. List of an items/vendor sku. xml: wrapped: true items: required: - lineId - requestedQuantity - salesUnit - sku type: object properties: sku: type: string description: The identifier of the item in seller system (vendor sku). lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. description: Offer details. List of an items/vendor sku. description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. PromiseDestination: required: - address - fulfillmentType type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. PromiseOffer: required: - lineId - requestedQuantity - salesUnit - sku type: object properties: sku: type: string description: The identifier of the item in seller system (vendor sku). lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. description: Offer details. List of an items/vendor sku. PromiseOrderRequestPayload: required: - destinations - offerSelections type: object properties: destinations: type: array description: Customer order destination details. xml: wrapped: true items: required: - address - fulfillmentType type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. offerSelections: type: array description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. xml: wrapped: true items: required: - offers type: object properties: offers: type: array description: Offer details. List of an items/vendor sku. xml: wrapped: true items: required: - lineId - requestedQuantity - salesUnit - sku type: object properties: sku: type: string description: The identifier of the item in seller system (vendor sku). lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. description: Offer details. List of an items/vendor sku. description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. description: Request payload. PromiseOrderRequestWrapper: required: - header type: object properties: header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: required: - destinations - offerSelections type: object properties: destinations: type: array description: Customer order destination details. xml: wrapped: true items: required: - address - fulfillmentType type: object properties: address: required: - postalCode - stateCode type: object properties: city: type: string description: City where the address is located in. addressType: type: string description: 'The address type. For example: ''RESIDENTIAL''' postalCode: type: string description: ZIP or postal code where the address is located in. addressLineOne: type: string description: First line of the address. addressLineTwo: type: string description: Second line of the address. countryCode: type: string description: Country code where the address is located in. stateCode: type: string description: State (two letter) code where the address is located in. isPOBox: type: boolean description: PO box detail. description: Address details. fulfillmentType: type: string description: 'Fulfillment Type of an order. Currently supported type : ''DELIVERY''' description: Customer order destination details. offerSelections: type: array description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. xml: wrapped: true items: required: - offers type: object properties: offers: type: array description: Offer details. List of an items/vendor sku. xml: wrapped: true items: required: - lineId - requestedQuantity - salesUnit - sku type: object properties: sku: type: string description: The identifier of the item in seller system (vendor sku). lineId: type: string description: The identifier (UUID) for each line assigned by seller systems. salesUnit: type: string description: 'Sales unit type. Currently supported type : ''EACH''' requestedQuantity: required: - measurementValue - unitOfMeasure type: object properties: measurementValue: minimum: 1 type: integer description: Quantity of each item. format: int32 unitOfMeasure: type: string description: 'Unit of quantity. Currently supported type : ''EA''' description: Requested Quantity Information of an item. description: Offer details. List of an items/vendor sku. description: Offer Selection details. List of offers - number of offer inside offer selection should be less than or equal to 30. description: Request payload. CancelCustomerOrderRequestPayload: required: - orderItems - sellerOrderId type: object properties: sellerOrderId: type: string orderItems: type: array xml: wrapped: true items: required: - qty - sellerLineId type: object properties: sellerLineId: maxLength: 32 minLength: 1 type: string qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 32 minLength: 1 type: string measurementValue: minimum: 1 exclusiveMinimum: false type: number description: request payload CancelCustomerOrderRequestWrapper: required: - header type: object properties: header: type: object properties: headerAttributes: type: object properties: martId: type: string description: 'martId of the seller. Currently supported: ''202''' buId: type: string description: 'buId of the seller. Currently supported: ''0''' description: Header attributes description: header to support build and martId payload: required: - orderItems - sellerOrderId type: object properties: sellerOrderId: type: string orderItems: type: array xml: wrapped: true items: required: - qty - sellerLineId type: object properties: sellerLineId: maxLength: 32 minLength: 1 type: string qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 32 minLength: 1 type: string measurementValue: minimum: 1 exclusiveMinimum: false type: number description: request payload OrderCancelItem: required: - qty - sellerLineId type: object properties: sellerLineId: maxLength: 32 minLength: 1 type: string qty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 32 minLength: 1 type: string measurementValue: minimum: 1 exclusiveMinimum: false type: number QuantityType: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: maxLength: 32 minLength: 1 type: string measurementValue: minimum: 1 exclusiveMinimum: false type: number InboundShipmentCreateResponseWrapper: type: object properties: shipmentId: type: string description: Unique ID identifying each shipment shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items shipmentItems: type: array description: The items which needs to be send in the shipment items: type: object properties: vendorSku: type: string description: Seller Item ID itemQty: type: integer description: Total number of sellable units format: int32 description: The items which needs to be send in the shipment expectedDeliveryDate: type: string description: expected delivery date for inbounding shipment. Can be different from provided in the rquest based on network capacity format: date-time description: response payload InboundShipmentCreateResponseWrapperDTO: type: object properties: status: type: string payload: type: array description: response payload items: type: object properties: shipmentId: type: string description: Unique ID identifying each shipment shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items shipmentItems: type: array description: The items which needs to be send in the shipment items: type: object properties: vendorSku: type: string description: Seller Item ID itemQty: type: integer description: Total number of sellable units format: int32 description: The items which needs to be send in the shipment expectedDeliveryDate: type: string description: expected delivery date for inbounding shipment. Can be different from provided in the rquest based on network capacity format: date-time description: response payload ShipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items ShipmentItem: type: object properties: vendorSku: type: string description: Seller Item ID itemQty: type: integer description: Total number of sellable units format: int32 description: The items which needs to be send in the shipment InboundService: type: object properties: inventoryTransferService: type: string description: ITS Flag description: Requested inbound services such as ITS InboundShipmentRequestWrapper: required: - inboundOrderId - returnAddress type: object properties: inboundOrderId: maxLength: 100 minLength: 0 type: string description: Unique ID identifying inbound shipment request inboundServices: type: object properties: inventoryTransferService: type: string description: ITS Flag description: Requested inbound services such as ITS returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: maxItems: 5000 minItems: 1 type: array description: inbound shipment request line items xml: wrapped: true items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items OrderItem: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items ReturnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller InboundPreviewResponseDTO: type: object properties: inboundOrderId: type: string description: Unique shipment identifier previews: type: array description: List of preview responses items: type: object properties: previewType: type: string description: Use "inbound" if you are using WFS Inventory Transfer Service (ITS). Use "selfMirroring" if you are not using ITS and shipping directly to Walmart fulfillment centers. preview: type: array description: Preview items: type: object properties: shipNode: type: string description: Ship Node isSortable: type: boolean description: Flag indicating if the dimensions of the item make it sortable isNonSortable: type: boolean description: Flag indicating if the dimensions of the item make it non-sortable nodeType: type: string description: 'Node Type: FC/ICC' shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items totalNetTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated shipmentItems: type: array description: Shipment items items: type: object properties: vendorSku: type: string description: Vendor SKU productType: type: string description: 'Product type: GTIN/UPC/EAN' productId: type: string description: Unique product identifier itemQty: type: integer description: Item quantity format: int32 netTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated description: Shipment items description: Preview description: List of preview responses description: Response payload. InboundPreviewResponseWrapper: type: object properties: status: type: string description: Response status. payload: type: array description: Response payload. items: type: object properties: inboundOrderId: type: string description: Unique shipment identifier previews: type: array description: List of preview responses items: type: object properties: previewType: type: string description: Use "inbound" if you are using WFS Inventory Transfer Service (ITS). Use "selfMirroring" if you are not using ITS and shipping directly to Walmart fulfillment centers. preview: type: array description: Preview items: type: object properties: shipNode: type: string description: Ship Node isSortable: type: boolean description: Flag indicating if the dimensions of the item make it sortable isNonSortable: type: boolean description: Flag indicating if the dimensions of the item make it non-sortable nodeType: type: string description: 'Node Type: FC/ICC' shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items totalNetTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated shipmentItems: type: array description: Shipment items items: type: object properties: vendorSku: type: string description: Vendor SKU productType: type: string description: 'Product type: GTIN/UPC/EAN' productId: type: string description: Unique product identifier itemQty: type: integer description: Item quantity format: int32 netTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated description: Shipment items description: Preview description: List of preview responses description: Response payload. Preview: type: object properties: previewType: type: string description: Use "inbound" if you are using WFS Inventory Transfer Service (ITS). Use "selfMirroring" if you are not using ITS and shipping directly to Walmart fulfillment centers. preview: type: array description: Preview items: type: object properties: shipNode: type: string description: Ship Node isSortable: type: boolean description: Flag indicating if the dimensions of the item make it sortable isNonSortable: type: boolean description: Flag indicating if the dimensions of the item make it non-sortable nodeType: type: string description: 'Node Type: FC/ICC' shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items totalNetTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated shipmentItems: type: array description: Shipment items items: type: object properties: vendorSku: type: string description: Vendor SKU productType: type: string description: 'Product type: GTIN/UPC/EAN' productId: type: string description: Unique product identifier itemQty: type: integer description: Item quantity format: int32 netTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated description: Shipment items description: Preview description: List of preview responses PreviewResponseDTO: type: object properties: shipNode: type: string description: Ship Node isSortable: type: boolean description: Flag indicating if the dimensions of the item make it sortable isNonSortable: type: boolean description: Flag indicating if the dimensions of the item make it non-sortable nodeType: type: string description: 'Node Type: FC/ICC' shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items totalNetTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated shipmentItems: type: array description: Shipment items items: type: object properties: vendorSku: type: string description: Vendor SKU productType: type: string description: 'Product type: GTIN/UPC/EAN' productId: type: string description: Unique product identifier itemQty: type: integer description: Item quantity format: int32 netTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated description: Shipment items description: Preview PreviewShipmentItem: type: object properties: vendorSku: type: string description: Vendor SKU productType: type: string description: 'Product type: GTIN/UPC/EAN' productId: type: string description: Unique product identifier itemQty: type: integer description: Item quantity format: int32 netTransferCharge: type: number description: Total charge if you are using ITS. currencyUnit: type: string description: Currency in which transfer charge is estimated description: Shipment items CreateInboundRequestDTO: required: - inboundOrderId - orderItems - returnAddress type: object properties: inboundOrderId: maxLength: 50 minLength: 0 type: string description: Unique identifier used for shipments returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: maxItems: 5000 minItems: 1 type: array description: List of Order Items xml: wrapped: true items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items description: Request Payload InboundPreviewWrapper: required: - header - payload type: object properties: header: required: - headerAttributes type: object properties: headerAttributes: required: - buId - martId type: object properties: buId: type: string description: Business unit identifier and must be 0 for US market. xml: wrapped: true martId: type: string description: Market identifier and must be 0 for US market. xml: wrapped: true description: Multi Tenant header attributes description: Request Multi Tenant Header Wrapper payload: required: - inboundOrderId - orderItems - returnAddress type: object properties: inboundOrderId: maxLength: 50 minLength: 0 type: string description: Unique identifier used for shipments returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: maxItems: 5000 minItems: 1 type: array description: List of Order Items xml: wrapped: true items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items description: Request Payload MultitenantHeader: required: - buId - martId type: object properties: buId: type: string description: Business unit identifier and must be 0 for US market. xml: wrapped: true martId: type: string description: Market identifier and must be 0 for US market. xml: wrapped: true description: Multi Tenant header attributes MultitenantHeaderWrapper: required: - headerAttributes type: object properties: headerAttributes: required: - buId - martId type: object properties: buId: type: string description: Business unit identifier and must be 0 for US market. xml: wrapped: true martId: type: string description: Market identifier and must be 0 for US market. xml: wrapped: true description: Multi Tenant header attributes description: Request Multi Tenant Header Wrapper Carrier: type: object properties: carrierId: type: string carrierName: type: string QuoteResponseV2Wrapper: type: object properties: shipmentId: type: string shipmentNumber: type: string rateQuotes: type: array items: type: object properties: quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string currency: type: string discountCharge: type: number format: float netCharge: type: number format: float surchargeType: type: string surchargeValue: type: string totalBillingWeight: type: number format: float status: type: string transitDays: type: string effectiveDate: type: string format: date-time expiryDate: type: string format: date-time mode: type: string sellerFreightClassCode: type: string freightCharge: type: number format: float fuelCharge: type: number format: float totalWeight: type: number format: float totalVolume: type: number format: float equipmentTypeCode: type: string serviceCode: type: string numberOfPallets: type: integer format: int32 nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float minimumCharge: type: number format: float declaredValue: type: string mixedSKUs: type: integer format: int32 singleSKUs: type: integer format: int32 freightReadyDate: type: string format: date-time RateQuoteV2: type: object properties: quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string currency: type: string discountCharge: type: number format: float netCharge: type: number format: float surchargeType: type: string surchargeValue: type: string totalBillingWeight: type: number format: float status: type: string transitDays: type: string effectiveDate: type: string format: date-time expiryDate: type: string format: date-time mode: type: string sellerFreightClassCode: type: string freightCharge: type: number format: float fuelCharge: type: number format: float totalWeight: type: number format: float totalVolume: type: number format: float equipmentTypeCode: type: string serviceCode: type: string numberOfPallets: type: integer format: int32 nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float minimumCharge: type: number format: float declaredValue: type: string mixedSKUs: type: integer format: int32 singleSKUs: type: integer format: int32 freightReadyDate: type: string format: date-time Address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string CarrierQuoteRequestV2Wrapper: required: - customer - destinationLocation - mode - originLocation - returnLocation - shipmentId - shipmentPackages - shipmentSource type: object properties: shipmentId: type: string shipmentSource: type: string pickupFromDateTime: type: string format: date-time pickupToDateTime: type: string format: date-time deliveryFromDateTime: type: string format: date-time deliveryToDateTime: type: string format: date-time customer: required: - customerId - customerName type: object properties: customerId: type: string customerName: type: string originLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string destinationLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string returnLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string shipmentPackages: maxItems: 5000 minItems: 1 type: array items: required: - height - length - lengthUOM - packageSequenceNumber - weight - weightUOM - width type: object properties: packageSequenceNumber: type: integer format: int32 weight: minimum: -1 type: number format: float weightUOM: type: string length: minimum: -1 type: number format: float height: minimum: -1 type: number format: float width: minimum: -1 type: number format: float lengthUOM: type: string labelInformation: type: object properties: labelData: type: string labelFormat: type: string trackingCode: type: string referenceTrackingCode: type: string epTrackerId: type: string shipmentId: type: string packageAsn: type: string masterTrackingCode: type: string master: type: boolean billingWeight: type: number format: float netCharge: type: number format: float nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float packageType: type: string noOfPackages: type: integer format: int32 stackable: type: boolean mode: type: string default: PARCEL freightClass: type: string declaredValue: type: integer format: int32 loadTypes: type: array items: required: - count - loadType type: object properties: count: type: string loadType: type: string Customer: required: - customerId - customerName type: object properties: customerId: type: string customerName: type: string DestinationLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string LabelInformation: type: object properties: labelData: type: string labelFormat: type: string trackingCode: type: string referenceTrackingCode: type: string epTrackerId: type: string shipmentId: type: string packageAsn: type: string masterTrackingCode: type: string master: type: boolean LoadTypeDetails: required: - count - loadType type: object properties: count: type: string loadType: type: string OriginLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string ReturnLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string ShipmentPackage: required: - height - length - lengthUOM - packageSequenceNumber - weight - weightUOM - width type: object properties: packageSequenceNumber: type: integer format: int32 weight: minimum: -1 type: number format: float weightUOM: type: string length: minimum: -1 type: number format: float height: minimum: -1 type: number format: float width: minimum: -1 type: number format: float lengthUOM: type: string labelInformation: type: object properties: labelData: type: string labelFormat: type: string trackingCode: type: string referenceTrackingCode: type: string epTrackerId: type: string shipmentId: type: string packageAsn: type: string masterTrackingCode: type: string master: type: boolean billingWeight: type: number format: float netCharge: type: number format: float nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float packageType: type: string noOfPackages: type: integer format: int32 stackable: type: boolean CarrierQuoteConfirmRequestWrapper: required: - shipmentId type: object properties: shipmentId: type: string CarrierLabelRequestWrapper: required: - shipDate type: object properties: shipDate: type: string format: date-time FeedId: type: object properties: feedId: type: string description: A unique ID, returned from the Bulk Upload API, used for tracking the feed file additionalAttributes: type: object nullable: true errors: type: object nullable: true BuyerInfo: type: object properties: primaryContact: type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer description: Primary contact of the order description: buyerInfo of the order CustomerOrderDetailsHeader: type: object properties: headerAttributes: type: object properties: martId: type: string description: martId passed in header buId: type: string description: buId passed in header pageCount: type: integer description: page count of the orders available with given filters format: int32 totalCount: type: integer description: total count of orders available with given filters format: int32 description: Header attributes description: Meta data of the response CustomerOrderDetailsHeaderAttributes: type: object properties: martId: type: string description: martId passed in header buId: type: string description: buId passed in header pageCount: type: integer description: page count of the orders available with given filters format: int32 totalCount: type: integer description: total count of orders available with given filters format: int32 description: Header attributes CustomerOrderDetailsResponse: type: object properties: orderChannelId: type: string description: orderChannelId of the order sellerOrderId: type: string description: sellerOrderId of the order orderType: type: string description: order type of the order status: type: string description: status of the order orderDate: type: string description: createDate of the order format: date-time buyerInfo: type: object properties: primaryContact: type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer description: Primary contact of the order description: buyerInfo of the order shipments: type: array description: createDate of the order items: type: object properties: status: type: string description: Shipment status statusDescription: type: string description: Shipment status description purchaseOrderId: type: string description: Shipment purchase Order Id scac: type: string description: Shipment scac trackingNo: type: string description: Shipment tracking number externalTrackingURL: type: string description: Shipment tracking URL shipmentNo: type: string description: Shipment number actualShipmentDate: type: string description: Actual shipment date packageASN: type: string description: Shipment packageASN number carrierDescription: type: string description: Shipment carrier description carrierServiceCode: type: string description: Shipment carrier service code packageId: type: string description: Shipment package Id lastModified: type: string description: Shipment lastModified date shipmentLines: type: array description: Shipment line details items: type: object properties: shipmentLineNo: type: string description: Shipment line number fulfillerLineId: type: string description: Shipment fulfiller LineId quantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Shipment line details shipmentDates: type: array description: Shipment dates items: type: object properties: actualDate: type: string description: Actual delivery date of the order format: date-time dateTypeId: type: string description: Order dateTypeId expectedDate: type: string description: Expected delivery date of the order format: date-time description: Shipment dates description: createDate of the order orderLines: type: array description: order lines details items: type: object properties: fulfillmentType: type: string description: fulfillmentType of the order lastModified: type: string description: Last modified date of the order lines format: date-time shippingMethod: type: string description: Shipping method of the order lines shippingTier: type: string description: Shipping tier of the order lines orderLineQuantityInfo: type: array description: Order line quantity information items: type: object properties: status: type: string description: status of the order line quantity statusDescription: type: string description: status description of the order line quantity statusQuantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Order line quantity information orderProduct: type: object properties: productName: type: string description: Product name of the order description: Product details within order orderedQty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order customerShipToAddress: type: object properties: address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string name: type: object properties: completeName: type: string firstName: type: string lastName: type: string description: Customer name details description: Customer shipping address description: order lines details description: Order details CustomerOrderDetailsResponseWrapperDTO: type: object properties: status: type: string description: status header: type: object properties: headerAttributes: type: object properties: martId: type: string description: martId passed in header buId: type: string description: buId passed in header pageCount: type: integer description: page count of the orders available with given filters format: int32 totalCount: type: integer description: total count of orders available with given filters format: int32 description: Header attributes description: Meta data of the response payload: type: array description: Order details items: type: object properties: orderChannelId: type: string description: orderChannelId of the order sellerOrderId: type: string description: sellerOrderId of the order orderType: type: string description: order type of the order status: type: string description: status of the order orderDate: type: string description: createDate of the order format: date-time buyerInfo: type: object properties: primaryContact: type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer description: Primary contact of the order description: buyerInfo of the order shipments: type: array description: createDate of the order items: type: object properties: status: type: string description: Shipment status statusDescription: type: string description: Shipment status description purchaseOrderId: type: string description: Shipment purchase Order Id scac: type: string description: Shipment scac trackingNo: type: string description: Shipment tracking number externalTrackingURL: type: string description: Shipment tracking URL shipmentNo: type: string description: Shipment number actualShipmentDate: type: string description: Actual shipment date packageASN: type: string description: Shipment packageASN number carrierDescription: type: string description: Shipment carrier description carrierServiceCode: type: string description: Shipment carrier service code packageId: type: string description: Shipment package Id lastModified: type: string description: Shipment lastModified date shipmentLines: type: array description: Shipment line details items: type: object properties: shipmentLineNo: type: string description: Shipment line number fulfillerLineId: type: string description: Shipment fulfiller LineId quantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Shipment line details shipmentDates: type: array description: Shipment dates items: type: object properties: actualDate: type: string description: Actual delivery date of the order format: date-time dateTypeId: type: string description: Order dateTypeId expectedDate: type: string description: Expected delivery date of the order format: date-time description: Shipment dates description: createDate of the order orderLines: type: array description: order lines details items: type: object properties: fulfillmentType: type: string description: fulfillmentType of the order lastModified: type: string description: Last modified date of the order lines format: date-time shippingMethod: type: string description: Shipping method of the order lines shippingTier: type: string description: Shipping tier of the order lines orderLineQuantityInfo: type: array description: Order line quantity information items: type: object properties: status: type: string description: status of the order line quantity statusDescription: type: string description: status description of the order line quantity statusQuantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Order line quantity information orderProduct: type: object properties: productName: type: string description: Product name of the order description: Product details within order orderedQty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order customerShipToAddress: type: object properties: address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string name: type: object properties: completeName: type: string firstName: type: string lastName: type: string description: Customer name details description: Customer shipping address description: order lines details description: Order details CustomerOrderLineQtyInfo: type: object properties: status: type: string description: status of the order line quantity statusDescription: type: string description: status description of the order line quantity statusQuantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Order line quantity information CustomerOrderLinesDetails: type: object properties: fulfillmentType: type: string description: fulfillmentType of the order lastModified: type: string description: Last modified date of the order lines format: date-time shippingMethod: type: string description: Shipping method of the order lines shippingTier: type: string description: Shipping tier of the order lines orderLineQuantityInfo: type: array description: Order line quantity information items: type: object properties: status: type: string description: status of the order line quantity statusDescription: type: string description: status description of the order line quantity statusQuantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Order line quantity information orderProduct: type: object properties: productName: type: string description: Product name of the order description: Product details within order orderedQty: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order customerShipToAddress: type: object properties: address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string name: type: object properties: completeName: type: string firstName: type: string lastName: type: string description: Customer name details description: Customer shipping address description: order lines details CustomerShipToAddress: type: object properties: address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string name: type: object properties: completeName: type: string firstName: type: string lastName: type: string description: Customer name details description: Customer shipping address Name: type: object properties: completeName: type: string firstName: type: string lastName: type: string description: Customer name details OrderDate: type: object properties: actualDate: type: string description: Actual delivery date of the order format: date-time dateTypeId: type: string description: Order dateTypeId expectedDate: type: string description: Expected delivery date of the order format: date-time description: Shipment dates OrderProduct: type: object properties: productName: type: string description: Product name of the order description: Product details within order PrimaryContactDetails: type: object properties: name: required: - firstName - lastName type: object properties: firstName: maxLength: 64 minLength: 1 type: string description: Customer first name lastName: maxLength: 64 minLength: 1 type: string description: Customer last name description: Name of the Customer description: Primary contact of the order Quantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order Shipment: type: object properties: status: type: string description: Shipment status statusDescription: type: string description: Shipment status description purchaseOrderId: type: string description: Shipment purchase Order Id scac: type: string description: Shipment scac trackingNo: type: string description: Shipment tracking number externalTrackingURL: type: string description: Shipment tracking URL shipmentNo: type: string description: Shipment number actualShipmentDate: type: string description: Actual shipment date packageASN: type: string description: Shipment packageASN number carrierDescription: type: string description: Shipment carrier description carrierServiceCode: type: string description: Shipment carrier service code packageId: type: string description: Shipment package Id lastModified: type: string description: Shipment lastModified date shipmentLines: type: array description: Shipment line details items: type: object properties: shipmentLineNo: type: string description: Shipment line number fulfillerLineId: type: string description: Shipment fulfiller LineId quantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Shipment line details shipmentDates: type: array description: Shipment dates items: type: object properties: actualDate: type: string description: Actual delivery date of the order format: date-time dateTypeId: type: string description: Order dateTypeId expectedDate: type: string description: Expected delivery date of the order format: date-time description: Shipment dates description: createDate of the order ShipmentLine: type: object properties: shipmentLineNo: type: string description: Shipment line number fulfillerLineId: type: string description: Shipment fulfiller LineId quantity: required: - measurementValue - unitOfMeasure type: object properties: unitOfMeasure: type: string description: The unit of measure in the item's weight (e.g., 'EACH' or 'EA') measurementValue: type: number description: The quantity of the unit of measure for the item format: double description: Quantity of the order description: Shipment line details GetInventoryLogsResponsePayload: type: object properties: gtin: type: string description: GTIN vendorSku: type: string description: Vendor SKU productName: type: string description: Product Name inventoryLog: type: array description: Inventory Log records items: type: object properties: id: type: string description: Unique Event Id fcName: type: string description: Fulfillment Center Short Name changedUnits: type: integer description: Number of inventory units changed +/- in FC as a result of this transaction format: int32 transactionTime: type: string description: Timestamp of transaction format: date-time transactionLocation: type: string description: Transaction Location transactionReasonCode: type: string description: Transaction Reason Code transactionReasonDesc: type: string description: Transaction Reason Description transactionType: type: string description: Transaction Type shipmentId: type: string description: Shipment Id description: Inventory Log records description: Payload Section InventoryLog: type: object properties: id: type: string description: Unique Event Id fcName: type: string description: Fulfillment Center Short Name changedUnits: type: integer description: Number of inventory units changed +/- in FC as a result of this transaction format: int32 transactionTime: type: string description: Timestamp of transaction format: date-time transactionLocation: type: string description: Transaction Location transactionReasonCode: type: string description: Transaction Reason Code transactionReasonDesc: type: string description: Transaction Reason Description transactionType: type: string description: Transaction Type shipmentId: type: string description: Shipment Id description: Inventory Log records InventoryLogResponseWrapper: type: object properties: headers: type: object properties: limit: type: integer description: Number of records to be returned format: int32 offset: type: integer description: Number of records you wish to skip before selecting records format: int32 totalCount: type: integer description: Total Count of records this request yields format: int32 description: Headers Section payload: type: object properties: gtin: type: string description: GTIN vendorSku: type: string description: Vendor SKU productName: type: string description: Product Name inventoryLog: type: array description: Inventory Log records items: type: object properties: id: type: string description: Unique Event Id fcName: type: string description: Fulfillment Center Short Name changedUnits: type: integer description: Number of inventory units changed +/- in FC as a result of this transaction format: int32 transactionTime: type: string description: Timestamp of transaction format: date-time transactionLocation: type: string description: Transaction Location transactionReasonCode: type: string description: Transaction Reason Code transactionReasonDesc: type: string description: Transaction Reason Description transactionType: type: string description: Transaction Type shipmentId: type: string description: Shipment Id description: Inventory Log records description: Payload Section PaginationMetadata: type: object properties: limit: type: integer description: Number of records to be returned format: int32 offset: type: integer description: Number of records you wish to skip before selecting records format: int32 totalCount: type: integer description: Total Count of records this request yields format: int32 description: Headers Section GetShipmentPlanDTO: type: object properties: headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 payload: type: array description: response payload items: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying inbound shipment shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller status: type: string description: Current status of the shipment createdDate: type: string description: creation date for shipment format: date-time shipmentUnits: type: integer description: Total number of units in the shipment format: int32 receivedUnits: type: integer description: Total number of units recived in FC for the shipment format: int32 expectedDeliveryDate: type: string description: expected delivery date provided by seller format: date-time updatedExpectedDeliveryDate: type: string description: update expected delivery date based on network capacity format: date-time actualDeliveryDate: type: string description: Actual delivery date of the shipment at FC format: date-time trackingNo: type: array description: Tracking info for the shipment items: type: string description: Tracking info for the shipment carrierName: type: string description: Carrier of the shipment description: response payload Headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 ShipmentPlanDetails: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying inbound shipment shipToAddress: type: object properties: fcName: type: string description: Facility name addressLine1: type: string description: 'Address details ' addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: The address to which sellers need to inbound items returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller status: type: string description: Current status of the shipment createdDate: type: string description: creation date for shipment format: date-time shipmentUnits: type: integer description: Total number of units in the shipment format: int32 receivedUnits: type: integer description: Total number of units recived in FC for the shipment format: int32 expectedDeliveryDate: type: string description: expected delivery date provided by seller format: date-time updatedExpectedDeliveryDate: type: string description: update expected delivery date based on network capacity format: date-time actualDeliveryDate: type: string description: Actual delivery date of the shipment at FC format: date-time trackingNo: type: array description: Tracking info for the shipment items: type: string description: Tracking info for the shipment carrierName: type: string description: Carrier of the shipment description: response payload GetShipmentItemsDTO: type: object properties: headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 payload: type: array description: response payload items: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying each shipment gtin: type: string description: Item barcode sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: type: integer description: Total number of sellable units format: int32 vendorPackQty: type: integer description: Total number of cases format: int32 innerPackQty: type: integer description: Total number of sellable units per case format: int32 receivedQty: type: integer description: Qty received in FC format: int32 damagedQty: type: integer description: Qty damaged while receiving in FC format: int32 fillRate: type: number description: Fill rate for this shipment item format: float expectedDeliveryDate: type: string description: expected delivery date provided by seller format: date-time updatedExpectedDeliveryDate: type: string description: update expected delivery date based on network capacity format: date-time shipNodeName: type: string description: FC name description: response payload ShipmentItemDetails: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment request shipmentId: type: string description: Unique ID identifying each shipment gtin: type: string description: Item barcode sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: type: integer description: Total number of sellable units format: int32 vendorPackQty: type: integer description: Total number of cases format: int32 innerPackQty: type: integer description: Total number of sellable units per case format: int32 receivedQty: type: integer description: Qty received in FC format: int32 damagedQty: type: integer description: Qty damaged while receiving in FC format: int32 fillRate: type: number description: Fill rate for this shipment item format: float expectedDeliveryDate: type: string description: expected delivery date provided by seller format: date-time updatedExpectedDeliveryDate: type: string description: update expected delivery date based on network capacity format: date-time shipNodeName: type: string description: FC name description: response payload InboundShipmentErrorResponseWrapperDTO: type: object properties: headers: type: object properties: totalCount: type: integer description: total number of POs for provided GET request. format: int32 limit: type: integer description: provided limit value in the request format: int32 offset: type: integer description: provided offset value in the request. format: int32 payload: type: array description: response payload items: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment requests createdDate: type: string description: created date for the request format: date-time returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: type: array description: inbound shipment request line items items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items errors: type: array description: Error in inbound shipment creation 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 xml: name: Error description: response payload InboundShipmentErrorsResponseWrapper: type: object properties: inboundOrderId: type: string description: Unique ID identifying inbound shipment requests createdDate: type: string description: created date for the request format: date-time returnAddress: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string description: Address details addressLine2: type: string description: Address details continuation city: type: string description: City name stateCode: type: string description: State Code countryCode: type: string description: Country code postalCode: type: string description: Zip code description: return address of seller orderItems: type: array description: inbound shipment request line items items: required: - expectedDeliveryDate - innerPackQty - itemDesc - itemQty - productId - productType - sku - vendorPackQty type: object properties: productId: type: string description: Unique ID identifying product productType: type: string description: Supported product types are GTIN sku: type: string description: Seller Item ID itemDesc: type: string description: Item description itemQty: minimum: 1 type: integer description: Total number of sellable units format: int32 vendorPackQty: minimum: 1 type: integer description: Total number of cases format: int32 innerPackQty: minimum: 1 type: integer description: Total number of sellable units per case format: int32 expectedDeliveryDate: type: string description: expected delivery date for shipment format: date-time addOnServices: type: array description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed xml: wrapped: true items: type: string description: Indicate whether add-on services (e.g. item labeling or poly bagging) are needed itemNbr: type: integer format: int32 dimensions: type: array items: type: number format: float itemWeightQty: type: number format: float nonSortItem: type: boolean shipNode: type: string description: inbound shipment request line items errors: type: array description: Error in inbound shipment creation 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 xml: name: Error description: response payload GetRateQuoteInfoResponseWrapper: type: object properties: shipmentId: type: string quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time quoteCreationDate: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string rateQuote: type: object properties: quoteId: type: string estimatedDeliveryDateTime: type: string format: date-time carrier: type: object properties: carrierId: type: string carrierName: type: string currency: type: string discountCharge: type: number format: float netCharge: type: number format: float surchargeType: type: string surchargeValue: type: string totalBillingWeight: type: number format: float status: type: string transitDays: type: string effectiveDate: type: string format: date-time expiryDate: type: string format: date-time mode: type: string sellerFreightClassCode: type: string freightCharge: type: number format: float fuelCharge: type: number format: float totalWeight: type: number format: float totalVolume: type: number format: float equipmentTypeCode: type: string serviceCode: type: string numberOfPallets: type: integer format: int32 nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float minimumCharge: type: number format: float declaredValue: type: string mixedSKUs: type: integer format: int32 singleSKUs: type: integer format: int32 freightReadyDate: type: string format: date-time shipmentPackages: type: array items: required: - height - length - lengthUOM - packageSequenceNumber - weight - weightUOM - width type: object properties: packageSequenceNumber: type: integer format: int32 weight: minimum: -1 type: number format: float weightUOM: type: string length: minimum: -1 type: number format: float height: minimum: -1 type: number format: float width: minimum: -1 type: number format: float lengthUOM: type: string labelInformation: type: object properties: labelData: type: string labelFormat: type: string trackingCode: type: string referenceTrackingCode: type: string epTrackerId: type: string shipmentId: type: string packageAsn: type: string masterTrackingCode: type: string master: type: boolean billingWeight: type: number format: float netCharge: type: number format: float nominalCharge: type: number format: float assessorialCharge: type: number format: float serviceCharge: type: number format: float packageType: type: string noOfPackages: type: integer format: int32 stackable: type: boolean originLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string destinationLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string locationId: type: string returnLocation: required: - address - locationName type: object properties: locationName: type: string address: required: - addressLine1 - city - countryCode - postalCode - stateCode type: object properties: addressLine1: type: string addressLine2: type: string city: type: string stateCode: type: string countryCode: type: string postalCode: type: string phone: type: string 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: Fulfillment