Walmart
Walmart Ship with Walmart API

The Ship with Walmart API from Walmart — 7 operation(s) for ship with walmart.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: Walmart Cost Management Assortment Recommendations Ship with Walmart API
  description: 'This API allows drop ship vendor (DSV) users to update cost for items in bulk.


    **May 2024**<br>Built: 05/09/2024, 13:05:34

    '
  version: '1.0'
servers:
- url: https://api-gateway.walmart.com
  description: Production URL
- url: https://sandbox.walmartapis.com
  description: Sandbox URL
tags:
- name: Ship with Walmart
paths:
  /v3/shipping/labels:
    post:
      tags:
      - Ship with Walmart
      summary: Walmart Create Label
      description: "This API generates shipping labels with the shipment info passed. The response to a successful call contains the tracking number with the pdf or image type based on the media type passed in Accept header.\nFor eg. 'Accept'='application/json,application/pdf' will result in pdf media type, \n'Accept'='application/json,image/png' as image png media type and 'Accept'='application/json' as json response. Refer request sample4 for India(IN) to United-States(US) shipping"
      operationId: createLabel
      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: Label fields
        content:
          application/json:
            schema:
              required:
              - boxDimensions
              - boxItems
              - carrierName
              - carrierServiceType
              - packageType
              - purchaseOrderId
              type: object
              properties:
                packageType:
                  type: string
                  description: Package Type. This value maps to 'packageTypeShortName' from Supported carrier package types API response.
                boxDimensions:
                  required:
                  - boxWeight
                  - boxWeightUnit
                  type: object
                  properties:
                    boxLength:
                      minimum: 0
                      type: number
                    boxWidth:
                      minimum: 0
                      type: number
                    boxHeight:
                      minimum: 0
                      type: number
                    boxWeight:
                      type: number
                    boxDimensionUnit:
                      type: string
                      enum:
                      - IN
                      - FT
                      - CM
                    boxWeightUnit:
                      type: string
                      enum:
                      - LB
                      - KG
                      - OZ
                boxItems:
                  type: array
                  description: Box Items
                  items:
                    required:
                    - lineNumber
                    - quantity
                    - sku
                    type: object
                    properties:
                      sku:
                        type: string
                        description: sku of an item
                      quantity:
                        type: integer
                        description: Quantity of Item
                        format: int32
                      lineNumber:
                        type: string
                        description: PO Line Number
                      productName:
                        type: string
                        description: Name of the Product. This is a mandatory field if carrier is opted as 'Yanwen' and also for India(IN) to United-States(US) shipping
                      productNameInLocale:
                        type: string
                        description: Name of the Product in Mandarin. This is a mandatory field if carrier is opted as 'Yanwen'
                      hsCode:
                        type: string
                        description: HS Code. This is a mandatory field for India(IN) to United-States(US) shipping
                      originState:
                        type: string
                        description: Origin State. This is a mandatory field for India(IN) to United-States(US) shipping
                      originCity:
                        type: string
                        description: Origin City. This is a mandatory field for India(IN) to United-States(US) shipping
                      countryOfOrigin:
                        type: string
                        description: Country of Origin. This is a mandatory field for India(IN) to United-States(US) shipping
                    description: Box Items
                fromAddress:
                  required:
                  - addressLine1
                  - city
                  - contactName
                  - country
                  - phone
                  - postalCode
                  - state
                  type: object
                  properties:
                    contactName:
                      type: string
                      description: Contact name
                    companyName:
                      type: string
                      description: Company name
                    addressLine1:
                      type: string
                      description: Address Line 1
                    addressLine2:
                      type: string
                      description: Address Line 2
                    city:
                      type: string
                      description: city
                    state:
                      type: string
                      description: state
                    postalCode:
                      type: string
                      description: postal code
                    country:
                      type: string
                      description: country
                    phone:
                      type: string
                      description: phone
                    email:
                      type: string
                      description: email
                  description: From Address
                purchaseOrderId:
                  type: string
                  description: Purchase Order Id
                carrierName:
                  type: string
                  description: Carrier Name. This value maps to 'shortName' from Supported carriers API response. Currently FedEx and USPS are supported carriers.
                carrierServiceType:
                  type: string
                  description: Carrier Service Type. This value maps to 'serviceTypes.name' from Shipping Estimates API response
                addOns:
                  type: array
                  description: AddOns Type. AddOns can be opted during label generation for a shipping. Supported values for AddOns are INSURANCE and SIGNATURE. We support standard SIGNATURE Type for now.
                  items:
                    type: string
                    description: AddOns Type. AddOns can be opted during label generation for a shipping. Supported values for AddOns are INSURANCE and SIGNATURE. We support standard SIGNATURE Type for now.
                    enum:
                    - SIGNATURE
                    - INSURANCE
                returnAddress:
                  required:
                  - addressLine1
                  - city
                  - contactName
                  - country
                  - phone
                  - postalCode
                  - state
                  type: object
                  properties:
                    contactName:
                      type: string
                      description: Contact name
                    addressLine1:
                      type: string
                      description: Address Line 1
                    addressLine2:
                      type: string
                      description: Address Line 2
                    city:
                      type: string
                      description: city
                    state:
                      type: string
                      description: state
                    postalCode:
                      type: string
                      description: postal code
                    country:
                      type: string
                      description: country
                    phone:
                      type: string
                      description: phone
                    email:
                      type: string
                      description: email
                    shipNode:
                      type: string
                      description: ship Node
                  description: Return Address. This is only mandatory field for yanwen
                hasBattery:
                  type: boolean
                  description: hasBattery flag. Pass 'true' if the shipment consists of battery. This is a mandatory field for yanwen.
                hazmat:
                  type: boolean
                  description: hazmat flag. Pass 'true' if the shipment consists of hazardous material.
            examples:
              sample1:
                value:
                  packageType: CUSTOM_PACKAGE
                  boxDimensions:
                    boxDimensionUnit: IN
                    boxWeightUnit: LB
                    boxWeight: 13
                    boxLength: 13
                    boxWidth: 9
                    boxHeight: 0
                  boxItems:
                  - lineNumber: '1'
                    sku: PRECISE3PGLASS9
                    quantity: 1
                  fromAddress:
                    contactName: Test Seller
                    companyName: Test Company
                    addressLine1: Add1
                    addressLine2: Add2
                    city: Anchorage
                    state: AK
                    postalCode: '99501'
                    country: US
                    phone: '12253'
                    email: test@walmart.com
                  purchaseOrderId: '97108719025934786'
                  carrierName: FedEx
                  carrierServiceType: FEDEX_2_DAY
                  hazmat: true
              sample2:
                value:
                  packageType: CUSTOM_PACKAGE
                  boxDimensions:
                    boxDimensionUnit: IN
                    boxWeightUnit: LB
                    boxWeight: 13
                    boxLength: 13
                    boxWidth: 9
                    boxHeight: 0
                  boxItems:
                  - lineNumber: '1'
                    sku: PRECISE3PGLASS9
                    quantity: 1
                  fromAddress:
                    contactName: Test Seller
                    companyName: Test Company
                    addressLine1: Add1
                    addressLine2: Add2
                    city: Anchorage
                    state: AK
                    postalCode: '99501'
                    country: US
                    phone: '12253'
                    email: test@walmart.com
                  addOns:
                  - INSURANCE
                  - SIGNATURE
                  purchaseOrderId: '97108719025934786'
                  carrierName: FedEx
                  carrierServiceType: FEDEX_2_DAY
              sample3:
                value:
                  packageType: CUSTOM_PACKAGE
                  boxDimensions:
                    boxDimensionUnit: IN
                    boxWeightUnit: LB
                    boxWeight: 13
                    boxLength: 13
                    boxWidth: 9
                    boxHeight: 0
                  boxItems:
                  - lineNumber: '1'
                    sku: PRECISE3PGLASS9
                    quantity: 1
                    productName: racket
                    productNameInLocale: 读写汉字
                  fromAddress:
                    contactName: Test Seller
                    companyName: Test Company
                    addressLine1: Add1
                    addressLine2: Add2
                    city: guangZhouShi
                    state: GD
                    postalCode: '510599'
                    country: CN
                    phone: '12253'
                    email: test@walmart.com
                  returnAddress:
                    contactName: 深圳市市盛天育科区游乡寺 - 10001223622 - MP
                    addressLine1: 福田区石峡新田世纪商务中心B座36楼11室
                    city: 深圳
                    state: 系列
                    postalCode: '581000'
                    country: CN
                    phone: '9087654589'
                    email: sfsorderbatching@gmail.com
                    shipNode: '765476571'
                  purchaseOrderId: '97108719025934786'
                  carrierName: Yanwen
                  carrierServiceType: YANWEN_EXPRESS
                  hasBattery: true
              sample4:
                value:
                  packageType: CUSTOM_PACKAGE
                  boxDimensions:
                    boxDimensionUnit: IN
                    boxWeightUnit: KG
                    boxWeight: 13
                    boxLength: 13
                    boxWidth: 9
                    boxHeight: 0
                  boxItems:
                  - lineNumber: '1'
                    sku: SKUWfs6055469496189
                    quantity: 1
                    productName: Boys tshirt
                    hsCode: '12332412'
                    originState: Delhi
                    originCity: Delhi
                    countryOfOrigin: IN
                  fromAddress:
                    contactName: Test Seller
                    companyName: Test Company
                    addressLine1: Add1
                    addressLine2: Add2
                    city: Bangalore
                    state: Karanataka
                    postalCode: '560100'
                    country: IN
                    phone: '2074193432'
                    email: test@walmart.com
                  purchaseOrderId: '108913539040341'
                  carrierName: FedEx
                  carrierServiceType: FEDEX_INTERNATIONAL_PRIORITY
                  hazmat: false
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      purchaseOrderId:
                        type: string
                        description: 'Purchase Order Id '
                      trackingNo:
                        type: string
                        description: Tracking Number
                      boxItems:
                        type: array
                        description: Box Items
                        items:
                          required:
                          - lineNumber
                          - quantity
                          - sku
                          type: object
                          properties:
                            sku:
                              type: string
                              description: sku of an item
                            quantity:
                              type: integer
                              description: Quantity of Item
                              format: int32
                            lineNumber:
                              type: string
                              description: PO Line Number
                            productName:
                              type: string
                              description: Name of the Product. This is a mandatory field if carrier is opted as 'Yanwen' and also for India(IN) to United-States(US) shipping
                            productNameInLocale:
                              type: string
                              description: Name of the Product in Mandarin. This is a mandatory field if carrier is opted as 'Yanwen'
                            hsCode:
                              type: string
                              description: HS Code. This is a mandatory field for India(IN) to United-States(US) shipping
                            originState:
                              type: string
                              description: Origin State. This is a mandatory field for India(IN) to United-States(US) shipping
                            originCity:
                              type: string
                              description: Origin City. This is a mandatory field for India(IN) to United-States(US) shipping
                            countryOfOrigin:
                              type: string
                              description: Country of Origin. This is a mandatory field for India(IN) to United-States(US) shipping
                          description: Box Items
                      carrierName:
                        type: string
                        description: Carrier Short Name
                      carrierFullName:
                        type: string
                        description: Carrier Full Name
                      carrierServiceType:
                        type: string
                        description: Carrier Service Type
                      trackingUrl:
                        type: string
                        description: Tracking URL
                      addOns:
                        type: array
                        description: Add Ons Response
                        items:
                          required:
                          - charge
                          - name
                          type: object
                          properties:
                            name:
                              type: string
                              description: Name of the AddOn type.
                              enum:
                              - SIGNATURE
                              - INSURANCE
                            charge:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  description: Amount
                                currency:
                                  type: string
                                  description: Currency
                                  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: Charge of AddOn type.
                            declaredValue:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  description: Amount
                                currency:
                                  type: string
                                  description: Currency
                                  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
                   

# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/walmart/refs/heads/main/openapi/walmart-ship-with-walmart-api-openapi.yml
Walmart Ship with Walmart API

Documentation

Specifications

Other Resources

OpenAPI Specification
