The Store Inventory APIs provide suppliers with near real-time visibility of available inventory at our Walmart stores.
- The Single Item Inventory endpoint can be used to request inventory status information for a single item by GTIN.
- The Multi Item Inventory endpoint can be used to request inventory status information for up to 100 items, using either the GTIN or Walmart Item Number.
Endpoints
Get Single Item Inventory.
GET
/store/{storeNbr}/gtin/{gtin}/available
Note: In this endpoint, {storeNbr} and {gtin} are the request parameters.
Get Multi Item Inventory.
POST
/store/inventory/status?itemIdentifier={itemIdentifier}
Note: In this endpoint, {itemIdentifier} represents the endpoint path parameter (item identifier). See below for accepted item identifiers.
Single Item Inventory Endpoint Details
Find details for the Single Item Inventory endpoint in the sections below.
Optional Headers
The following optional header keys are available:
| Name | Description | Required | Data Type |
|---|---|---|---|
| wm_context_identifier | A Walmart Supplier's unique identifier. | Mandatory for Preferred Service Providers (PSPs) only. | String |
Request Details
| Parameter | Description | Data Type |
|---|---|---|
| storeNbr | The valid store number associated with the requested details. | Integer |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
Response Details
| Parameter | Description | Data Type |
|---|---|---|
| supplier | The name of the supplier. | String |
| storeNbr | The store number(s) associated with the requested details. | Integer |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| locationArea | The location of the inventory. For example: store, mfc (Market Fulfillment Center). | String |
| state | The status of the inventory (ie, available). | String |
| quantity | The number of items that are currently available for sale at store level. | Double |
| lastUpdatedTime | Latest time when the data was updated. Timestamp is specified in ISO format (YYYY-MM-DDTHH24:MM:SS), in UTC timezone. | Date |
Multi Item Inventory Endpoint Details
Find details for the Single Item Inventory endpoint in the sections below.
Accepted Item Identifiers
| itemIdentifier | Description |
|---|---|
| gtin | The 14-digit Global Trade Item Number (GTIN) that uniquely identifies the items. |
| wmItemNbr | The 9-digit Walmart Item Number that uniquely identifies the items. |
Optional Headers
The following optional header keys are available:
| Name | Description | Required | Data Type |
|---|---|---|---|
| wm_context_identifier | A Walmart Supplier's unique identifier. | Mandatory for Preferred Service Providers (PSPs) only. | String |
Request Body Details
| Parameter | Description | Data Type |
|---|---|---|
| storeNbr | This is an identifying number of a store within a country. It is the most used store identifier and is an essential store attribute for reporting. | Integer |
| values | An array containing either the 14-digit Global Trade Item Numbers (gtin) or the Walmart Item Numbers (wmItemNbr) that uniquely identify the items. A maximum of 100 values can be passed. | Array |
Response Details
| Parameter | Description | Data Type |
|---|---|---|
| supplier | The name of the supplier. | String |
| storeNbr | The store number(s) for which the user is looking for details. | Integer |
| inventory | The array that will contain the list of items identified and their inventory, by location and state. | Array |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| wmItemNbr | The Walmart Item Number that uniquely identifies the items. | String |
| inventoryByLocation | The array that will contain the details of the inventory by location. | Array |
| locationArea | The location of the item. | String |
| state | The status of the inventory (ie, available). | String |
| quantity | The number of items that are currently available for sale at store level. | Double |
| cidLevelInventory | The array that will contain the details of the inventory aggregated at Consumer ID (CID) level. | Array |
| crossReferences | The array that will contain the details of the inventory that is mapped to the CID. | Array |
| lastUpdatedTime | Latest time when the data is updated. Timestamp is specified in ISO format “YYYY-MM-DDTHH24:MM:SS” in UTC timezone. | Date |
| errors | The array that will contain the list of values with their corresponding error message and timestamp. See Response Errors table below for additional information. | Array |
Response Errors
Item-related response errors will appear in the response body, rather than as separate errors. Find common response errors and their reasons below.
| Error Message | Reason | Array Response Sample |
|---|---|---|
| Invalid GTIN | If the user has provided gtin as the itemIdentifier in the path parameter, the error could be caused by: (a) gtin having special characters in it. (b) gtin is negative value. (c) gtin contains other than a number (d) gtin is more than or less than 14 digits | { "supplier": "Awesome Company", "storeNbr": 45, "errors": [ { "fieldName": "gtin", "value": "0002840031041#", "message": "invalid gtin", "timestamp":"2024-01-23T00:15:03" } ] } |
| Invalid wmItemNbr | If the user has provided wmItemNbr as the itemIdentifier in the path parameter, the error could be caused by: (a) wmItemNbr having special characters in it. (b) wmItemNbr is negative value. (c) wmItemNbr contains other than number (d) wmItemNbr is more than or less than 9 digits | { "supplier": "Awesome Company", "storeNbr": 45, "errors": [ { "fieldName": "wmItemNbr", "value": "900067543", "message": "invalid wmItemNbr", "timestamp":"2024-01-23T00:15:03" } ] } |
| gtin not mapped to the supplier | If the user has provided gtin as the itemIdentifier in the path parameter, the error is because the GTIN is not mapped to the supplier. | { "supplier": "Awesome Company", "storeNbr": 45, "errors": [ { "fieldName": "gtin", "value": "00028400310414", "message": "gtin not mapped to the supplier", "timestamp":"2024-01-23T00:15:03" } ] } |
| wmtItemNbr not mapped to the supplier | If the user has provided wmtItemNbr as the itemIdentifier in the path parameter, the error is because the wmtItemNbr is not mapped to the supplier. | { "supplier": "Awesome Company", "storeNbr": 45, "errors": [ { "fieldName": "wmItemNbr", "value": "9000543678", "message": "wmtItemNbr not mapped to the supplier", "timestamp":"2024-01-23T00:15:03" } ] } |
| No data found | If the user has provided gtin as the itemIdentifier in the path parameter, the error is because one or more gtin's data is not available in the EI response. | { "supplier": "Awesome Company", "storeNbr": 45, "errors": [ { "fieldName": "gtin", "value": "00301490477014", "message": "No data found", "timestamp":"2024-01-23T00:15:03" } ] } |
| No data found | If the user has provided wmtItemNbr as the itemIdentifier in the path parameter, the error is because one or more wmItemNbr's data is not available in the EI response. | { "supplier": "Awesome Company", "storeNbr": 45, "errors": [ { "fieldName": "wmItemNbr", "value": "900045678", "message": "No data found", "timestamp":"2024-01-23T00:15:03" } ] } |
| No message, but the inventoryByLocation array is blank | EI response does not contain 'Available' state inventory information at store level or for one or more requested gtin. | { "supplier": "Awesome Company", "storeNbr": 45, "inventory": [ { "gtin": "00300450524218", "inventoryByLocation": [] } ] } |
| No message, but the inventoryByLocation array is blank | EI response does not have 'Store' level inventory information for one or more requested gtin. | { "supplier": "Awesome Company", "storeNbr": 45, "inventory": [ { "gtin": "00300450524218", "inventoryByLocation": [] } ] } |
Error Codes
Find common error codes, reasons, and resolution details below. Expand each to view details. If you are still unable to resolve your issue, please contact us.
400 (BAD REQUEST)
| Error Message | Reason | Resolution |
|---|---|---|
| Invalid GTIN. | When an invalid GTIN is provided in the request: a. GTIN has special characters in it. b. GTIN is a negative value. c. GTIN contains other than a number . | Please provide a valid GTIN for the given storeNbr in the request header. |
| Invalid storeNbr. | When an invalid storeNbr is provided in the request: a. storeNbr has special characters in it. b. storeNbr is a negative value. c. storeNbr is not numeric. | Provide a valid storeNbr in the request header. |
| Association not present with provided context supplier. | This could occur if an invalid wm_context_identifier was provided. | If you are providing a wm_context_identifier please check that it is valid and try again. |
| The request must contain either gtin or wmItemNbr as itemIdentifier. | The request must contain an itemIdentifier. | Please provide either a valid gtin or wmItemNbr. |
| Association not present with provided context supplier. | This could occur if an invalid wm_context_identifier was provided. | If you are providing a wm_context_identifier please check that it is valid and try again. |
401 (UNAUTHORIZED)
| Error Message | Reason | Resolution |
|---|---|---|
| Could not authenticate inrequest, auth signature: Signature verification failed. | This is possibly because of: 1. using the incorrect private key that you use for generating signatures. 2. the Authentication signature has malfunctioned. | Make sure you are using the correct private key and other parameters. Please generate a new Authentication Signature. |
| The timestamp 1639999142531 passed for the signature has expired. | The timestamp for the signature has expired. Signatures expire every 3 minutes. | Please generate a new signature and try again. |
| wm_consumer.id is not found in the request header. | The request does not contain the wm_consumer.id request header. | Please provide the wm_consumer.id header with a valid Consumer ID in the request. |
403 (FORBIDDEN)
| Error Message | Reason | Resolution |
|---|---|---|
| The Consumer ID is not subscribed to the service name. | When the "wm_consumer.id" header is not present in the request header or is not correct. | Please use the provided Consumer ID and pass in the request header. |
| Request is missing required security headers, please read documentation for security headers. | This is because any one of the mandatory request headers are missing. | Request headers should have all four attributes: wm_consumer.id, wm_sec.auth_signature, wm_consumer.intimestamp, and wm_sec.key_version. |
404 (NOT FOUND)
| Error Message | Reason | Resolution |
|---|---|---|
| Not found. | The provided URL is incorrect. | Use the correct endpoints mentioned in the documentation. |
| The requested GTIN is not mapped to the Supplier. | - The provided GTIN doesn’t belong to the supplier. - The provided GTIN is not mapped to the supplier for a few stores. | Please use the appropriate GTIN belonging to the supplier. |
| Data not found for the given request parameters. | There is no data for the requested GTIN and storeNbr. | Provide the valid GTIN for the particular storeNbr. |
405 (METHOD NOT ALLOWED)
| Error Message | Reason | Resolution |
|---|---|---|
| Method not allowed. | An incorrect HTTP verb has been used. | Use the correct request method. Refer the endpoint URL details in the documentation. |
429 (TOO MANY REQUESTS)
| Error Message | Reason | Resolution |
|---|---|---|
| Too many requests, please retry after some time. | This is possibly due to a number of requests exceeding the given quota. Refer to the Throttling section on this page for details. | Since the requests are getting throttled, it is suggested to make API calls again after some time. |
500 (INTERNAL SERVER ERROR)
| Error Message | Reason | Resolution |
|---|---|---|
| Internal server error. | One or more services are unavailable. Please contact support. | Please contact support. |
Disclaimer
Your use of the API documentation is at your own discretion and risk. To the maximum extent permitted by law, the APIs, documentation and all related software, components, and support are provided by Walmart on an "as-is" and "as available" basis without any warranties of any kind, and Walmart expressly disclaims any and all express and implied warranties, including, but not limited to, warranties of merchantability, fitness for a particular purpose, title, noninfringement, non-interference, and warranties arising from a course of dealing. You acknowledge that Walmart does not warrant that the APIs will be uninterrupted, timely, secure, or error-free. Walmart may modify and delete API documentation in its sole discretion and without notice.
In no event shall Walmart be liable to you or any third parties for any damages whatsoever, including, without limitation, those resulting from loss of use, damage to your computer system, loss of data or profits, or any liability arising out of or in connection with the use of the APIs, documentation, software, components, or support.
©️Walmart | All Rights Reserved | Confidential
