--- updatedAt: 2026-08-03T16:48:54.000Z --- # Get all items

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


Displays a list of all items by using either nextCursor or offset and limit query parameters.There are two ways of pagination for this API* Using nextCursor query parameterFirst call will have the value of nextCursor as '*'. If a call to the endpoint results in a large number of items being returned, the results are sent back in pages. The element nextCursor which is returned in the response is required for pagination. The nextCursor element contains the string that should be send as a query parameter to the subsequent GET call to get the next page of results. A missing or empty nextCursor element in the response means that there are no more items left to retrieve.The totalCount returns the total number of available items. Therefore, analysis of the totalCount provides the number of pages to be retrieved to get the whole list of items.* Using offset and limit query parameterFirst call to the API using offset=0 will return the first page of the list of items. The full list can be retrieved by subsequent requests to the same API with successively larger values of offset.If a SKU is included, this request is semantically identical to Get an Item request. It will return only one item and hence pagination is not required. [block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "version": "1.0", "title": "Item Management", "description": "The Item Management APIs enable you to set up and manage items on Walmart.com. Once you have completed Registration and have access to your Consumer ID and Private Key, you can get started with the integration process" }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false, "explorer-enabled": true }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" } ], "paths": { "/v3/ca/items": { "get": { "tags": [ "Items" ], "summary": "Get all items", "description": "

Migrate to Global APIs: New sellers and approved Solution Providers should use Global APIs. Existing users must migrate to avoid disruption and access new capabilities coming to your market. Explore Global Marketplace migration resources.


Displays a list of all items by using either nextCursor or offset and limit query parameters.There are two ways of pagination for this API* Using nextCursor query parameterFirst call will have the value of nextCursor as '*'. If a call to the endpoint results in a large number of items being returned, the results are sent back in pages. The element nextCursor which is returned in the response is required for pagination. The nextCursor element contains the string that should be send as a query parameter to the subsequent GET call to get the next page of results. A missing or empty nextCursor element in the response means that there are no more items left to retrieve.The totalCount returns the total number of available items. Therefore, analysis of the totalCount provides the number of pages to be retrieved to get the whole list of items.* Using offset and limit query parameterFirst call to the API using offset=0 will return the first page of the list of items. The full list can be retrieved by subsequent requests to the same API with successively larger values of offset.If a SKU is included, this request is semantically identical to Get an Item request. It will return only one item and hence pagination is not required.", "operationId": "getAllItems", "parameters": [ { "name": "nextCursor", "in": "query", "description": "Used for pagination when more than 200 items are retrieved.", "required": false, "schema": { "type": "string", "default": "*" } }, { "name": "sku", "in": "query", "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item.", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.", "required": false, "schema": { "type": "string", "default": "0" } }, { "name": "limit", "in": "query", "description": "The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.", "required": false, "schema": { "type": "string", "default": "20" } }, { "name": "lifecycleStatus", "in": "query", "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.", "required": false, "schema": { "type": "string" } }, { "name": "publishedStatus", "in": "query", "description": "The published status of an item describes where the item is in the submission process. Examples of allowed values are PUBLISHED, UNPUBLISHED.", "required": false, "schema": { "type": "string" } }, { "name": "variantGroupId", "in": "query", "description": "Variant Id to retrieve all items with the same variant id", "required": false, "schema": { "type": "string" } }, { "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": true, "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" }, { "name": "WM_SEC.TIMESTAMP", "in": "header", "description": "The Epoch timestamp", "required": true, "schema": { "type": "string" }, "example": "1443748249449" }, { "name": "WM_SEC.AUTH_SIGNATURE", "in": "header", "description": "The vendor's digital signature, generated by running the JAR file or custom generation code", "required": true, "schema": { "type": "string" }, "example": "9fg3TPeRt0WSGbXNGGj4kSQ9L6PMBX.....9Zj5aDyg=" }, { "name": "WM_CONSUMER.ID", "in": "header", "description": "A unique ID required to access the API", "required": true, "schema": { "type": "string" }, "example": "Get the Consumer ID from Developer Center after logging in" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "required": [ "itemResponse" ], "type": "object", "properties": { "errors": { "type": "array", "xml": { "name": "error" }, "items": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "description": { "type": "string" }, "info": { "type": "string" }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ] }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ] }, "causes": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "Cause" } } }, "errorIdentifiers": { "type": "object", "additionalProperties": { "type": "object" } }, "component": { "type": "string" }, "type": { "type": "string" }, "serviceName": { "type": "string" }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ] } }, "xml": { "name": "GatewayError" } } }, "itemResponse": { "type": "array", "description": "Items included in the response list", "xml": { "name": "ItemResponse" }, "items": { "type": "object", "properties": { "mart": { "type": "string", "description": "The marketplace name. Example: 'WALMART_CA'", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "sku": { "type": "string", "description": "Unique identifier for the item" }, "wpid": { "type": "string", "description": "An alphanumeric Product ID generated by Walmart" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name. Example: 'Sterling Silver Blue Diamond Heart Pendant with 18in Chain'" }, "shelf": { "type": "string", "description": "Walmart assigned item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the item price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "description": "The current price of the item" }, "publishedStatus": { "type": "string", "description": "The published status of an item describes where the item is in the submission process. Examples of allowed values are PUBLISHED, UNPUBLISHED." }, "lifecycleStatus": { "type": "string", "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED." }, "variantGroupId": { "type": "string", "description": "Variant Id if the item is of type Variant" }, "variantGroupInfo": { "type": "object", "properties": { "isPrimary": { "type": "boolean", "description": "Returns true if the item is a primary variant" }, "groupingAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Returns true if the item is a primary variant" }, "value": { "type": "string", "description": "The list of variant attributes used to create the variant item" } }, "description": "The list of variant attributes used to create the variant item" }, "primary": { "type": "boolean" } }, "description": "Additional variant group information if the item is of type Variant" } }, "xml": { "name": "ItemResponse" } } }, "totalItems": { "type": "integer", "description": "Total Items for the query", "format": "int64" }, "nextCursor": { "type": "string", "description": "Used for pagination when more than 200 items are retrieved. The nextCursor value of the response includes a link to another GET call which retrieves the next page of results." } }, "xml": { "name": "ItemResponses" } }, "example": { "ItemResponse": [ { "mart": "WALMART_CA", "sku": "SKU-07036588938254", "wpid": "4LEGH64HJ7G5", "gtin": "07036588938254", "productName": "Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Orange", "shelf": "[\"UNNAV\"]", "productType": "Baby Blankets", "price": { "currency": "CAD", "amount": 104.99 }, "publishedStatus": "PUBLISHED", "lifecycleStatus": "ACTIVE", "variantGroupId": "Gerberfunitur007878", "variantGroupInfo": { "isPrimary": false, "groupingAttributes": [ { "name": "actual_color", "value": "Orange" }, { "name": "pattern", "value": "plain" } ] } }, { "mart": "WALMART_CA", "sku": "SKU-07036587698227", "wpid": "21A0278LYCTA", "gtin": "07036587698227", "productName": "Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Orange", "shelf": "[\"UNNAV\"]", "productType": "Baby Blankets", "price": { "currency": "CAD", "amount": 104.99 }, "publishedStatus": "PUBLISHED", "lifecycleStatus": "ACTIVE", "variantGroupId": "Gerberfunitur007878", "variantGroupInfo": { "isPrimary": true, "groupingAttributes": [ { "name": "actual_color", "value": "Orange" }, { "name": "pattern", "value": "plain" } ] } }, { "mart": "WALMART_CA", "sku": "SKU-07036587698234", "wpid": "6R2ID6X7TFUV", "gtin": "07036587698234", "productName": "Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Maroon", "shelf": "[\"UNNAV\"]", "productType": "Baby Blankets", "price": { "currency": "CAD", "amount": 105.99 }, "publishedStatus": "PUBLISHED", "lifecycleStatus": "ACTIVE", "variantGroupId": "Gerberfunitur007878", "variantGroupInfo": { "isPrimary": false, "groupingAttributes": [ { "name": "actual_color", "value": "Maroon" }, { "name": "pattern", "value": "Camouflage" } ] } }, { "mart": "WALMART_CA", "sku": "SKU-07036588938261", "wpid": "4G03PCRLEOF5", "gtin": "07036588938261", "productName": "Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Maroon", "shelf": "[\"UNNAV\"]", "productType": "Baby Blankets", "price": { "currency": "CAD", "amount": 105.99 }, "publishedStatus": "PUBLISHED", "lifecycleStatus": "ACTIVE", "variantGroupId": "Gerberfunitur007878", "variantGroupInfo": { "isPrimary": false, "groupingAttributes": [ { "name": "actual_color", "value": "Maroon" }, { "name": "pattern", "value": "Camouflage" } ] } } ], "totalItems": 4 } }, "application/xml": { "schema": { "required": [ "itemResponse" ], "type": "object", "properties": { "errors": { "type": "array", "xml": { "name": "error" }, "items": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "description": { "type": "string" }, "info": { "type": "string" }, "severity": { "type": "string", "enum": [ "INFO", "WARN", "ERROR" ] }, "category": { "type": "string", "enum": [ "APPLICATION", "SYSTEM", "REQUEST", "DATA" ] }, "causes": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "Cause" } } }, "errorIdentifiers": { "type": "object", "additionalProperties": { "type": "object" } }, "component": { "type": "string" }, "type": { "type": "string" }, "serviceName": { "type": "string" }, "gatewayErrorCategory": { "type": "string", "enum": [ "INTERNAL_DATA_ERROR", "EXTERNAL_DATA_ERROR", "SYSTEM_ERROR" ] } }, "xml": { "name": "GatewayError" } } }, "itemResponse": { "type": "array", "description": "Items included in the response list", "xml": { "name": "ItemResponse" }, "items": { "type": "object", "properties": { "mart": { "type": "string", "description": "The marketplace name. Example: 'WALMART_CA'", "enum": [ "WALMART_US", "WALMART_CA", "ASDA_GM", "WALMART_MEXICO" ] }, "sku": { "type": "string", "description": "Unique identifier for the item" }, "wpid": { "type": "string", "description": "An alphanumeric Product ID generated by Walmart" }, "upc": { "type": "string", "description": "The 12-digit bar code used extensively for retail packaging in the United States" }, "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length." }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name. Example: 'Sterling Silver Blue Diamond Heart Pendant with 18in Chain'" }, "shelf": { "type": "string", "description": "Walmart assigned item shelf name" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: 'Diamond'" }, "price": { "type": "object", "properties": { "currency": { "type": "string", "description": "The currency of the item price", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "STD", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XFU", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZWL" ] }, "amount": { "type": "number", "description": "The numerical amount of the price. Example: 9.99" } }, "description": "The current price of the item" }, "publishedStatus": { "type": "string", "description": "The published status of an item describes where the item is in the submission process. Examples of allowed values are PUBLISHED, UNPUBLISHED." }, "lifecycleStatus": { "type": "string", "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED." }, "variantGroupId": { "type": "string", "description": "Variant Id if the item is of type Variant" }, "variantGroupInfo": { "type": "object", "properties": { "isPrimary": { "type": "boolean", "description": "Returns true if the item is a primary variant" }, "groupingAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Returns true if the item is a primary variant" }, "value": { "type": "string", "description": "The list of variant attributes used to create the variant item" } }, "description": "The list of variant attributes used to create the variant item" }, "primary": { "type": "boolean" } }, "description": "Additional variant group information if the item is of type Variant" } }, "xml": { "name": "ItemResponse" } } }, "totalItems": { "type": "integer", "description": "Total Items for the query", "format": "int64" }, "nextCursor": { "type": "string", "description": "Used for pagination when more than 200 items are retrieved. The nextCursor value of the response includes a link to another GET call which retrieves the next page of results." } }, "xml": { "name": "ItemResponses" } }, "example": "\n\n \n WALMART_CA\n SKU-07036588938261\n 4G03PCRLEOF5\n 07036588938261\n Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Maroon\n [\"UNNAV\"]\n Baby Blankets\n \n CAD\n 105.99\n \n PUBLISHED\n ACTIVE\n Gerberfunitur007878\n \n false\n \n actual_color\n Maroon\n \n \n pattern\n Camouflage\n \n \n \n \n WALMART_CA\n SKU-07036588938254\n 4LEGH64HJ7G5\n 07036588938254\n Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Orange\n [\"UNNAV\"]\n Baby Blankets\n \n CAD\n 104.99\n \n PUBLISHED\n ACTIVE\n Gerberfunitur007878\n \n false\n \n actual_color\n Orange\n \n \n pattern\n plain\n \n \n \n \n WALMART_CA\n SKU-07036587698227\n 21A0278LYCTA\n 07036587698227\n Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Orange\n [\"UNNAV\"]\n Baby Blankets\n \n CAD\n 104.99\n \n PUBLISHED\n ACTIVE\n Gerberfunitur007878\n \n true\n \n actual_color\n Orange\n \n \n pattern\n plain\n \n \n \n \n WALMART_CA\n SKU-07036587698234\n 6R2ID6X7TFUV\n 07036587698234\n Teamson Kids Baby 16\" Doll Changing Station Playset Roleplay Dolls Furniture Grey toy Maroon\n [\"UNNAV\"]\n Baby Blankets\n \n CAD\n 105.99\n \n PUBLISHED\n ACTIVE\n Gerberfunitur007878\n \n false\n \n actual_color\n Maroon\n \n \n pattern\n Camouflage\n \n \n \n 4\n" } } } } } } } } ```