The Inventory Action Capture (IAC) API provides the capability for Pay-For-Scan (PFS) suppliers to send their Walmart Store inventory actions back to the Walmart Enterprise Inventory.
Endpoints
POST
/store/inventoryActions
Request Body Details
| Parameter | Mandatory | Description | Data Type |
|---|---|---|---|
| messageId | Yes | A unique reference identifier for the message that can be any unique value up to 36 characters. The messageId must be unique for every call. | String |
| eventType | Yes | Event type will be a unique identifier for the type of action that is being taken at the store. Note: Only the four events below will be accepted, and they are case sensitive (upper case). ARRIVAL - Used for arrival or restocking of the merchandise. "Arrival" Event Type cannot have a negative quantity value. Please always provide a positive value with this event. Ex: If an item has "quantity" value as "40" with "arrival" event, 40 units will be added to the available inventory. REMOVAL - Used when merchandise is being removed from the store due to damage, overstock, expiration, etc. Please always provide a positive value with this event. Ex: If an item has "quantity" value as "40" with "removal" event, 40 units will be subtracted from the available inventory. CORRECTION - Used when inventory needs to be reset to a value that is different from what is available in the Enterprise Inventory. It can also be used if the available quantity is not known. For correction, a positive quantity must be provided. Negative quantities will be rejected. For example, if the current inventory shows 25 but needs to be corrected to 20, the correction event should be sent as 20. BOOTSTRAP - Use this event for a new item/GTIN, for a quantity count signifying a starting Available value. For Bootstrap, a representative would need to do a full inventory count of all Supplier merchandise in the store. | String |
| storeNbr | Yes | The store number where the event is taking place. | Integer |
| lineInfo | Yes | This array will contain the list of details of the items that are being acted on. Maximum of 10 items are allowed per event. | Array |
| gtin | Yes | The 14-digit global trade identification number of the item that is being acted on. | String |
| secondaryItemIdentifier | No | An optional secondary item identifier, such as ITEM NUMBER, UPC, etc. | Record (JSON Object) |
| type | Yes | The secondary item identifier type. E.g., UPC, ITEM NUMBER etc. | String |
| value | Yes | The value of the secondary identifier. | String |
| destinationLocation | Yes | Record of where the item is being dropped in the store. | Record (JSON Object) |
| locationArea | Yes | Area within the score where the item is being dropped e.g., shelf, salesfloor, backroom, MFC etc. | String |
| location | No | The aisle location, in sgln format. Example: A-10-100. | String |
| lpn | No | This is an optional container identifier. | String |
| quantity | Yes | The quantity of items/merchandise that were added, removed, or corrected (positive or negative) during the action. The value in this field can be negative or positive (ex. - 20, 20). | Float |
| expiryDate | No | Expiration Date of the item being dropped (gtin level). In YYYY-MM-DD format. | String |
| documentInfo | No | Optional document-related information, if available, regarding the action being taken. | Array |
| doctype | No | The type of document being used e.g., INVOICE, PO etc. (optional) | String |
| docNbr | No | The number/identifier associated with the document. (optional) | String |
| docDate | No | The Date/time of the the document generation, in epoch format. (optional) | Long |
| userId | Yes | The user id, or unique identifier, of the person/process triggering the event. This will be sent by the source app. | String |
| reasonDetails | Yes | Details of the reason why this action is being taken. | Array |
| reasonCode | No | An optional supplier reason code, Maximum 30 characters. | String |
| reasonDesc | Yes | A short description of why the action was taken needs to be provided, maximum 30 characters. | String |
| vendorNbr | No | The vendor number associated with the vendor, if different from the supplier making the delivery (optional), maximum 30 characters. | String |
| eventCreationTime | Yes | The system time of when the event was created, in epoch format (note: time must be in milliseconds). The event must occur within the last 3 days. | Long |
Response Body Details
The response body will contain the message "Events created for the following gtins" for all successful events. Item-related errors will follow in the response. For common item-related errors, please see our Error Codes page.
©️Walmart | All Rights Reserved
