openapi: 3.0.1
info:
title: Walmart Cost Management Assortment Recommendations Insight API
description: 'This API allows drop ship vendor (DSV) users to update cost for items in bulk.
**May 2024**
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: Insight
paths:
/v3/insights/items/listingQuality/items:
post:
tags:
- Insight
summary: Walmart Item Listing Quality Details
description: 'Get each item''s listing quality details including: item quality score, offer score, content score and issues, and item performance.'
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3880
operationId: itemsDetailsForListing
parameters:
- name: limit
in: query
description: Specify number of items to return. If no limit is specified, API returns 200 items by default.
required: false
schema:
type: string
default: '200'
- name: nextCursor
in: query
description: Specify pagination for long list of items.
required: false
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: Request payload
content:
application/json:
schema:
type: object
properties:
query:
type: object
properties:
field:
type: string
description: '| Attribute | Description | Data Type
| --- | ----------- | -------
| title | Product Title | string |
| sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |
| itemId | Specifies the item identifier generated by Walmart | string |'
enum:
- title
- sku
- itemId
value:
type: string
filters:
type: array
items:
type: object
properties:
field:
type: string
description: '| Attribute | Description | Data Type
| --- | ----------- | -------
| contentDiscoverabilityPercentage | Item''s content and discoverability score expressed as a percentage. | string |
| qualityScorePercentage | Item''s overall Listing Quality score, rated as a percentage. | string |
| offerPercentage | Item''s offer score, based on: item price, shipping price and speed, and in-stock rate.| string |
| ratingReviewsPercentage | Rating and reviews score, as a percentage. | string |
| viewTrendingItems | Indicates to return details for trending items that have non-zero page views. Acceptable values are "true" if pageView > 0, or "false" if pageView >= 0. | string |
| viewPostPurchaseItems | Show items with post-purchase quality issues. If item has post-purchase value >= 1, it filters all items greater or equal based on post purchase value. | string |
| wfsFlag | Show WFS-eligible items. Value of this parameter can be true or false. | string |
| categoryName | Item''s category name. | string |
| hasIssues | Provides a count of item with issues. | integer |
| productType | Product type to classify the item (e.g. Pants). | string|
| attributeList | List of all available filter attributes. | string |
| productTypes | List of all available product. | List |
| brandList | List of all available brand. | List |
| oos | Filter using out of stock offer based on days. Min value = 0, Max Value = 7. | integer |
| fastAndFreeShipping | Possible values are 1 for offers eligible for free shipping and 0 for offers not eligible for free shipping. No value shows all the offers. | integer |
| priceMeetBeatFlag | Possible values are -1 for no match, 0 for lose, 1 for meets and 2 for beats. No value shows all the offers. | integer |
| conditionList | Specifies the condition of the item. Can take values (New, New without box, New without tags, Restored Premium, Restored, Remanufactured, Open Box, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, New with defects) | List'
enum:
- contentDiscoverabilityPercentage
- qualityScorePercentage
- offerPercentage
- ratingReviewsPercentage
- viewTrendingItems
- viewPostPurchaseItems
- wfsFlag
- categoryName
- hasIssues
- productType
- attributeList
- productTypes
- brandList
- oos
- fastAndFreeShipping
- priceMeetBeatFlag
- conditionList
op:
type: string
enum:
- equals
- between
values:
type: array
items:
type: integer
format: int32
examples:
Query for SKU:
value:
query:
field: sku
value: WB 433KP412-12
Filter for quality score %:
value:
filters:
- field: qualityScorePercentage
op: between
values:
- 10
- 50
Filter for productType:
value:
filters:
- field: viewPostPurchaseItems
op: equals
values:
- 0
- field: productType
op: equals
values:
- Music
Filter for condition:
value:
filters:
- field: conditionList
op: equals
values:
- New
- New without tags
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
nextCursor:
type: string
totalItems:
type: string
payload:
type: array
items:
type: object
properties:
productId:
type: string
scoreDetails:
type: object
properties:
offer:
type: object
properties:
issueCount:
type: integer
format: int32
price:
type: object
properties:
amount:
type: string
description: The numerical value of the price
currency:
type: string
description: The currency type
shippingSpeed:
type: object
properties:
shippingType:
type: string
issueTitle:
type: string
issueDesc:
type: string
score:
type: integer
format: int32
publishAndTransactable:
type: object
properties:
issueTitle:
type: string
totalIssue:
type: integer
format: int32
maxIssue:
type: integer
format: int32
issues:
type: array
items:
type: object
properties:
date:
type: string
publishFlag:
type: boolean
transactableFlag:
type: boolean
score:
type: integer
format: int32
ratingReviews:
type: object
properties:
maxRating:
type: string
ratingCount:
type: string
postPurchase:
type: object
properties:
cancellations:
type: object
properties:
defectedOrder:
type: integer
format: int32
totalOrder:
type: integer
format: int32
rate:
type: integer
format: int32
returns:
type: object
issueCount:
type: string
otd:
type: object
properties:
defectedOrder:
type: integer
format: int32
totalOrder:
type: integer
format: int32
rate:
type: integer
format: int32
contentAndDiscoverability:
type: object
properties:
issueCount:
type: integer
format: int32
issues:
type: array
items:
type: object
properties:
score:
type: number
format: double
isEditable:
type: boolean
attributeValue:
type: string
isSpecAttribute:
type: boolean
attributeName:
type: string
issueCount:
type: integer
format: int32
issues:
type: array
items:
type: object
properties:
title:
type: string
value:
type: string
wfsEnabled:
type: string
priority:
type: string
productName:
type: string
itemId:
type: string
sellerId:
type: string
pageViews:
type: string
stats:
type: object
properties:
gmv:
type: object
properties:
amount:
type: string
currency:
type: string
pageViews:
type: string
orders:
type: string
conversionRate:
type: string
totalUnits:
type: string
imageUrL:
type: string
qualityScore:
type: object
properties:
score:
type: number
format: double
values:
type: array
items:
type: object
properties:
scoreType:
type: string
scoreValue:
type: integer
format: int32
impact:
type: string
offerId:
type: string
sku:
type: string
category:
type: string
postPurchaseIssues:
type: string
productType:
type: string
condition:
type: string
status:
type: string
examples:
Query for SKU:
value:
nextCursor: AoIFQC8AAAAAAAAATQwRUM0RUVGQTRCODRCNUE5NjE2QjNEMUFGNUNDNUNC
totalItems: 1
payload:
- qualityScoreData:
score: 15.5
values:
- impact: MEDIUM
scoreType: content & Discoverability
scoreValue: 62
- impact: HIGH
scoreType: offer
scoreValue: 0
- impact: MEDIUM
scoreType: Rating & Reviews
scoreValue: 0
productId: 3F82A2A8W0DJ
scoreDetails:
offer:
shippingSpeed:
score: 0
issueDesc: Please consider providing free ThreeDay Shipping (enable through Shipping Templates) or TwoDay Shipping for customers
issueTitle: Consider Faster Shipping
shippingType: Value
price:
score: null
walmartShipping: 0
additionalDes: null
competitorShipping: 0
competitorPrice:
amount: 34.95
currency: USD
price:
amount: 36.29
currency: USD
issueTitle: Price Not Competitive
asin: B00PDHPL5Y
publishAndTransactable:
score: 0
issueTitle: Issue Detected
maxIssue: 7
totalIssue: 7
issues:
- date: '2021-05-18'
transactableFlag: false
publishFlag: true
- date: '2021-05-17'
transactableFlag: false
publishFlag: true
- date: '2021-05-16'
transactableFlag: false
publishFlag: true
- date: '2021-05-15'
transactableFlag: false
publishFlag: true
- date: '2021-05-14'
transactableFlag: false
publishFlag: true
- date: '2021-05-13'
transactableFlag: false
publishFlag: true
- date: '2021-05-12'
transactableFlag: false
publishFlag: true
issueCount: 9
contentAndDiscoverability:
issueCount: 12
issues:
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: capacity
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 100
isEditable: true
attributeValue: Plastic
isSpecAttribute: false
attributeName: material
issueCount: 0
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: manufacturer_part_number
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 99.9
isEditable: true
attributeValue: Oasis Supply
isSpecAttribute: true
attributeName: brand
issueCount: 0
- score: 100
isEditable: true
attributeValue: New
isSpecAttribute: false
attributeName: condition
issueCount: 0
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: color
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 100
isEditable: true
attributeValue: 00616450784447
isSpecAttribute: false
attributeName: gtin
issueCount: 0
- score: 100
isEditable: true
attributeValue: '12'
isSpecAttribute: false
attributeName: package_quantity
issueCount: 0
- score: 100
isEditable: false
attributeValue: Multi use
isSpecAttribute: false
attributeName: recommended_use
issueCount: 0
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: food_storage_jar_and_container_type
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 45
isEditable: true
attributeValue: 'Dimensions: length: 12.5" - width: 9 1/2"Base width at highest point: 2 3/8"Base width at lowest point: 2" - total compartment height: 3 1/2"Compartment top diameter: 2 1/4" - compartment bottom diameter: 2"High dome. Crystal clear ,12 per order'
isSpecAttribute: true
attributeName: product_long_description
issueCount: 1
issues:
- title: NOT_ENOUGH_BULLET_POINTS
value: This description includes 0 key feature bullets, while it should contain 5 or more. Please include more key features.
- score: 0
isEditable: true
isSpecAttribute: true
attributeName: number_of_pieces
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 71.4
isEditable: true
attributeValue: Oasis Supply 12-Compartment Hinged High Dome Clear Cupcake Container, Clear, 12-Pack
isSpecAttribute: true
attributeName: product_name
issueCount: 1
issues:
- title: MISSING_KEY_ATTRIBUTES
value: This title includes key attributes such as 'brand', but is missing others such as 'capacity', 'material', and 'recommended use'.
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: features
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 100
isEditable: true
attributeValue: This high dome clear cupcake container comes with 12 individual compartments to store a dozen of your delectable cupcakes or muffins. This container is great for bakeries, grocery stores, and catering businesses looking to transport desserts to their events. The high dome structure helps make sure that decorative icing or toppings stay pristine during travel. The lid is detachable, so you'll be able to use this container as its own display without worrying about the top of the lid getting in the way. Just take the top off after your treats have reached their destination, and you're all set up with a grab-and-go dessert station. This container provides a tight, reliable seal, while the crystal clear OPS plastic construction gives your products optimum marketability.
isSpecAttribute: true
attributeName: product_short_description
issueCount: 0
- score: 46.6
attributeValue: '2'
isSpecAttribute: true
attributeName: images
issueCount: 5
issues:
- title: IMAGE_COUNT_TOO_LOW
value: This item has only 2 image(s), while this category requires the item have 5 or more images. Please add more images.
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: shape
issueCount: 1
issues:
- title: MISSING
value: Missing
ratingReviews:
maxRating: 5
ratingCount: 0
wfsEnabled: 0
priority: LOW
categoryName: Food & Beverage
updatedTimestamp: '2021-05-20 12:56:28.984'
productName: Oasis Supply 12-Compartment Hinged High Dome Clear Cupcake Container, Clear, 12-Pack
itemId: '916854860'
stats:
orders: '0'
conversionRate: '0'
gmvAmount:
amount: '0'
currency: USD
totalUnits: '0'
sku: WB 433KP412-12
condition: New
productType: Food Storage Jars & Containers
trends:
- statsType: GMV
- statsType: pageViews
- statsType: orders
- statsType: conversionRate
- values:
- value:
currency: USD
statsType: totalUnits
status: OK
Filter for quality score %:
value:
nextCursor: AoIFQC8AAAAAAAA/ATQwRUM0RUVGQTRCODRCNUE5NjE2QjNEMUFGNUNDNUNC
totalItems: 1
payload:
- qualityScoreData:
score: 15.5
values:
- impact: MEDIUM
scoreType: content & Discoverability
scoreValue: 62
- impact: HIGH
scoreType: offer
scoreValue: 0
- impact: MEDIUM
scoreType: Rating & Reviews
scoreValue: 0
productId: 3F82A2A8W0DJ
scoreDetails:
offer:
shippingSpeed:
score: 0
issueDesc: Please consider providing free ThreeDay Shipping (enable through Shipping Templates) or TwoDay Shipping for customers
issueTitle: Consider Faster Shipping
shippingType: Value
price:
score: null
walmartShipping: 0
additionalDes: null
competitorShipping: 0
competitorPrice:
amount: 34.95
currency: USD
price:
amount: 36.29
currency: USD
issueTitle: Price Not Competitive
asin: B00PDHPL5Y
publishAndTransactable:
score: 0
issueTitle: Issue Detected
maxIssue: 7
totalIssue: 7
issues:
- date: '2021-05-18'
transactableFlag: false
publishFlag: true
- date: '2021-05-17'
transactableFlag: false
publishFlag: true
- date: '2021-05-16'
transactableFlag: false
publishFlag: true
- date: '2021-05-15'
transactableFlag: false
publishFlag: true
- date: '2021-05-14'
transactableFlag: false
publishFlag: true
- date: '2021-05-13'
transactableFlag: false
publishFlag: true
- date: '2021-05-12'
transactableFlag: false
publishFlag: true
issueCount: 9
contentAndDiscoverability:
issueCount: 12
issues:
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: capacity
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 100
isEditable: true
attributeValue: Plastic
isSpecAttribute: false
attributeName: material
issueCount: 0
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: manufacturer_part_number
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 99.9
isEditable: true
attributeValue: Oasis Supply
isSpecAttribute: true
attributeName: brand
issueCount: 0
- score: 100
isEditable: true
attributeValue: New
isSpecAttribute: false
attributeName: condition
issueCount: 0
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: color
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 100
isEditable: true
attributeValue: 00616450784447
isSpecAttribute: false
attributeName: gtin
issueCount: 0
- score: 100
isEditable: true
attributeValue: '12'
isSpecAttribute: false
attributeName: package_quantity
issueCount: 0
- score: 100
isEditable: false
attributeValue: Multi use
isSpecAttribute: false
attributeName: recommended_use
issueCount: 0
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: food_storage_jar_and_container_type
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 45
isEditable: true
attributeValue: 'Dimensions: length: 12.5" - width: 9 1/2"Base width at highest point: 2 3/8"Base width at lowest point: 2" - total compartment height: 3 1/2"Compartment top diameter: 2 1/4" - compartment bottom diameter: 2"High dome. Crystal clear ,12 per order'
isSpecAttribute: true
attributeName: product_long_description
issueCount: 1
issues:
- title: NOT_ENOUGH_BULLET_POINTS
value: This description includes 0 key feature bullets, while it should contain 5 or more. Please include more key features.
- score: 0
isEditable: true
isSpecAttribute: true
attributeName: number_of_pieces
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 71.4
isEditable: true
attributeValue: Oasis Supply 12-Compartment Hinged High Dome Clear Cupcake Container, Clear, 12-Pack
isSpecAttribute: true
attributeName: product_name
issueCount: 1
issues:
- title: MISSING_KEY_ATTRIBUTES
value: This title includes key attributes such as 'brand', but is missing others such as 'capacity', 'material', and 'recommended use'.
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: features
issueCount: 1
issues:
- title: MISSING
value: Missing
- score: 100
isEditable: true
attributeValue: This high dome clear cupcake container comes with 12 individual compartments to store a dozen of your delectable cupcakes or muffins. This container is great for bakeries, grocery stores, and catering businesses looking to transport desserts to their events. The high dome structure helps make sure that decorative icing or toppings stay pristine during travel. The lid is detachable, so you'll be able to use this container as its own display without worrying about the top of the lid getting in the way. Just take the top off after your treats have reached their destination, and you're all set up with a grab-and-go dessert station. This container provides a tight, reliable seal while the crystal clear OPS plastic construction gives your products optimum marketability.
isSpecAttribute: true
attributeName: product_short_description
issueCount: 0
- score: 46.6
attributeValue: '2'
isSpecAttribute: true
attributeName: images
issueCount: 5
issues:
- title: IMAGE_COUNT_TOO_LOW
value: This item has only 2 image(s), while this category requires the item have 5 or more images. Please add more images.
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: shape
issueCount: 1
issues:
- title: MISSING
value: Missing
ratingReviews:
maxRating: 5
ratingCount: 0
wfsEnabled: 0
priority: LOW
categoryName: Food & Beverage
updatedTimestamp: '2021-05-20 12:56:28.984'
productName: Oasis Supply 12-Compartment Hinged High Dome Clear Cupcake Container, Clear, 12-Pack
itemId: '916854860'
stats:
orders: '0'
conversionRate: '0'
gmvAmount:
amount: '0'
currency: USD
totalUnits: '0'
sku: WB 433KP412-12
condition: New
productType: Food Storage Jars & Containers
trends:
- statsType: GMV
- statsType: pageViews
- statsType: orders
- statsType: conversionRate
- values:
- value:
currency: USD
statsType: totalUnits
status: OK
Filter for productType:
value:
nextCursor: AoIFQCVXCj1wo9c/ATA3MTYxOURFRTc2RjQxQ0ZCNDM2N0MyMTE4QTc2RTA5
totalItems: 1
payload:
- qualityScoreData:
score: 10.67
values:
- impact: MEDIUM
scoreType: content & Discoverability
scoreValue: 32
productId: 6L9JFF2TDZDU
scoreDetails:
offer:
shippingSpeed:
score: null
issueDesc: null
issueTitle: null
shippingType: Value
price:
score: null
walmartShipping: 0
additionalDes: null
competitorShipping: 0
competitorPrice:
amount: 3.75
currency: USD
price:
amount: 6.14
currency: USD
issueTitle: Price Not Competitive
asin: B0006GK3JQ
publishAndTransactable:
score: 0
issueTitle: Issue Detected
maxIssue: 7
totalIssue: 7
issues:
- date: '2021-05-18'
transactableFlag: false
publishFlag: true
- date: '2021-05-17'
transactableFlag: false
publishFlag: true
issueCount: 8
contentAndDiscoverability:
issueCount: 20
issues:
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: track_listing
issueCount: 1
issues:
- title: MISSING
value: Missing
- title: MISSING_KEY_ATTRIBUTES
value: This title includes key attributes such as 'musician', but it is missing others such as 'physical media format' and 'music genre'.
ratingReviews:
maxRating: 5
ratingCount: 0
wfsEnabled: 0
priority: LOW
categoryName: Toy
updatedTimestamp: '2021-05-20 10:50:43.163'
productName: Loftus - Noise Maker
itemId: '738555634'
stats:
orders: '0'
conversionRate: '0'
gmvAmount:
amount: '0'
currency: USD
totalUnits: '0'
sku: LOF DC-0091
condition: New
productType: Music
status: OK
Filter for condition:
value:
nextCursor: AoIFQCVXCj1wo9c/ATA3MTYxOURFRTc2RjQxQ0ZCNDM2N0MyMTE4QTc2RTA5
totalItems: 1
payload:
- qualityScoreData:
score: 10.67
values:
- impact: MEDIUM
scoreType: content & Discoverability
scoreValue: 32
productId: 6L9JFF2TDZDU
scoreDetails:
offer:
shippingSpeed:
score: null
issueDesc: null
issueTitle: null
shippingType: Value
price:
score: null
walmartShipping: 0
additionalDes: null
competitorShipping: 0
competitorPrice:
amount: 3.75
currency: USD
price:
amount: 6.14
currency: USD
issueTitle: Price Not Competitive
asin: B0006GK3JQ
publishAndTransactable:
score: 0
issueTitle: Issue Detected
maxIssue: 7
totalIssue: 7
issues:
- date: '2021-05-18'
transactableFlag: false
publishFlag: true
- date: '2021-05-17'
transactableFlag: false
publishFlag: true
issueCount: 8
contentAndDiscoverability:
issueCount: 20
issues:
- score: 0
isEditable: true
isSpecAttribute: false
attributeName: track_listing
issueCount: 1
issues:
- title: MISSING
value: Missing
- title: MISSING_KEY_ATTRIBUTES
value: This title includes key attributes such as 'musician', but it is missing others such as 'physical media format' and 'music genre'.
ratingReviews:
maxRating: 5
ratingCount: 0
wfsEnabled: 0
priority: LOW
categoryName: Toy
updatedTimestamp: '2021-05-20 10:50:43.163'
productName: Loftus - Noise Maker
itemId: '738555634'
stats:
orders: '0'
conversionRate: '0'
gmvAmount:
amount: '0'
currency: USD
totalUnits: '0'
sku: LOF DC-0091
condition: New
productType: Music
status: OK
/v3/insights/prosellerbadge:
get:
tags:
- Insight
summary: Walmart Pro Seller Badge Status
description: The Pro Seller badge status will provide you with information regarding your current badge status as well as the progress you've made in meeting the criteria.
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3880
operationId: getProSellerBadgeInfo
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:
hasBadge:
type: boolean
description: Specifies if the seller has the badge
isEligible:
type: boolean
description: Specifies if the seller is eligible for the badge in the next refresh
badgedSince:
type: string
description: Specifies when the seller received their badge
format: date-time
isProhibited:
type: boolean
description: Specifies whether the seller is prohibited from participating in the Pro Seller badge program.
badgeStatus:
type: string
description: Specifies the seller's badge status in detail. The possible values are "Become a Pro Seller", "You are a Pro Seller", "Pro Seller Badge at risk", "Eligible starting from YYYY-MM-DD", and "Not eligible for the Pro Seller Badge"
meetsCriteria:
type: object
properties:
isOrdersCriteriaMet:
type: boolean
description: Indicates whether the seller has met the minimum number of orders required.
isDeliveryDefectCriteriaMet:
type: boolean
description: Indicates whether the seller has a low delivery defect, meeting the threshold for the badge.
isCancellationCriteriaMet:
type: boolean
description: Indicates whether the seller has a low cancellation rate, meeting the threshold for the badge.
isListingQualityCatalogCriteriaMet:
type: boolean
description: Indicates whether the seller is meeting the trending catalog requirement.
isActiveDaysCriteriaMet:
type: boolean
description: Indicates whether the seller has met the minimum number of active days required.
description: Shows whether the seller has met the requirements for the badge.
criteriaData:
type: object
properties:
orders:
type: integer
description: Number of orders received during the last 90 days.
format: int32
deliveryDefectRate:
type: string
description: Delivery Defect rate in the given timeframe.
cancellationRate:
type: string
description: Cancellation rate in the given timeframe.
listingQualityCatalog:
type: integer
description: Trending Catalog Quality Score coverage.
format: int32
activeDays:
type: integer
description: Days active on the platform.
format: int32
description: Shows the criteria for the Pro Seller badge.
recommendations:
type: object
properties:
deliveryDefectRate:
type: string
description: Recommendations on reducing the delivery defect rate
cancellationRate:
type: string
description: Recommendations on reducing the Cancellation rate
listingQualityCatalog:
type: string
description: Recommendations on increasing the trending item catalog coverage
description: Recommendations on how to increase chances of Pro Seller Badge eligibility
example:
hasBadge: true
isEligible: false
badgedSince: 2020-11-05T04:32:02.330+0000
isProhibited: false
badgeStatus: Pro Seller Badge at risk
meetsCriteria:
activeDaysCriteriaMet: true
ordersCriteriaMet: true
deliveryDefectCriteriaMet: true
cancellationCriteriaMet: true
listingQualityCatalogCriteriaMet: false
criteriaData:
orders: 2318
deliveryDefectRate: '0.27'
cancellationRate: '0.0'
listingQualityCatalog: 56
activeDays: 1213
recommendations:
listingQualityCatalog: Improve 226 more trending items with a Listing Quality score below 60%.
/v3/insights/items/unpublished/items:
get:
tags:
- Insight
summary: Walmart Unpublished Items
description: Get Unpublished Items
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3880
operationId: getUnpublishedItems
parameters:
- name: unpublishedReasonCode
in: query
description: Unpublished reason code
required: false
schema:
type: string
default: all
- name: fromDate
in: query
description: Returns all unpublished items since the given date
required: true
schema:
type: string
example: '2020-09-23'
- name: limit
in: query
description: The number of items to be returned.
required: false
schema:
type: string
default: '20'
- name: offerLifecycleStatus
in: query
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
required: false
schema:
type: string
default: all
- name: marketTrending
in: query
description: Filter the item list to return only items that are trending on Walmart.com
required: false
schema:
type: string
default: 'true'
- name: itemsWithInventory
in: query
description: Filter the item list to return only items that have inventory
required: false
schema:
type: string
default: 'true'
- 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:
payload:
type: array
items:
type: object
properties:
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN)
marketPrice:
type: object
properties:
amount:
type: string
description: The numerical value of the price
currency:
type: string
description: The currency type
offerStartDate:
type: string
description: The Date when item becomes available to sell in Walmart
marketTrending:
type: string
description: If item is trending in walmart
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle
unpublishReasons:
type: string
description: It outlines the reason for an item when unpublished
conversionRate:
type: integer
description: Percentage of number of items that are converted into sales
format: int32
productName:
type: string
description: A seller-specified, alphanumeric string uniquely identifying the product name
gmvAmount:
type: object
properties:
amount:
type: integer
description: The numerical value of the price
format: int32
currency:
type: string
description: The currency type
itemId:
type: string
description: Specifies the item identifier generated by Walmart
customerRating:
type: string
description: An average rating number for the item from customers
pageViews:
type: integer
description: number of times this item is viewed by customers
format: int32
price:
type: object
properties:
amount:
type: string
description: The numerical value of the price
currency:
type: string
description: The currency type
unpublishedDate:
type: string
description: The Date item becomes to Unpublished
brand:
type: string
description: Specifies the item brand
sku:
type: string
description: String of letters and/or numbers a partner uses to identify the item
condition:
type: string
description: Information about the condition of the product
productType:
type: string
description: A seller-specified, alphanumeric string uniquely identifying the Product Type
offerEndDate:
type: string
description: The Date when item becomes unavailable to sell in Walmart
publishStatus:
type: string
description: The status of an item when the item is in the submission process
totalCount:
type: integer
description: total number of unpublished items
format: int32
totalGmvAmount:
type: object
properties:
amount:
type: string
description: The numerical value of the price
currency:
type: string
description: The currency type
description: Gross Merchandise Value of the total result set
example:
payload:
- gtin: 00847321012345
marketPrice:
amount: '0.000000'
currency: USD
offerStartDate: '2020-01-06'
marketTrending: 'false'
lifecycleStatus: ACTIVE
unpublishReasons: REASONABLE_PRICE_NOT_SATISFIED
conversionRate: 0
productName: Baxton Studio BBT5111 Bar Stool-Brown Libra Dark Brown Modern Bar Stool with Nail Head Trim - 44.5 x 18.5 x 21.5 in. - Pack of 2
gmvAmount:
amount: 0
currency: USD
itemId: '196412345'
customerRating: '4'
pageViews: 3
price:
amount: '309.95'
currency: USD
unpublishedDate: '2020-08-04'
brand: Baxton Studio
sku: DEAL12345
condition: New
productType: Stools
offerEndDate: '2049-12-30'
publishStatus: PUBLISHED
- gtin: 07612981712345
marketPrice:
amount: '0.000000'
currency: USD
offerStartDate: '2019-11-13'
marketTrending: 'false'
lifecycleStatus: ACTIVE
unpublishReasons: REASONABLE_PRICE_NOT_SATISFIED
conversionRate: 0
productName: Franke Bernadine Kitchen Faucet Stainless Steel
gmvAmount:
amount: 0
currency: USD
itemId: '236212345'
customerRating: '0'
pageViews: 88
price:
amount: '187.98'
currency: USD
unpublishedDate: '2020-08-13'
brand: Franke
sku: DEAL12345
condition: 'Pre-Owned: Like New'
productType: faucets
offerEndDate: '2049-12-30'
publishStatus: UNPUBLISHED
- gtin: 00190931112345
marketPrice:
amount: '0.000000'
currency: USD
offerStartDate: '2019-04-09'
marketTrending: 'false'
lifecycleStatus: ACTIVE
unpublishReasons: REASONABLE_PRICE_NOT_SATISFIED
conversionRate: 0
productName: Coastal Blue Women's SwimsuitDeep V Ruffle Front One Piece S 4-6 Swimsuit
gmvAmount:
amount: 0
currency: USD
itemId: '332612345'
customerRating: '0'
pageViews: 0
price:
amount: '31.98'
currency: USD
unpublishedDate: '2020-09-13'
brand: Coastal Blue
sku: DEAL12345
condition: Restored Premium
productType: One-Piece Swimsuits
offerEndDate: '2049-12-30'
publishStatus: UNPUBLISHED
totalCount: 7
totalGmvAmount:
amount: '3760.95'
currency: USD
/v3/insights/items/unpublished/counts:
get:
tags:
- Insight
summary: Walmart Unpublished Item Counts
description: Get Count for Unpubished Item
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3880
operationId: getUnpublishedItemCount
parameters:
- name: fromDate
in: query
description: Returns all unpublished items count with reason codes since the given date
required: true
schema:
type: string
example: '2020-09-23'
- 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:
payload:
type: array
items:
type: object
properties:
unpublishedCount:
type: string
description: total count for unpublished Item
unpublishedValue:
type: string
description: total value for unpublished Item
unpublishedReasonCode:
type: string
description: the reason why item is unpublished
example:
payload:
- unpublishedCount: '185'
unpublishedValue: '2154.0'
unpublishedReasonCode: END_DATE
- unpublishedCount: '3'
unpublishedValue: '0.0'
unpublishedReasonCode: END_DATE,REASONABLE_PRICE_NOT_SATISFIED
- unpublishedCount: '1'
unpublishedValue: '0.0'
unpublishedReasonCode: NO_PRICE,END_DATE
- unpublishedCount: '94'
unpublishedValue: '1900.89'
unpublishedReasonCode: REASONABLE_PRICE_NOT_SATISFIED
/v3/insights/items/trending:
get:
tags:
- Insight
summary: Walmart Top Trending Items
description: Get Trending Item List
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3865
operationId: getTrendingResult
parameters:
- name: departmentId
in: query
description: departmentId
required: true
schema:
type: string
- name: categoryId
in: query
description: categoryId
required: false
schema:
type: string
default: 'null'
- name: limit
in: query
description: The number of items to be returned.
required: false
schema:
type: string
default: '20'
- name: offset
in: query
description: The object response to start with, where 0 is the first entity that can be requested.
required: false
schema:
type: string
default: '0'
- name: timeFrame
in: query
description: Returns all trending items for the given time frame in days
required: false
schema:
type: string
default: '7'
example: 10
- 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:
payload:
type: object
properties:
totalCount:
type: integer
description: Total count of qualified items
format: int32
items:
type: array
description: List of Qualified Items
items:
type: object
properties:
categoryName:
type: string
description: The categories this item belongs to
departmentName:
type: string
description: The department this product belongs to
isbn:
type: string
description: International Standard Book Number
productName:
type: string
description: A seller-specified, alphanumeric string uniquely identifying the product name
isTwoDayEligible:
type: integer
description: if the item can be shipped in two days
format: int32
itemId:
type: string
description: Specifies the item identifier generated by Walmart
totalOffers:
type: integer
description: Total number of item stored by seller
format: int32
issn:
type: string
description: International Standard Serial Number
existsForSeller:
type: integer
description: if seller is selling this item
format: int32
rank:
type: integer
description: Level of trending for this item
format: int32
brand:
type: string
description: Specifies the item brand
superDepartmentName:
type: string
description: The superDepartmentName this item belongs to
subCategoryName:
type: string
description: The subCategoryName this item belongs to
description: List of Qualified Items
status:
type: string
example:
status: SUCCESS
payload:
items:
- departmentName: BATH AND SHOWER
isbn: ''
categoryName: BATH DECOR
productName: High Precision Digital Body Weight Bathroom Scale with Ultra Wide Platform and Easy-to-Read Backlit LCD,400 Pounds
subCategoryName: BATH SCALES
isTwoDayEligible: 0
itemId: '297382621'
totalOffers: 1
issn: ''
superDepartmentName: 20 BATH AND SHOWER
existsForSeller: 0
rank: 1
brand: POCFGST
- departmentName: BATH AND SHOWER
isbn: ''
categoryName: SHOWER
productName: LiBa Mildew Resistant Anti-Bacterial PEVA Shower Curtain Liner, 72x72 Clear Non Toxic, No Odor
subCategoryName: SHOWER CURTAINS AND LINERS
isTwoDayEligible: 1
itemId: '195087796'
totalOffers: 1
issn: ''
superDepartmentName: 20 BATH AND SHOWER
existsForSeller: 0
rank: 2
brand: Liba
- departmentName: BATH AND SHOWER
isbn: ''
categoryName: SHOWER
productName: Clorox Cushioned 17 In. x 36 In. Bathtub Mat, White
subCategoryName: TUB MATS
isTwoDayEligible: 1
itemId: '933889813'
totalOffers: 1
issn: ''
superDepartmentName: 20 BATH AND SHOWER
existsForSeller: 0
rank: 3
brand: Duck
totalCount: 187
/v3/insights/items/listingQuality/score:
get:
tags:
- Insight
summary: Walmart Seller Listing Quality Score
description: Get the total Listing Quality Score for a seller's entire item catalog.
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3880
operationId: getListingQualityScore
parameters:
- name: viewTrendingItems
in: query
description: Specify whether or not to include seller's items that are trending in the Listing Quality Score.
required: false
schema:
type: boolean
- name: wfsFlag
in: query
description: Specify whether or not to include WFS-eligible items in the overall Listing Quality Score.
required: false
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
payload:
type: object
properties:
overAllQuality:
type: number
description: 'Over All Quality '
format: double
score:
type: object
properties:
offerScore:
type: number
description: Offer Score
format: double
contentScore:
type: number
description: Content Score
format: double
ratingReviewScore:
type: number
description: Rating Review Score
format: double
description: Score
postPurchaseQuality:
type: object
properties:
defectRatio:
type: integer
description: Defect Ratio
format: int32
itemDefectCnt:
type: integer
description: Item Defect Count
format: int32
description: Post Purchase Quality
example:
payload:
score:
offerScore: 50
ratingReviewScore: 14.48
contentScore: 64.24
postPurchaseQuality:
itemDefectCnt: 0
defectRatio: 0
overAllQuality: 44.7
status: OK
/v3/insights/items/listingQuality/count:
get:
tags:
- Insight
summary: Walmart Item Count With Listing Quality Issues
description: Get a list of all item categories that have items with listing quality issues or brands for a seller.
externalDocs:
description: View Guide
url: /doc/us/mp/us-mp-insights/#3880
operationId: getCategoriesList
parameters:
- name: viewTrendingItems
in: query
description: Specify whether or not to include seller's items that are trending in the Listing Quality Score.
required: false
schema:
type: boolean
default: true
- name: wfsFlag
in: query
description: Specify whether or not to include WFS-eligible items in the overall Listing Quality Score.
required: false
schema:
type: boolean
- name: hasIssue
in: query
description: Specify whether or not to include items that have issues in the Listing Quality Score.
required: false
schema:
type: integer
format: int32
default: 0
- name: type
in: query
description: Specify whether to get item count by brand or category. Category is the default value when no type is specified.
required: false
schema:
type: string
enum:
- brand
- category
- name: limit
in: query
description: Specify number of items to return. The value is defaulted to 100 and the maximum value is 1000.
required: false
schema:
type: integer
format: int32
- name: offset
in: query
description: Specify the offset of item list to be returned.
required: false
schema:
type: integer
format: int32
default: 0
- 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:
payload:
type: array
items:
type: object
properties:
name:
type: string
count:
type: integer
format: int32
productType:
type: array
description: productType is only applicable for categories
items:
type: object
properties:
name:
type: string
count:
type: integer
format: int32
description: productType is only applicable for categories
examples:
Categories With Issues:
value:
status: OK
payload:
- category: Baby
offerCount: 122000
productType:
- productTypeName: Baby Onesies
offerCount: 9000
Brand List:
value:
status: OK
totalCount: 12260
payload:
- name: Bali
count: 1515
- name: Unique Loom
count: 1130
x-tagGroups:
- name: 1P Suppliers DSV Cost Reference
tags:
- DSV Cost