Get my item details and insights

You can use the Item Management APIs to retrieve item-level data and the Insight APIs to analyze those items, including trends, usage patterns, and performance metrics. First, retrieve item details using the Item Management APIs. Then, analyze performance using the Insight APIs. The All Items and An Item APIs help you get information on your existing items in the catalog. By combining Item Management APIs with Insight APIs, you can explore performance metrics and behavioral trends.

Search for all items in the seller's catalog

Use the All Items API to retrieve all items from a partner catalog.

This API supports pagination using either the nextCursor or the offset and limit parameters.

Each item includes an isDuplicate flag that indicates whether the item is a duplicate.

To return additional information about duplicates, set the optional showDuplicateItemInfo parameter to true. This adds a destinationItem object with relevant details.

To identify customer favorite items, include the optional includeCustomerFavoritesStatus parameter and set it to true. This returns an isCustomerFavorite flag, which indicates whether the item is popular with customers.

  1. Run https://marketplace.walmartapis.com/v3/items API to search for an item in the catalog.
    You’ll see the total items available, their product name, product type, SKU details, published status, lifecycle, and variant information.
  2. To search for a product in the catalog, call GET /v3/items/walmart/search, and specify query parameters:
    • query for a keyword search
    • upc for Universal Product Code search, or
    • gtin for Global Trade Item Number search

Example: Search by keyword

For example, to search for a keyword, enter text (for example, iPad or Fitbit) with the query parameter:
GET https://marketplace.walmartapis.com/v3/items/walmart/search?query=ipad

Example: Search by UPC

To search by UPC code, specify the number with the upc parameter:
GET https://marketplace.walmartapis.com/v3/items/walmart/search?upc=911138034047

  1. Upon success, the response returns all values for the item in JSON format.

Search for an item in the seller's catalog

Use the An Item API to retrieve detailed information about a specific item from the partner’s catalog. You must pass productId as a path parameter and partnerId as a query parameter.

The response includes an isDuplicate field, indicating whether the item is a duplicate (true or false). This field is omitted when the productIdType is SKU.

To identify customer favorite items, include the optional includeCustomerFavoritesStatus parameter and set it to true. This returns an isCustomerFavorite flag, which indicates whether the item is currently popular with customers.

  1. Run https://marketplace.walmartapis.com/v3/items/{id} API to search a seller’s catalog by seller’s Item_ID, GTIN, UPC, EAN, ISBN, or SKU.
  2. To search for a seller’s item by specific product code, call GET v3/items resource, and specify the productIdType query parameter set to ITEM_ID, GTIN, UPC, ISBN, EAN, or SKU.
  3. You must specify at least one value for the productIdType query parameter (for example, productIdType=GTIN), or else the API returns SKU by default.
  4. If there are more than one item in the catalog, the search returns the first 20 items in the response.

By default, this API will only respond with 20 results matching your filtering parameters, even though there would be more matches to your query. You can increase this by setting the limit parameter.

Additionally, you can use the information provided in the relatedQueries response parameter to run a new search for similar items.

Get an item by SKU

You can pass the SKU code directly as the URL parameter, ID:
https://marketplace.walmartapis.com/v3/items/{ID}
For example, to get the SKU code 30348_KFTest, specify it directly to the items resource as a URL parameter:
https://marketplace.walmartapis.com/v3/items/30348_KFTest

Get an item by specific codes

To get other item codes, specify the query parameter productIdType set to either GTIN, UPC, EAN, ISBN, SKU, or ITEM_ID and provide the numeric code after the /items resource in the URL.

Example: get an item by GTIN

https://marketplace.walmartapis.com/v3/items/06932096330348?productIdType=GTIN

Example: get an item by UPC

https://marketplace.walmartapis.com/v3/items/123456789012?productIdType=UPC

Example: get an item by EAN

https://marketplace.walmartapis.com/v3/items/5901234123457?productIdType=EAN

Example: get an item by ISBN

https://marketplace.walmartapis.com/v3/items/1514735164?productIdType=ISBN

Example: get an item by ITEM_ID

https://marketplace.walmartapis.com/v3/items/0935829?productIdType=ITEM_ID

Example: get an item by SKU

https://marketplace.walmartapis.com/v3/items/30348_KFTest?productIdType=SKU

  1. Upon success, the response returns all values for the item in JSON format.