GET Retrieve A Single Item: Overview

The GET Read: Single Item request, also known as GET An Item, allows users to search for a single item, with Walmart returning either all or select item details.

There are two versions of this request:

  • v4/items/{productId} (v4): Allows users to search by additional supported product identifiers (SKU, GTIN, EAN, ISBN, WIN, and Item ID). Aligns Supplier APIs to data available to suppliers in Walmart’s Item 360 web app, including enhanced search capabilities, additional attributes, and full item and insight visibility.
  • v3/items/{sku} (v3): Allows users to search by stock keeping unit (SKU) only. Walmart will end support on March 1, 2024 and will deprecate on May 1, 2024.

Search for an Item in the Supplier’s Catalog

The GET Read: Single Item call enables a supplier to search for an item the supplier sells to Walmart. The call returns the item and relevant item information in the GET Read: Single Item response. The supplier can choose to receive key item attributes or the entire item payload.

v4 Release: New Identifiers Supported in Search

GET Read: Single Item v4 allows suppliers to search a supplier’s catalog by the following product identifiers:

  • Stock keeping unit (SKU)
  • Global trade item number (GTIN)
  • European article number (EAN)
  • International standard book number (ISBN)
  • Walmart item number (WIN)
  • Item identifier (Item ID)

To search for a supplier’s item by a specific product identifier or code:

  1. Call v4/items/{productId}.
  2. Specify the productId path parameter by inputting the product identifier value. If not specified, the call searches by GTIN by default.

Example: To get GTIN 06932096330348, specify it directly in the path parameter productId.

https://api-gateway.walmart.com/v4/items/06932096330348

Get an Item by Specific Product Identifiers

To get an item by other specific product identifiers, provide the numeric product code in the productId path parameters. Specify the query parameter productIdType to SKU, GTIN, EAN, ISBN, WIN, or Item ID . A successful response returns all values for the item in JSON format.

Example URLs for searching each product identifier are listed below:

GET Read: Single Item v4 Release: Attribute Enhancements

The GET Read: Single Item response may contain key item attributes (default response) or a payload of all item attributes.

Key Item Attributes Included in Response (Default)

The following key item attributes will always be returned in the response as part of a normal or default item search using the GET Read: Single Item call.

These attributes include:

  • SKU, GTIN, variant group ID, product name, shelf, product type, Walmart.com selling price, and published status
  • 10 key item attributes have been added to the v4 response: Brand, main image URL, product short description, unpublished reason, item page URL, 1P item is Buy Box winner, site dates (start and end), customer rating, number of customer reviews, and content quality score

Item Attributes Removed in Response (v4)

The following attributes are being removed in the GET Read: Single Item v4 response:

  • Mart: Removing the mart or country-level market attribute since 1P supplier requests are only applicable to the U.S. market, negating the need to define any other country-level market.
  • WPID: Removing the Walmart product identifier (WPID) attribute, as this identifier is only used internally by Walmart and is not needed by suppliers in the item search requests.
  • UPC: Removing the universal product code (UPC) attribute, as the response includes GTIN-14, and UPC can be identified from GTIN-14 by removing the two leading digits.

All Item Attributes (Including Insights) in Response

Suppliers can get the all item attributes, or the entire Walmart-provided item details or attributes, in the GET Read: Single Item response. These attributes will include data specific to the following:

  • additionalProductAttributes: Includes all product-specific attributes relevant to the item’s product type
  • walmartOrderAttributes: Includes attributes that Walmart uses to order the item, including key compliance and regulatory information
  • itemConfigurations: Provides each item configuration, Walmart Item Number (WIN), and all attributes (for example, cost attributes) for each item a supplier sells to Walmart
  • attributeContentInsights: Includes all recommendations to improve the content and increase the content quality score
  • variantGroupInfo: Includes all relevant item variant details used to create item variants on the Item Page in Walmart.com

Suppliers can indicate if they want to receive the all item attributes, or the full item payload, by setting the query parameter includeFullItemDetails to YES.

An example v4 call for complete item information is:

https://api-gateway.walmart.com/v4/items/06932096330348?productIdType=GTIN&includeFullItemDetails=YES

Items of note when returning all item attributes:

  • If the item does not have a product type assigned (for example, the productType value is null), then the additionalProductAttributes object will not be included.
  • The attributes returned in a complete item information response are specific to the item’s product type. Suppliers can find which attributes may be present for each item by finding the productType in the Visible object in the POST Item Maintenance by Product Type feed file schema. See the POST Bulk Item Setup and Maintenance by Product Type: Feed File Structure Overview section for more information.