Call this endpoint to retrieve comprehensive pricing insights for your items on Walmart Marketplace. This API is designed to provide programmatic access to data that can help you monitor performance, identify opportunities, and make informed pricing decisions.

By using this API, you can query your catalog for various pricing attributes, including current price, Buy Box pricing information, competitive pricing information, repricer details, and more. The API supports pagination, sorting, and flexible filtering to help you retrieve the exact data you need.

This page describes how to use the Pricing Insights API, including request parameters and sample responses. For a full list of all available response fields and filterable attributes, refer to the Pricing Insights API Reference .

The following table lists the various filters you can use to get pricing insights date for your items.

Endpoint

POST https://marketplace.walmartapis.com/v3/price/getPricingInsights

Sample request

This sample request shows how to query for pricing insights data. The request includes authentication headers, a correlation ID for tracking, and a JSON payload specifying pagination, filters, and sorting. In this example, the first 10 items that are not Buy Box eligible are sorted by traffic.

curl --request POST \ --url <https://marketplace.walmartapis.com/v1/pricing/insights/query> \ --header 'WM_QOS.CORRELATION_ID: YOUR_CORRELATION_ID' \ --header 'WM_SEC.ACCESS_TOKEN: YOUR_ACCESS_TOKEN' \ --header 'WM_SVC.NAME: YOUR_SERVICE_NAME' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "filter":[ { "name": "buyBoxWinRate", "operator": "BETWEEN", "value": [0, 75] }, { "name": "priceCompetitiveness", "operator": "BETWEEN", "value": [0, 100] }, { "name": "gmvL30D", "operator": "BETWEEN", "value": [0, 100] }, { "name": "isInDemand", "operator": "IN", "value": ["TRUE"] } ], "searchCriteria": { "searchField": "SKU", "searchValue": ["21203526","Candle-lavender-green-tea","504312(1)","hvff"] } , "sort":{ "sortField":"TRAFFIC", "sortOrder":"DESC" }, "pageNumber": 0 }' 

import requests url = "https://marketplace.walmartapis.com/v1/pricing/insights/query" headers = { "WMQOS.CORRELATIONID": "YOURCORRELATIONID", "WMSEC.ACCESSTOKEN": "YOURACCESSTOKEN", "WMSVC.NAME": "YOURSERVICENAME", "accept": "application/json", "content-type": "application/json"
} data = { "filter": [ { "name": "buyBoxWinRate", "operator": "BETWEEN", "value": [0, 75] }, { "name": "priceCompetitiveness", "operator": "BETWEEN", "value": [0, 100] }, { "name": "gmvL30D", "operator": "BETWEEN", "value": [0, 100] }, { "name": "isInDemand", "operator": "IN", "value": ["TRUE"] } ], "searchCriteria": { "searchField": "SKU", "searchValue": ["21203526", "Candle-lavender-green-tea", "504312(1)", "hvff"] }, "sort": { "sortField": "TRAFFIC", "sortOrder": "DESC" }, "pageNumber": 0
} response = requests.post(url, headers=headers, json=data) print(response.statuscode)
print(response.json())

Request body explained

• pageNumber (integer, optional): The page number to retrieve (0-indexed). Default: 0.
• searchCriteria (object, optional):
  • Used for retrieving data for specific SKUs.
  • searchField (string): The field to search on. For example, SKU.
  • searchValue (array of strings): The SKUs to include in the search. For example, YOUR_SKU_1, YOUR_SKU_2.

    If searchCriteria is provided, filter and sort are ignored.

• filter (object, optional):
  • Contains criteria to filter the results. Fields are combined with an implicit AND.
    • Each field to be filtered is an object specifying the operator and value.
      • operator (string): The comparison operator. For example, eq for equals, gte for greater than or equal to, in for value is in the list. Refer to the Pricing Insights API Reference for all supported operators.
      • value: The value to compare against (type depends on the field and operator).
    • Example: "name": "isInDemand", "operator": "IN", "value": ["TRUE"]
• sort (object, optional):
  • Defines the sorting order for the results.
  • sortField (string): The field name from the response payload to sort by.
  • sortOrder (string): The sort direction (ASC for ascending, DESC for descending).

Modify your code

• Replace WM_SEC.ACCESS_TOKEN, WM_QOS.CORRELATION_ID, and WM_SVC.NAME with your actual values.
• Adjust pageNumber and pageSize for pagination as needed.
• If using searchCriteria, provide the appropriate searchField SKU and an array of searchValue.
• Construct your filter object with the desired fields, operators, and values, keeping in mind supported filterable fields.
• Set the sortField and sortOrder if specific ordering is required.

Sample response

The sample response confirms the request was successful and returns a list of items matching the query criteria, along with pagination details.

{ "data": { "getpricinginsightsItems": { "pageContext": { "pageNo": 0, "currentPageCount": 0, "totalCount": 1, "totalPages": 0 }, "pricingInsightsResponseList": [ { "itemName": "KIND Gluten Free Dark Chocolate Nuts & Sea Salt Snack Bars, Value Pack, 1.4 oz, 12 Count", "sku": "SKU-00649718205842", "currentPrice": null, "buyBoxBasePrice": 9.0, "buyBoxTotalPrice": 9.0, "buyBoxWinRate": "100.0", "competitorPrice": null, "comparisonPrice": null, "fulfillment": null, "inventoryCount": null, "repricerStrategyType": null, "repricerStrategyName": null, "repricerStatus": null, "repricerMinPrice": null, "repricerMaxPrice": null, "priceCompetitiveScore": 11.18, "promoStatus": null, "salesRank": 1, "potentialGmvLift": null, "gmv30": 3874.18, "inDemand": true, "priceDifferential": null, "traffic": null, "priceCompetitive": false, "reducedReferralStatus": null, "walmartFundedStatus": null } ] } }
}

Result

A successful response (e.g., HTTP 200 OK) will contain the requested pricing insights data in the pricingInsightsResponseList array. You can use this data to analyze your pricing strategy, identify items requiring attention, or feed into your internal systems for automated actions. If there are issues with the request for example an invalid filter or authentication error, the API will return an appropriate error code and message.