Get item count by groups

Overview

Use the Get item count by groups API to retrieve the number of items associated with variant groups in your Walmart Marketplace seller catalog.

A variant group contains items that share a common variantGroupId. Use this API to review the number of items in each group or retrieve the count for a specific variant group.

Use cases

  • Retrieve item counts for variant groups
  • Check the number of items associated with a specific variant group
  • Review variant group sizes
  • Identify groups that may require further review

Reference guide

This guide explains how to retrieve item counts grouped by variant group ID.

For complete endpoint details, refer to the Get item count by groups API reference.

Endpoint

GET https://marketplace.walmartapis.com/v3/items/groups/count

Request sample

The following request retrieves item counts by variant group.

curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/items/groups/count' \ -H "WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6" \ -H "WM_MARKET: US" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>" \ -H "WM_GLOBAL_VERSION: 3.1" \ -H "Accept: application/json"

Replace <ACCESS_TOKEN> with a valid access token and use a unique correlation ID for each request.

Modify your request

Retrieve the count for a specific variant group

Set variantGroupId to the identifier of the variant group.

Example:

GET /v3/items/groups/count?variantGroupId=WFSGRP22

Retrieve counts for variant groups

Omit variantGroupId to retrieve variant group counts without filtering to a specific group.

Example:

GET /v3/items/groups/count

Response sample

The following response is based on the documented API example.

{ "status": 200, "payload": [ { "variantGroupId": "VGWATER130", "count": 1 }, { "variantGroupId": "WFSGRP22", "count": 5 }, { "variantGroupId": "VGS-3B-CASE", "count": 2 } ]
}

Results

After a successful request, the API returns the number of items associated with each matching variant group. Each result includes the variant group ID and its item count.

Next steps

  1. Identify the variant group you want to review.
  2. Use Get all items with variantGroupId to retrieve its items.
  3. Review the variant information returned for each item.
  4. Refer to Setting up multiple variants for variant setup guidance.

Did this page help you?