The Transaction History API provides suppliers with the transaction history for their GTINs at our Walmart stores (such as item sales, returns, receiving, etc).
Endpoints
GET
/store/{storeNbr}/gtin/{gtin}/transactionHistory
Note: In this endpoint, {storeNbr} and {gtin} are the request parameters.
Optional Headers
The following optional header keys are available:
| Name | Description | Required | Data Type |
|---|---|---|---|
| continuationpagetoken | Transaction History can contain more than 1 page of response. When this is the case, the response header will contain a Continuation Token. This Continuation Token must be added to the request header of subsequent API requests in order to see more pages. If there are no additional pages, you will not receive a continuationpagetoken header. | No | String |
| locationArea | Can be used as a filter to display the transaction history of items in specific parts of a store. Accepted values (case sensitive): STORE, BACKROOM, MFC. If no value is passed for the parameter, it will default to STORE. | No | String |
| wm_context_identifier | A Walmart Supplier's unique identifier. | Mandatory for Preferred Service Providers (PSPs) only. | String |
Request Details
| Parameter | Mandatory | Description | Data Type |
|---|---|---|---|
| storeNbr | Yes | The valid store number for which the user is looking for details. | Integer |
| gtin | Yes | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| eventType | No | Returns a code associated with the events that took place. All event types will be returned by default. See Event Type Codes below for more information. | String |
| startDate | No | This is the reference start Date over which the events occurred (last 7 days by default). This Date should be in yyyy-mm-dd format. | String |
| endDate | No | This is the final Date over which the events occurred (current Date by default). This Date should be in yyyy-mm-dd format. | String |
Event Type Codes
The following explains the event type code meanings associated with the transaction history events.
| eventType | Event |
|---|---|
| BR | Backroom |
| CID_GTIN_BALANCE | Internal Enterprise Inventory (EI) Activity. Example: Reconciling a multi GTIN item where one is showing surplus and the other is showing negative. |
| CORRECTION | Any correction event. Corrections can come from a Walmart associate or a system such an In Stock Assistant. Corrections could also be sent by vendor from the IAC endpoint. |
| DECANTING | Market Fulfillment Center (MFC) event – used when inventory is taken from receiving to the dedicated MFC area to be picked. |
| DISASTER | A claims event – used during a disaster to remove the inventory from available. |
| DISPOSE | Store has thrown away an item. Example: Bad produce. |
| DONATE | Store has donated the item. Example: Donating water to a local community fundraiser. |
| EFOC | eCommerce event – full order was canceled. |
| EODC | eCommerce event – order dispense was canceled. |
| EODR | eCommerce event – order dispense was rejected by the customer. |
| EOPC | eCommerce event – order pick event for an Online Pickup and Delivery (OPD) order. |
| EOPX | eCommerce event – order pack exception. |
| EOUP | eCommerce event – order pack complete. |
| INCR | Inventory correction event – only applicable to Fulfillment Centers (FC) and Distribution Centers (DC). |
| INRF | Internal Enterprise Inventory (EI) event - Inventory Refresh – Never changes quantity. |
| INVENTORY_REMOVAL | MFC event – removing inventory for an MFC. |
| LIQUIDATE | Item is entering the Customer Value Program – EI will lose insight on the item once it has entered the customer value program. Example: items that are being marked down due to a nearing expiration Date. |
| LR | Legacy Receiving - a product is received in the store. Most common for direct-to-store DSD items. |
| NB | Internal Enterprise Inventory event – replays old events for reconciliation. |
| NGR | Next-Gen Receiving - inventory receiving process for non-DSD items. |
| NIL_PICK | Online Pickup and Delivery (OPD) order event indicating the item was not found to be picked. |
| PCID (Prime CID Change Process) | Item Setup change has occurred – no change of inventory. Example: a GTIN moving between two CIDs. |
| PI | Inventory correction. |
| RECLAMATION | Inventory is being taken out of “available" state to enter the claims process. |
| REINDUCT_REJECT | MFC event – When an item has been reintroduced to the MFC after removal, but was rejected. |
| REMOVAL | Inventory removal event – Items removed from the store by the supplier via the IAC endpoint. |
| RETURNS | Returns event. [Replaces Legacy Pick (LP)] |
| SALES | Sales event. [Replaces Legacy Pick (LP)] |
| SHORTAGE | Correction event – occurs when a store does not receive the expected quantity of an item from a DC. |
| STOCK_TRANSFER | Occurs when an item is moved between stores. |
| STOCKED | Receiving event – Vendor Delivered – Pay from scan (PFS) business event – Sent from vendor. |
| STOLEN | Store has reported the item as stolen. The item is then taken out of the "available" status. |
| STORE_USE | Item has been taken off the shelf for store use. |
| TIMEBOUND_STATE | Internal EI event – Automatic correction of inventory state. Example: an item was received in the backroom 24 hours ago but never showed a binned status, correction occurs to move the item to the sales floor status. |
| TSBR – EI TickTick Reconciliation | Internal EI event – Generated due to the system detecting events being received out of order – Event corrects the order and reconciles the timing. |
Response Details
| Parameter | Description | Data Type |
|---|---|---|
| supplier | The name of the supplier. | String |
| storeNbr | The store number associated with the events. | Integer |
| gtin | The 14-digit Global Trade Item Number that uniquely identifies the items. | String |
| eventHistory | The returned transaction history. | Array |
| eventType | The type of event that occurred. | String |
| eventQty | The product count that was affected. | Double |
| eventCreationTime | The time the event was created. | Date |
| aggregatedQty | The inventory count after the event occurred. | Double |
Sandbox Test Values
Below are the sample Request Parameters (StoreNbr & GTIN combinations) you can utilize to test the Transaction History endpoint for all the successful and error scenarios in your sandbox environment. The values provided are strictly applicable for the sandbox environment only and will only work with a sandbox consumer ID.
| Testing Scenarios | Store Number (StoreNbr) | GTIN | Event Type | Start Date | End Date | Response Sample |
|---|---|---|---|---|---|---|
| SUCCESS 200 OK | 45 | 00044444444444-00044444444449 00055555555555-00055555555559 | LP, POF, LR, PI, BR, ALL | 2023-02-16 | 2023-02-22 | { "supplier":"Awesome Company", "storeNbr":45, "gtin":"00044444444444", "eventHistory":[ { "eventType":"LP", "eventQty":3, "eventCreationTime":"2023-02-22T06:00:00", "aggregatedQty":150 }, { "eventType":"POF", "eventQty":4, "eventCreationTime":"2023-02-21T21:01:02", "aggregatedQty":147 }, { "eventType":"LR", "eventQty":5, "eventCreationTime":"2023-02-21T12:03:06", "aggregatedQty":143 }, { "eventType":"PI", "eventQty":6, "eventCreationTime":"2023-02-21T03:06:12", "aggregatedQty":138 }, { "eventType":"BR", "eventQty":7, "eventCreationTime":"2023-02-20T18:10:20", "aggregatedQty":132 }, { "eventType":"LP", "eventQty":8, "eventCreationTime":"2023-02-20T09:15:30", "aggregatedQty":125 ...... |
| NOT FOUND 404 | 30 | 00082233344455 | LP, POF, LR, PI, BR, ALL | 2023-02-16 | 2023-02-22 | { "errors": [ { "instance": "/store/30/gtin/00082233344455/transactionHistory", "message": "The requested GTIN is not mapped to the Supplier.", "status": "NOT_FOUND", "timestamp": "2022-06-28T13:59:18" } ] } |
| 45 | 00088888888888 or 00099999999999 | LP, POF, LR, PI, BR, ALL | 2023-02-16 | 2023-02-22 | { "errors": [ { "instance": "/store/45/gtin/00088888888888/transactionHistory", "message": "Data not found for the given request parameters.", "status": "NOT_FOUND", "timestamp": "2022-06-29T12:44:33" } ] } | |
| 400 Bad Request | -45 (Invalid store number) | 00044444444444 | LP, POF, LR, PI, BR, ALL | 2023-02-16 | 2023-02-22 | { "errors": [ { "fieldName": "storeNbr", "message": "Invalid storeNbr.", "status": "BAD_REQUEST", "timestamp": "2022-06-29T15:06:55" } ] } |
| 45 | - 00044444444444 (Invalid GTIN) | LP, POF, LR, PI, BR, ALL | 2023-02-16 | 2023-02-22 | { "errors": [ { "fieldName": "gtin", "message": "Invalid GTIN.", "status": "BAD_REQUEST", "timestamp": "2022-06-29T15:07:35" } ] } | |
| 45 | 00044444444444 | 123 (Invalid event type) | 2023-02-16 | 2023-02-22 | { "errors": [ { "fieldName": "eventType", "message": "Invalid eventType.", "status": "BAD_REQUEST", "timestamp": "2022-06-29T15:07:35" } ] } | |
| 45 | 00044444444444 | LP, POF, LR, PI, BR, ALL | 2023-02-25 (Invalid Date) | 2023-02-22 | { "errors": [ { "fieldName": "startDate", "message": "Start date cannot be greater than end date", "status": "BAD_REQUEST", "timestamp": "2022-06-29T15:07:35" } ] } |
©️Walmart | All Rights Reserved
