Walmart Listing Quality API
The Listing Quality API from Walmart — 3 operation(s) for listing quality.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/walmart-listing-quality-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Walmart Insights Management Listing Quality API
description: "The Insights Management API provides sellers with actionable information to optimize their listings:\n* Sellers can locate best-selling items with Trending Items API so they can add those to their catalog of item offerings. \n* Sellers can find out reasons why items go unpublished, fix the issue and republish those items.\n* Sellers can use Listing Quality APIs to gather listing quality metrics about their items and find out any post-production issues that they can fix.\n* Sellers can obtain their overall Listing Quality score, and locate any categories that show items with listing quality issues."
servers:
- url: https://marketplace.walmartapis.com
description: Production URL
- url: https://sandbox.walmartapis.com
description: Sandbox URL
security:
- basicScheme: []
tags:
- name: Listing Quality
paths:
/v3/insights/prosellerbadge:
get:
tags:
- Listing Quality
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/listingQuality/score:
get:
tags:
- Listing Quality
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:
- Listing Quality
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