openapi: 3.0.1
info:
title: Walmart Cost Management Assortment Recommendations Settings API
description: 'This API allows drop ship vendor (DSV) users to update cost for items in bulk.
**May 2024**<br>Built: 05/09/2024, 13:05:34
'
version: '1.0'
servers:
- url: https://api-gateway.walmart.com
description: Production URL
- url: https://sandbox.walmartapis.com
description: Sandbox URL
tags:
- name: Settings
paths:
/v3/settings/shipping/templates/{templateId}:
get:
tags:
- Settings
summary: Walmart Get Shipping Template Details
description: Get Shipping Template Details. Details of CUSTOM, DEFAULT and 3PL-specific (eg. DELIVERR) templates can be retrieved through this API. 3PL will be able to see details of only 3PL-specific templates.
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-settings/#4777
operationId: getShippingTemplateDetails
parameters:
- name: templateId
in: path
description: templateId
required: true
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
required:
- name
- rateModelType
- shippingMethods
- status
- type
type: object
properties:
id:
type: string
description: Shipping Template ID
name:
pattern: ^[A-Za-z0-9\s]+$
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type, should be CUSTOM or 3PL Specific
enum:
- DEFAULT
- CUSTOM
- DELIVERR
rateModelType:
type: string
description: 'This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order'
enum:
- TIERED_PRICING
- PER_SHIPMENT_PRICING
status:
type: string
description: Shipping Template Status, Can be ACTIVE or INACTIVE status
enum:
- ACTIVE
- INACTIVE
shippingMethods:
type: array
description: Array of different ship methods of a Shipping Template
items:
required:
- configurations
- shipMethod
- status
type: object
properties:
shipMethod:
type: string
description: '| Attribute | Description | Data Type |
| ---- | ----------------- | ------- |
| VALUE | All Marketplace Sellers must offer Value shipping to Walmart.com customers for items that can''t ship within expected transit times for standard shipping. | string |
| STANDARD | You are required to offer standard shipping to Walmart.com customers. | string |
| TWO_DAY | If approved for this option, you''ll provide free 2-day shipping to customers and your items will be enabled with the TwoDay delivery tag. | string |
| ONE_DAY | If approved for this option, you can provide free and paid 1-day shipping to customers and your items will be enabled with OneDay delivery. | string |
| FREIGHT | Heavy items which takes 6,7,8,9,10 days. | string |'
enum:
- VALUE
- STANDARD
- THREE_DAY
- TWO_DAY
- ONE_DAY
- FREIGHT
status:
type: string
description: Shipping Method Status, Can be ACTIVE or INACTIVE status
enum:
- ACTIVE
- INACTIVE
configurations:
type: array
description: Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge
items:
required:
- addressTypes
- regions
- transitTime
type: object
properties:
regions:
type: array
description: Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc
items:
required:
- regionCode
type: object
properties:
regionCode:
type: string
regionName:
type: string
subRegions:
type: array
items:
required:
- subRegionCode
type: object
properties:
subRegionCode:
type: string
subRegionName:
type: string
states:
type: array
items:
required:
- stateCode
type: object
properties:
stateCode:
type: string
stateName:
type: string
stateSubregions:
type: array
items:
required:
- stateSubregionCode
type: object
properties:
stateSubregionCode:
type: string
stateSubregionName:
type: string
description: Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc
addressTypes:
type: array
description: Supported address types like PO_BOX STREET MILITARY
items:
type: string
description: Supported address types like PO_BOX STREET MILITARY
enum:
- PO_BOX
- MILITARY
- STREET
transitTime:
type: integer
description: Time in transit
format: int32
perShippingCharge:
required:
- unitOfMeasure
type: object
properties:
unitOfMeasure:
type: string
description: Unit of Measure eg. LB
shippingAndHandling:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: 'The numerical amount for that charge. Example: 9.99'
currency:
type: string
description: 'The type of currency for the charge. Example: USD for US Dollars'
description: Shipping and Handling Charge
chargePerWeight:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: Charge Per weight, value USD
currency:
type: string
description: Currency, eg. USD
description: Per Item Charge
chargePerItem:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: Charge Per Item, value USD
currency:
type: string
description: Currency, eg. USD
description: Per Weight Charge
description: Charge per shipping
tieredShippingCharges:
type: array
description: Tiered Shipping Charges
items:
required:
- maxLimit
- minLimit
type: object
properties:
minLimit:
type: number
description: Minimum Limit
maxLimit:
type: number
description: Maximum Limit
shipCharge:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: Charge Per Item, value USD
currency:
type: string
description: Currency, eg. USD
description: Details of Shipping Charge
description: Tiered Shipping Charges
description: Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge
description: Array of different ship methods of a Shipping Template
createdBy:
type: string
modifiedBy:
type: string
createdDate:
type: number
modifiedDate:
type: number
example:
id: '91235658274476033'
name: Next Day servc test
type: CUSTOM
rateModelType: TIERED_PRICING
status: ACTIVE
shippingMethods:
- shipMethod: VALUE
status: ACTIVE
configurations:
- regions:
- regionCode: C
regionName: 48 State
addressTypes:
- STREET
transitTime: 6
tieredShippingCharges:
- minLimit: 0
maxLimit: -1
shipCharge:
amount: 0
currency: USD
- shipMethod: STANDARD
status: ACTIVE
configurations:
- regions:
- regionCode: C
regionName: 48 State
subRegions:
- subRegionCode: MW
subRegionName: MW
states:
- stateCode: SD
stateName: South Dakota
stateSubregions:
- stateSubregionCode: SD2
stateSubregionName: SD_WEST
- stateSubregionCode: SD1
stateSubregionName: SD_EAST
addressTypes:
- STREET
transitTime: 3
tieredShippingCharges:
- minLimit: 10.06
maxLimit: -1
shipCharge:
amount: 2
currency: USD
- minLimit: 0
maxLimit: 10.05
shipCharge:
amount: 1
currency: USD
createdDate: 1599589180814
modifiedDate: 1599589209694
put:
tags:
- Settings
summary: Walmart Update Shipping Templates
description: Update existing Shipping Template.
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-settings/#3643
operationId: updateShippingTemplates
parameters:
- name: templateId
in: path
description: templateId
required: true
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: Request fields
content:
application/json:
schema:
required:
- name
- rateModelType
- shippingMethods
- status
- type
type: object
properties:
name:
pattern: ^[A-Za-z0-9\s]+$
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type, should be CUSTOM or 3PL Specific
enum:
- DEFAULT
- CUSTOM
- DELIVERR
rateModelType:
type: string
description: 'This is the shipping model type. TIERED_PRICING: This model means that you charge shipping based on the price of the item PER_SHIPMENT_PRICING: This model means that you charge shipping based on the weight of your items (per pound), or you charge shipping based on the number of items purchased in an order'
enum:
- TIERED_PRICING
- PER_SHIPMENT_PRICING
status:
type: string
description: Shipping Template Status, Can be ACTIVE or INACTIVE status
enum:
- ACTIVE
- INACTIVE
shippingMethods:
type: array
description: Array of different ship methods of a Shipping Template
items:
required:
- configurations
- shipMethod
- status
type: object
properties:
shipMethod:
type: string
description: '| Attribute | Description | Data Type |
| ---- | ----------------- | ------- |
| VALUE | All Marketplace Sellers must offer Value shipping to Walmart.com customers for items that can''t ship within expected transit times for standard shipping. | string |
| STANDARD | You are required to offer standard shipping to Walmart.com customers. | string |
| TWO_DAY | If approved for this option, you''ll provide free 2-day shipping to customers and your items will be enabled with the TwoDay delivery tag. | string |
| ONE_DAY | If approved for this option, you can provide free and paid 1-day shipping to customers and your items will be enabled with OneDay delivery. | string |
| FREIGHT | Heavy items which takes 6,7,8,9,10 days. | string |'
enum:
- VALUE
- STANDARD
- THREE_DAY
- TWO_DAY
- ONE_DAY
- FREIGHT
status:
type: string
description: Shipping Method Status, Can be ACTIVE or INACTIVE status
enum:
- ACTIVE
- INACTIVE
configurations:
type: array
description: Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge
items:
required:
- addressTypes
- regions
- transitTime
type: object
properties:
regions:
type: array
description: Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc
items:
required:
- regionCode
type: object
properties:
regionCode:
type: string
regionName:
type: string
subRegions:
type: array
items:
required:
- subRegionCode
type: object
properties:
subRegionCode:
type: string
subRegionName:
type: string
states:
type: array
items:
required:
- stateCode
type: object
properties:
stateCode:
type: string
stateName:
type: string
stateSubregions:
type: array
items:
required:
- stateSubregionCode
type: object
properties:
stateSubregionCode:
type: string
stateSubregionName:
type: string
description: Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc
addressTypes:
type: array
description: Supported address types like PO_BOX STREET MILITARY
items:
type: string
description: Supported address types like PO_BOX STREET MILITARY
enum:
- PO_BOX
- MILITARY
- STREET
transitTime:
type: integer
description: Time in transit
format: int32
perShippingCharge:
required:
- unitOfMeasure
type: object
properties:
unitOfMeasure:
type: string
description: Unit of Measure eg. LB
shippingAndHandling:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: 'The numerical amount for that charge. Example: 9.99'
currency:
type: string
description: 'The type of currency for the charge. Example: USD for US Dollars'
description: Shipping and Handling Charge
chargePerWeight:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: Charge Per weight, value USD
currency:
type: string
description: Currency, eg. USD
description: Per Item Charge
chargePerItem:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: Charge Per Item, value USD
currency:
type: string
description: Currency, eg. USD
description: Per Weight Charge
description: Charge per shipping
tieredShippingCharges:
type: array
description: Tiered Shipping Charges
items:
required:
- maxLimit
- minLimit
type: object
properties:
minLimit:
type: number
description: Minimum Limit
maxLimit:
type: number
description: Maximum Limit
shipCharge:
required:
- amount
- currency
type: object
properties:
amount:
type: number
description: Charge Per Item, value USD
currency:
type: string
description: Currency, eg. USD
description: Details of Shipping Charge
description: Tiered Shipping Charges
description: Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge
description: Array of different ship methods of a Shipping Template
examples:
sample1:
value:
name: Next Day servc test
type: CUSTOM
rateModelType: TIERED_PRICING
status: ACTIVE
shippingMethods:
- shipMethod: VALUE
status: ACTIVE
configurations:
- regions:
- regionCode: C
regionName: 48 State
addressTypes:
- STREET
transitTime: 6
tieredShippingCharges:
- minLimit: 0
maxLimit: -1
shipCharge:
amount: 0
currency: USD
- shipMethod: STANDARD
status: ACTIVE
configurations:
- regions:
- regionCode: C
regionName: 48 State
subRegions:
- subRegionCode: MW
subRegionName: MW
states:
- stateCode: SD
stateName: South Dakota
stateSubregions:
- stateSubregionCode: SD2
stateSubregionName: SD_WEST
- stateSubregionCode: SD1
stateSubregionName: SD_EAST
addressTypes:
- STREET
transitTime: 3
tieredShippingCharges:
- minLimit: 10.06
maxLimit: -1
shipCharge:
amount: 2
currency: USD
- minLimit: 0
maxLimit: 10.05
shipCharge:
amount: 1
currency: USD
sample2:
value:
name: Template 2
type: CUSTOM
rateModelType: PER_SHIPMENT_PRICING
status: ACTIVE
shippingMethods:
- shipMethod: VALUE
status: ACTIVE
configurations:
- regions:
- regionCode: C
regionName: 48 State
addressTypes:
- STREET
transitTime: 6
perShippingCharge:
unitOfMeasure: LB
shippingAndHandling:
amount: 0
currency: USD
chargePerWeight:
amount: 0
currency: USD
- shipMethod: STANDARD
status: ACTIVE
configurations:
- regions:
- regionCode: C
regionName: 48 State
subRegions:
- subRegionCode: NE
subRegionName: NE
# --- truncated at 32 KB (520 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/walmart/refs/heads/main/openapi/walmart-settings-api-openapi.yml