Walmart Marketplace Prices API
The price is a fundamental building block for your listing on Walmart.com. You can use the price management APIs to set up and manage the price for a given item.
OpenAPI Specification
openapi: 3.0.1
info:
title: Walmart Price Management
description: The price is a fundamental building block for your listing on Walmart.com. You can use the price management APIs to set up and manage the price for a given item
servers:
- url: https://marketplace.walmartapis.com
description: Production URL
- url: https://sandbox.walmartapis.com
description: Sandbox URL
security:
- basicScheme: []
paths:
"/v3/repricer/strategy/{strategyCollectionId}":
put:
tags:
- Prices
summary: Walmart Update Repricer Strategy
description: Updates the existing strategy
operationId: updateStrategy
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: The request body will have the strategy related information
content:
application/json:
schema:
type: object
properties:
repricerStrategy:
type: string
description: Name of the Strategy Collection
example: Buy Box Strategy For testing
enabled:
type: boolean
description: Status of the Strategy Collection
example: true
enableRepricerForPromotion:
type: boolean
description: Status of item on promotions to be enable on repricer
example: true
restoreSellerPriceWithoutTarget:
type: boolean
description: Reprice back to last submitted price
example: true
strategies:
type: array
description: Strategies
items:
type: object
properties:
strategyType:
type: string
enum:
- Buy Box Price
- External Price
- Competitive Price
adjustmentType:
type: string
enum:
- UNIT
- PERCENTAGE
adjustmentValue:
type: number
format: double
example: 1.2
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
repricerStrategy:
type: string
example: Buy Box Strategy For testing
strategyCollectionId:
type: string
example: 41678999-a088-4fd8-9eb4-55f8d8ed4ac8
enabled:
type: boolean
example: true
enableRepricerForPromotion:
type: boolean
example: true
restoreSellerPriceWithoutTarget:
type: boolean
example: true
strategies:
type: array
items:
type: object
properties:
strategyType:
type: string
enum:
- Buy Box Price
- External Price
- Competitive Price
adjustmentType:
type: string
enum:
- UNIT
- PERCENTAGE
adjustmentValue:
type: number
format: double
example: 1.2
delete:
tags:
- Prices
summary: Walmart Delete Repricer Strategy
description: Deletes the strategy
operationId: deleteStrategy
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: 'Strategy with Strategy Collection Id : 41678999-a088-4fd8-9eb4-55f8d8ed4ac8 deleted successfully'
"/v3/repricer/incentive":
get:
tags:
- Prices
summary: Walmart List of Incentive Items
description: Get the list of incentive items
operationId: getRepricerIncentive
parameters:
- name: limit
in: query
description: Specify number of items to return.
required: false
schema:
type: integer
format: int32
default: 25
- name: offset
in: query
description: Specify the offset of item list to be returned.
required: false
schema:
type: integer
format: int32
default: 0
- name: sortBy
in: query
description: Specify the sort criteria for items. Examples of the allowed values are INCENTIVE_END_DATE or INCENTIVE_LIMIT
required: false
schema:
type: string
default: INCENTIVE_LIMIT
- name: sortOrder
in: query
description: Specify the sort order for given sort criteria. Examples of the allowed values are ASC or DESC
required: false
schema:
type: string
default: DESC
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
totalItems:
type: integer
format: int32
example: 1
items:
type: array
items:
type: object
properties:
productName:
type: string
example: Ring Defense
skuId:
type: string
example: sku123
sellerPrice:
type: number
format: double
example: 22
floorPrice:
type: number
format: double
example: 14
incentiveLimit:
type: number
format: double
example: 3
incentiveStartDate:
type: string
example: '2023-06-22'
incentiveEndDate:
type: string
example: '2023-07-22'
shippingPrice:
type: number
format: double
example: 0
competitivePrice:
type: number
format: double
example: 21
competitorShippingPrice:
type: number
format: double
example: 1
competitorUrl:
type: string
example: amazon.com/dp/123
put:
tags:
- Prices
summary: Walmart Assign Incentive Items to Repricer
description: Assigns incentive items to the default price incentives strategy, ‘Match Competitive Price’
operationId: updateRepricerIncentive
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
content:
application/json:
schema:
required:
- skus
type: object
properties:
skus:
type: array
description: selected skus
items:
type: string
description: selected skus
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
feedId:
type: string
example: AFEE4EEC9C3541B6A7B58E694416EC82@AUoBAwA
errors:
type: array
items:
type: object
properties:
errorMessage:
type: string
example: SKU XX is not eligible for price incentives and will not be price adjusted
"/v3/price":
put:
tags:
- Prices
summary: Walmart Update a Price
description: Updates the regular price for a given item.
operationId: updatePrice
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: The request body consists of a Feed file attached to the request.
content:
application/json:
schema:
required:
- pricing
- sku
type: object
properties:
offerId:
type: string
description: This is applicable only for promotions
sku:
type: string
replaceAll:
type: string
description: This is applicable only for promotions
enum:
- 'true'
- 'false'
pricing:
type: array
items:
required:
- currentPrice
- currentPriceType
type: object
properties:
effectiveDate:
type: string
description: This is applicable only for promotions
format: date-time
expirationDate:
type: string
description: This is applicable only for promotions
format: date-time
promoId:
type: string
description: This is applicable only for promotions
processMode:
type: string
description: This is applicable only for promotions
enum:
- UPSERT
- DELETE
currentPriceType:
type: string
description: This is applicable only for both promotions and price
enum:
- BASE
- REDUCED
- CLEARANCE
currentPrice:
type: object
properties:
currency:
type: string
enum:
- USD
- CAD
amount:
type: number
format: double
comparisonPriceType:
type: string
description: This is applicable only for promotions
enum:
- BASE
comparisonPrice:
type: object
properties:
currency:
type: string
enum:
- USD
- CAD
amount:
type: number
format: double
description: This is applicable only for promotions
priceDisplayCodes:
type: string
description: Represent promo placement. This is applicable only for promotions
enum:
- CART
- CHECKOUT
definitions:
type: object
example:
sku: 97964_KFTest
pricing:
- currentPriceType: BASE
currentPrice:
currency: USD
amount: 10
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
errors:
type: array
xml:
name: error
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
statusCode:
type: integer
format: int32
mart:
type: string
description: 'Marketplace name. Example: Walmart-US'
xml:
namespace: http://walmart.com/
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
xml:
namespace: http://walmart.com/
message:
type: string
description: A message of acknowledgement for a price update
xml:
namespace: http://walmart.com/
xml:
name: ItemPriceResponse
namespace: http://walmart.com/
example:
ItemPriceResponse:
mart: WALMART_US
message: Thank you. Your price has been updated. Please allow up to five minutes for this change to be reflected on the site.
sku: 97964_KFTest
application/xml:
schema:
type: object
properties:
errors:
type: array
xml:
name: error
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
statusCode:
type: integer
format: int32
mart:
type: string
description: 'Marketplace name. Example: Walmart-US'
xml:
namespace: http://walmart.com/
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
xml:
namespace: http://walmart.com/
message:
type: string
description: A message of acknowledgement for a price update
xml:
namespace: http://walmart.com/
xml:
name: ItemPriceResponse
namespace: http://walmart.com/
example: |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:ItemPriceResponse xmlns:ns2="http://walmart.com/">
<ns2:mart>WALMART_US</ns2:mart>
<ns2:sku>97964_KFTest</ns2:sku>
<ns2:message>Thank you. Your price has been updated. Please allow up to five minutes for this change to be reflected on the site.</ns2:message>
</ns2:ItemPriceResponse>
"/v3/repricerFeeds":
post:
tags:
- Prices
summary: Walmart Assign/unassign Items To/from Repricer Strategy
description: Add/Remove one or more items from a strategy
operationId: getRepricerFeed
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
content:
application/json:
schema:
type: object
properties:
ItemFeedHeader:
type: object
properties:
processMode:
type: string
example: REPLACE
subset:
type: string
example: EXTERNAL
mart:
type: string
example: WALMART_US
sellingChannel:
type: string
example: repricerstrategy
version:
type: string
example: '1.1'
locale:
type: string
example: en
Item:
type: array
items:
type: object
properties:
Strategy:
type: object
properties:
sku:
type: string
example: '06068064605122shoe'
repricerStrategy:
type: string
example: Match Competitive Price
minimumSellerAllowedPrice:
type: number
format: double
example: 7.2
maximumSellerAllowedPrice:
type: number
format: double
example: 8
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
feedId:
type: string
example: AFEE4EEC9C3541B6A7B58E694416EC82@AUoBAwA
"/v3/repricer/strategy":
post:
tags:
- Prices
summary: Walmart Create Repricer Strategy
description: Creates a new strategy for the seller
operationId: createStrategy
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: The request body will have the strategy related information
content:
application/json:
schema:
type: object
properties:
repricerStrategy:
type: string
description: Name of the Strategy Collection
example: Buy Box Strategy For testing
enabled:
type: boolean
description: Status of the Strategy Collection
example: true
enableRepricerForPromotion:
type: boolean
description: Status of item on promotions to be enable on repricer
example: true
restoreSellerPriceWithoutTarget:
type: boolean
description: Reprice back to last submitted price
example: true
strategies:
type: array
description: Strategies
items:
type: object
properties:
strategyType:
type: string
enum:
- Buy Box Price
- External Price
- Competitive Price
adjustmentType:
type: string
enum:
- UNIT
- PERCENTAGE
adjustmentValue:
type: number
format: double
example: 1.2
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
repricerStrategy:
type: string
example: Buy Box Strategy For testing
strategyCollectionId:
type: string
example: 41678999-a088-4fd8-9eb4-55f
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/walmart/refs/heads/main/openapi/walmart-marketplace-prices-openapi-original.yml