openapi: 3.0.1 info: title: Walmart Ship With Walmart description: The Ship With Walmart (SWW) APIs enables walmart.com sellers to buy shipping at competitively discounted rates directly from Walmart to ship their goods to US customers. servers: - url: https://marketplace.walmartapis.com description: Production URL - url: https://sandbox.walmartapis.com description: Sandbox URL security: - basicScheme: [] 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors examples: sample1: value: data: purchaseOrderId: '97108719025934786' trackingNo: '10015361751436' boxItems: - sku: PRECISE3PGLASS9 quantity: 1 lineNumber: '1' carrierName: FedEx carrierFullName: FedEx carrierServiceType: FedEx 2Day trackingUrl: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=10015361751436&locale=en_US&cntry_code=us sample2: value: data: purchaseOrderId: '97108719025934786' trackingNo: '10015361751436' boxItems: - sku: PRECISE3PGLASS9 quantity: 1 lineNumber: '1' carrierName: FedEx carrierFullName: FedEx carrierServiceType: FedEx 2Day trackingUrl: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=10015361751436&locale=en_US&cntry_code=us addOns: - name: INSURANCE charge: amount: 0.32 currency: USD declaredValue: amount: 40 currency: USD refLink: https://docs.google.com/forms/d/e/1FAIpQLSfptruFTsLSkL2T3xi50m3BZn6xFHApbliZqucpIxSYqVXEvA/viewform?pli=1 status: Active - name: SIGNATURE charge: amount: 6.35 currency: USD status: Active application/pdf: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors image/png: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors "/v3/shipping/labels/shipping-estimates": post: tags: - Ship with Walmart summary: Walmart Shipping Estimates description: This API retrieves shipping cost estimates for available shipping services based on address and package (e.g., customer address, packaged weight.) operationId: getShippingEstimate 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: Shipping fields content: application/json: schema: required: - boxDimensions - deliverByDate - fromAddress - packageType - shipByDate - toAddress type: object properties: 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 deliverByDate: type: string description: 'Estimated delivery date. ' shipByDate: type: string description: ShipBy date. fromAddress: required: - addressLines - city - countryCode - postalCode - state type: object properties: postalCode: type: string countryCode: type: string addressLines: type: array description: addressLines items: type: string description: addressLines city: type: string description: city state: type: string description: state description: From Address - Seller's fulfilment center address. toAddress: required: - addressLines - city - countryCode - postalCode - state type: object properties: postalCode: type: string countryCode: type: string addressLines: type: array description: addressLines items: type: string description: addressLines city: type: string description: city state: type: string description: state description: To Address - Customer's Delivery Address carriers: type: array description: Carriers List. This value maps to 'shortName' from All carriers API response.If not provided, it will fetch response for all service types. items: type: string description: Carriers List. This value maps to 'shortName' from All carriers API response.If not provided, it will fetch response for all service types. packageType: type: string description: Package Type. This value maps to 'packageTypeShortName' from All carrier package types API response. includeServicesNotMeetingDeliveryPromise: type: boolean description: Delivery promise date flag. Pass 'false' if only services meeting promised delivery dates needs to be fetched, else 'true' to fetch all supported delivery dates purchaseOrderId: type: string description: Purchase Order Id. This is a mandatory field for India(IN) to United-States(US) shipping. boxItems: type: array description: Box items. This is a mandatory field for India(IN) to United-States(US) shipping 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 description: Box items. This is a mandatory field for India(IN) to United-States(US) shipping addOns: type: boolean description: 'addOns flag. Pass ''true'' to fetch all addOns cost and we support two add ons type: SIGNATURE and INSURANCE. To get Insurance Estimate, please provide purchaseOrderId and boxItems details. By default, The value of addOns will be false.' hasBattery: type: boolean description: hasBattery flag. Pass 'true' if the shipment consists of battery. This is a mandatory field for yanwen. examples: sample1: value: packageType: CUSTOM_PACKAGE purchaseOrderId: '91088062299813853' boxItems: - lineNumber: 1 sku: sku-1NMeZnK1B1MNJdXde5771022 quantity: 1 boxDimensions: boxWeightUnit: LB boxWeight: 0.8 boxLength: 6 boxWidth: 6 boxHeight: 6 boxDimensionUnit: IN shipByDate: '2023-06-05T08:00:00.611Z' deliverByDate: '2023-06-07T23:00:00.611Z' carriers: - FEDEX fromAddress: postalCode: '91776' countryCode: US addressLines: - 311 E VALLEY BLVD STE 112 PMB 271as city: SAN GABRIEL1as state: CA toAddress: postalCode: '94085' countryCode: US addressLines: - 748 N Mathilda Ave - 'Room # 224' city: SUNNYVALE state: CA includeServicesNotMeetingDeliveryPromise: true sample2: value: packageType: CUSTOM_PACKAGE purchaseOrderId: '91088062299813853' boxItems: - lineNumber: 1 sku: sku-1NMeZnK1B1MNJdXde5771022 quantity: 1 boxDimensions: boxWeightUnit: LB boxWeight: 0.8 boxLength: 6 boxWidth: 6 boxHeight: 6 boxDimensionUnit: IN shipByDate: '2023-06-05T08:00:00.611Z' deliverByDate: '2023-06-07T23:00:00.611Z' carriers: - FEDEX fromAddress: postalCode: '91776' countryCode: US addressLines: - 311 E VALLEY BLVD STE 112 PMB 271as city: SAN GABRIEL1as state: CA toAddress: postalCode: '94085' countryCode: US addressLines: - 748 N Mathilda Ave - 'Room # 224' city: SUNNYVALE state: CA addOns: true includeServicesNotMeetingDeliveryPromise: true sample3: value: packageType: CUSTOM_PACKAGE purchaseOrderId: '91088062299813853' boxItems: - lineNumber: 1 sku: sku-1NMeZnK1B1MNJdXde5771022 quantity: 1 boxDimensions: boxWeightUnit: LB boxWeight: 0.8 boxLength: 6 boxWidth: 6 boxHeight: 6 boxDimensionUnit: IN shipByDate: '2023-06-05T08:00:00.611Z' deliverByDate: '2023-06-07T23:00:00.611Z' carriers: - YANWEN fromAddress: postalCode: '510599' countryCode: CN addressLines: - GuSu District PingLong Road 251 Hao city: guangZhouShi state: GD toAddress: postalCode: '94085' countryCode: US addressLines: - 748 N Mathilda Ave - 'Room # 224' city: SUNNYVALE state: CA includeServicesNotMeetingDeliveryPromise: true hasBattery: false required: true responses: '200': description: Successful Operation content: application/json: schema: type: object properties: data: type: object properties: estimates: type: array description: List of estimates items: type: object properties: serviceTypeGroupName: type: string description: Service Type Group Name serviceTypeGroupDisplayName: type: string description: Service Type Group Display Name name: type: string description: Carrier Service Type displayName: type: string description: Carrier Service Type Display Name estimatedRate: type: object properties: amount: type: number currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XFU - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZWL description: Estimated Rate deliveryDate: type: string description: Delivery Date carrierName: type: string description: Carrier Short Name carrierDisplayName: type: string description: Carrier Display Name isDeliveryPromiseFulfilled: type: boolean description: Delivery Promise Fulfilled 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: List of estimates alertMessage: type: string description: Alert message if any issues while fetching estimates for carrier service type description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors examples: sample1: value: data: estimates: - name: PRIORITY_MAIL displayName: USPS Priority Mail deliveryDate: '2023-10-02T23:59:00.000Z' estimatedRate: amount: 7.2 currency: USD serviceTypeGroupName: USPS_DEFAULT serviceTypeGroupDisplayName: Default isDeliveryPromiseFulfilled: false carrierName: USPS carrierDisplayName: USPS - name: FEDEX_GROUND displayName: FedEx US Ground deliveryDate: '2023-09-29T23:59:00.000Z' estimatedRate: amount: 11.87 currency: USD serviceTypeGroupName: FEDEX_GROUND serviceTypeGroupDisplayName: FedEx Ground isDeliveryPromiseFulfilled: false carrierName: FedEx carrierDisplayName: FedEx alertMessage: We are unable to find a shipping service that would meet this delivery date. You may choose one of the other delivery options below but note that you may be responsible for any late deliveries. sample2: value: data: estimates: - name: PRIORITY_MAIL displayName: USPS Priority Mail deliveryDate: '2023-10-02T23:59:00.000Z' estimatedRate: amount: 7.2 currency: USD serviceTypeGroupName: USPS_DEFAULT serviceTypeGroupDisplayName: Default isDeliveryPromiseFulfilled: false carrierName: USPS carrierDisplayName: USPS addOns: - name: INSURANCE charge: amount: 0.33 currency: USD declaredValue: amount: 40 currency: USD - name: FEDEX_GROUND displayName: FedEx US Ground deliveryDate: '2023-09-29T23:59:00.000Z' estimatedRate: amount: 11.87 currency: USD serviceTypeGroupName: FEDEX_GROUND serviceTypeGroupDisplayName: FedEx Ground isDeliveryPromiseFulfilled: false carrierName: FedEx carrierDisplayName: FedEx addOns: - name: INSURANCE charge: amount: 0.33 currency: USD declaredValue: amount: 40 currency: USD - name: SIGNATURE charge: amount: 6.35 currency: USD alertMessage: We are unable to find a shipping service that would meet this delivery date. You may choose one of the other delivery options below but note that you may be responsible for any late deliveries. "/v3/shipping/labels/purchase-orders/{purchaseOrderId}": get: tags: - Ship with Walmart summary: Walmart Labels Detail by Purchase Order Id description: This API retrieves all label details generated for a purchase order id. operationId: getLabel parameters: - name: purchaseOrderId in: path description: purchaseOrderId required: true schema: type: string - in: header name: WM_SEC.ACCESS_TOKEN description: The access token retrieved in the Token API call required: true schema: type: string example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM..... - in: header name: WM_CONSUMER.CHANNEL.TYPE description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding required: false schema: type: string - in: header name: WM_QOS.CORRELATION_ID description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID required: true schema: type: string example: b3261d2d-028a-4ef7-8602-633c23200af6 - in: header name: WM_SVC.NAME description: Walmart Service Name required: true schema: type: string example: Walmart Service Name - in: header name: Accept description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json responses: '200': description: Successful Operation content: application/json: schema: type: object properties: data: type: array description: data items: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors examples: sample1: value: data: - purchaseOrderId: '65108826634074798' trackingNo: '14300153617516' boxItems: - sku: '06068906426236Test' quantity: 1 lineNumber: '1' carrierName: FedEx carrierFullName: FedEx carrierServiceType: FedEx 2Day trackingUrl: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=14300153617516&locale=en_US&cntry_code=us sample2: value: data: - purchaseOrderId: '65108826634074798' trackingNo: '14300153617516' boxItems: - sku: '06068906426236Test' quantity: 1 lineNumber: '1' carrierName: FedEx carrierFullName: FedEx carrierServiceType: FedEx 2Day trackingUrl: https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=14300153617516&locale=en_US&cntry_code=us addOns: - name: INSURANCE charge: amount: 0.32 currency: USD declaredValue: amount: 40 currency: USD refLink: https://docs.google.com/forms/d/e/1FAIpQLSfptruFTsLSkL2T3xi50m3BZn6xFHApbliZqucpIxSYqVXEvA/viewform?pli=1 status: Active - name: SIGNATURE charge: amount: 6.35 currency: USD status: Active "/v3/shipping/labels/carriers": get: tags: - Ship with Walmart summary: Walmart Supported Carriers description: This API retrieves all carriers supported by Ship With Walmart. operationId: getCarriers 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 responses: '200': description: Successful Operation content: application/json: schema: type: object properties: carriers: type: array description: carriers items: type: object properties: carrierId: type: string description: The carried Id shortName: type: string description: The carried short name carrierName: type: string description: The carried name description: carriers errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors example: carriers: - carrierId: '1000' shortName: FedEx carrierName: FedEx "/v3/shipping/labels/carriers/{carrierShortName}/trackings/{trackingNo}": get: tags: - Ship with Walmart summary: Walmart Download Label description: |- This API retrieves label for a carrier & tracking number combination.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. For eg. 'Accept'='application/json,application/pdf' will result in pdf media type and 'Accept'='application/json,image/png' as image media type. operationId: getLabelByTrackingAndCarrier parameters: - name: carrierShortName in: path description: carrierShortName required: true schema: type: string - name: trackingNo in: path description: trackingNo 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 - in: header name: Accept description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json responses: '200': description: Successful Operation content: application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary delete: tags: - Ship with Walmart summary: Walmart Discard Label description: This API marks a generated label as discarded. operationId: discardLabel parameters: - name: carrierShortName in: path description: carrierShortName from getCarriers API required: true schema: type: string - name: trackingNo in: path description: trackingNo 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 - in: header name: Accept description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json responses: '200': description: Successful Operation content: application/json: schema: type: object properties: data: type: boolean description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors example: data: 'true' "/v3/shipping/labels/carriers/{carrierShortName}/trackings/{trackingNo}/CI": get: tags: - Ship with Walmart summary: Walmart Download Commercial Invoice description: "This API retrieves commercialInvoice for a carrier & tracking number combination. This API is applicable only when shipping done from (India)IN to (United-States)US. The response to a successful call contains the commercial invoice in pdf format. \nFor eg. 'Accept'='application/json,application/pdf' will result in pdf media type. " operationId: getCIForCarrierAndTrackingNumber parameters: - name: carrierShortName in: path description: carrierShortName required: true schema: type: string - name: trackingNo in: path description: trackingNo 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 - in: header name: Accept description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json responses: '200': description: Successful Operation content: application/pdf: schema: type: string format: binary "/v3/shipping/labels/carriers/{carrierShortName}/package-types": get: tags: - Ship with Walmart summary: Walmart Supported Carrier Package Types description: This API retrieves all supported package types for the selected carrier. operationId: getCarrierPackageTypes parameters: - name: carrierShortName in: path description: carrierShortName fetched from carrier API response or pass 'ALL' to fetch all package types of supported carriers 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 - in: header name: Accept description: 'Only supported Media Type : application/json' required: true schema: type: string example: application/json responses: '200': description: Successful Operation content: application/json: schema: type: object properties: data: type: array description: data items: type: object properties: id: type: string description: The carrier package Id packageTypeShortName: type: string description: The carrier package short name packageTypeDisplayName: type: string description: The carrier package display name length: type: integer description: The package length format: int32 width: type: integer description: The package width format: int32 height: type: integer description: The package height format: int32 dimensionUnit: type: string description: The package dimension unit description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors example: data: - id: DBF09762-C2B1-4D92-B159-41FC4C7BF3FD packageTypeShortName: CUSTOM_PACKAGE packageTypeDisplayName: Custom Package length: 0 width: 0 height: 0 dimensionUnit: IN - id: A26CFAA3-D3F3-4647-9180-F344A7736996 packageTypeShortName: FEDEX_ENVELOPE packageTypeDisplayName: FedEx Envelope length: 12.5 width: 9.5 height: 0 dimensionUnit: IN - id: 98120D70-7BCB-44BB-9912-F4655CC05A7D packageTypeShortName: FEDEX_PAK packageTypeDisplayName: FedEx Pak length: 12.75 width: 10.25 height: 0 dimensionUnit: IN components: schemas: Address: 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 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 BoxItem: 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 LabelGenerationRequest: 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. 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 AddOnsResponse: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response 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. CommonResponseLabelGenerationResponse: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. ErrorResponse: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors LabelGenerationResponse: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data EstimateShipmentRequestDTO: required: - boxDimensions - deliverByDate - fromAddress - packageType - shipByDate - toAddress type: object properties: 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 deliverByDate: type: string description: 'Estimated delivery date. ' shipByDate: type: string description: ShipBy date. fromAddress: required: - addressLines - city - countryCode - postalCode - state type: object properties: postalCode: type: string countryCode: type: string addressLines: type: array description: addressLines items: type: string description: addressLines city: type: string description: city state: type: string description: state description: From Address - Seller's fulfilment center address. toAddress: required: - addressLines - city - countryCode - postalCode - state type: object properties: postalCode: type: string countryCode: type: string addressLines: type: array description: addressLines items: type: string description: addressLines city: type: string description: city state: type: string description: state description: To Address - Customer's Delivery Address carriers: type: array description: Carriers List. This value maps to 'shortName' from All carriers API response.If not provided, it will fetch response for all service types. items: type: string description: Carriers List. This value maps to 'shortName' from All carriers API response.If not provided, it will fetch response for all service types. packageType: type: string description: Package Type. This value maps to 'packageTypeShortName' from All carrier package types API response. includeServicesNotMeetingDeliveryPromise: type: boolean description: Delivery promise date flag. Pass 'false' if only services meeting promised delivery dates needs to be fetched, else 'true' to fetch all supported delivery dates purchaseOrderId: type: string description: Purchase Order Id. This is a mandatory field for India(IN) to United-States(US) shipping. boxItems: type: array description: Box items. This is a mandatory field for India(IN) to United-States(US) shipping 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 description: Box items. This is a mandatory field for India(IN) to United-States(US) shipping addOns: type: boolean description: 'addOns flag. Pass ''true'' to fetch all addOns cost and we support two add ons type: SIGNATURE and INSURANCE. To get Insurance Estimate, please provide purchaseOrderId and boxItems details. By default, The value of addOns will be false.' hasBattery: type: boolean description: hasBattery flag. Pass 'true' if the shipment consists of battery. This is a mandatory field for yanwen. EstimatesBoxItem: 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 description: Box items. This is a mandatory field for India(IN) to United-States(US) shipping ShipmentLocation: required: - addressLines - city - countryCode - postalCode - state type: object properties: postalCode: type: string countryCode: type: string addressLines: type: array description: addressLines items: type: string description: addressLines city: type: string description: city state: type: string description: state description: From Address - Seller's fulfilment center address. ToShipmentLocation: required: - addressLines - city - countryCode - postalCode - state type: object properties: postalCode: type: string countryCode: type: string addressLines: type: array description: addressLines items: type: string description: addressLines city: type: string description: city state: type: string description: state description: To Address - Customer's Delivery Address CommonResponseEstimateShipmentResponseWrapper: type: object properties: data: type: object properties: estimates: type: array description: List of estimates items: type: object properties: serviceTypeGroupName: type: string description: Service Type Group Name serviceTypeGroupDisplayName: type: string description: Service Type Group Display Name name: type: string description: Carrier Service Type displayName: type: string description: Carrier Service Type Display Name estimatedRate: type: object properties: amount: type: number currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XFU - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZWL description: Estimated Rate deliveryDate: type: string description: Delivery Date carrierName: type: string description: Carrier Short Name carrierDisplayName: type: string description: Carrier Display Name isDeliveryPromiseFulfilled: type: boolean description: Delivery Promise Fulfilled 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: List of estimates alertMessage: type: string description: Alert message if any issues while fetching estimates for carrier service type description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors EstimateShipmentResponse: type: object properties: serviceTypeGroupName: type: string description: Service Type Group Name serviceTypeGroupDisplayName: type: string description: Service Type Group Display Name name: type: string description: Carrier Service Type displayName: type: string description: Carrier Service Type Display Name estimatedRate: type: object properties: amount: type: number currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XFU - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZWL description: Estimated Rate deliveryDate: type: string description: Delivery Date carrierName: type: string description: Carrier Short Name carrierDisplayName: type: string description: Carrier Display Name isDeliveryPromiseFulfilled: type: boolean description: Delivery Promise Fulfilled 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: List of estimates EstimateShipmentResponseWrapper: type: object properties: estimates: type: array description: List of estimates items: type: object properties: serviceTypeGroupName: type: string description: Service Type Group Name serviceTypeGroupDisplayName: type: string description: Service Type Group Display Name name: type: string description: Carrier Service Type displayName: type: string description: Carrier Service Type Display Name estimatedRate: type: object properties: amount: type: number currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XFU - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZWL description: Estimated Rate deliveryDate: type: string description: Delivery Date carrierName: type: string description: Carrier Short Name carrierDisplayName: type: string description: Carrier Display Name isDeliveryPromiseFulfilled: type: boolean description: Delivery Promise Fulfilled 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: List of estimates alertMessage: type: string description: Alert message if any issues while fetching estimates for carrier service type description: data Money: type: object properties: amount: type: number currency: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYR - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XFU - XOF - XPD - XPF - XPT - XTS - XXX - YER - ZAR - ZMK - ZWL description: Estimated Rate CommonResponseListLabelGenerationResponse: type: object properties: data: type: array description: data items: 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 - 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: Declared value of shipment. This value is applicable in case of INSURANCE AddOn Type only. refLink: type: string description: Reference link for AddOn type. status: type: string description: Status for AddOn type. description: Add Ons Response description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors CarrierCommonResponseListCarrierResponse: type: object properties: carriers: type: array description: carriers items: type: object properties: carrierId: type: string description: The carried Id shortName: type: string description: The carried short name carrierName: type: string description: The carried name description: carriers errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors CarrierResponse: type: object properties: carrierId: type: string description: The carried Id shortName: type: string description: The carried short name carrierName: type: string description: The carried name description: carriers CarrierPackageResponse: type: object properties: id: type: string description: The carrier package Id packageTypeShortName: type: string description: The carrier package short name packageTypeDisplayName: type: string description: The carrier package display name length: type: integer description: The package length format: int32 width: type: integer description: The package width format: int32 height: type: integer description: The package height format: int32 dimensionUnit: type: string description: The package dimension unit description: data CommonResponseListCarrierPackageResponse: type: object properties: data: type: array description: data items: type: object properties: id: type: string description: The carrier package Id packageTypeShortName: type: string description: The carrier package short name packageTypeDisplayName: type: string description: The carrier package display name length: type: integer description: The package length format: int32 width: type: integer description: The package width format: int32 height: type: integer description: The package height format: int32 dimensionUnit: type: string description: The package dimension unit description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors CommonResponseBoolean: type: object properties: data: type: boolean description: data errors: type: array description: errors items: type: object properties: info: type: string description: error info code: type: string description: error code field: type: string description: field description: type: string description: error description severity: type: string description: error severity enum: - EMERG - ALERT - CRITICAL - ERROR - WARN category: type: string description: error category enum: - APPLICATION - SERVICE - REQUEST - DATA httpStatus: type: integer description: error http status format: int32 description: errors 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: Ship with Walmart