You are here:
Types of Inventory Events
View the different export event types in Point of Sale CMS.
Advanced Shipping Notice Inventory Events
Monitor the status of incoming shipments in Point of Sale CMS with Advanced Shipping Notices (ASN).
ASN_RECEIVED_EVENT
This event is triggered if an ASN is received, either via Feed or manual upload. It signifies that Point of Sale successfully received your ASN, and the items are now within the inventory system, awaiting further processing. If you configured an ASN_RECEIVED_EVENT, you’ll receive a corresponding file for this event each time a new feed is received or if you manually upload an ASN.
ASN_PARTIALLY_RECEIVED_EVENT
After the ASN is available in the PS System, you can receive its associated items using the POS app, found under the tab, by selecting the "Receiving From Warehouse or Store" deep link.
When you scan a package or manually enter a carton ID or pallet ID from the received shipment, the system triggers an ASN_PARTIALLY_RECEIVED_EVENT. This event signifies that you received one carton or one pallet from the shipment. The generated file shows a "" status for the items within the received carton(s). For each received carton or pallet, one ASN_PARTIALLY_RECEIVED_EVENT event is triggered, except for the last carton or pallet.
After the final carton or pallet is scanned, an ASN_RECEIVE_COMPLETED_EVENT is triggered.
ASN_RECEIVE_COMPLETED_EVENT
When you scan a package or manually enter a pallet ID and that pallet ID is the only one in the entire shipment, the system triggers an ASN_RECEIVE_COMPLETED_EVENT. This event indicates that the entire shipment was successfully received. However, if there are multiple pallets, the system continues to trigger ASN_PARTIALLY_RECEIVED_EVENT events for each received pallet.
Field Mappings
The table lists the available Field Mappings related to ASNs.
| Field Mapping | Description |
|---|---|
| ASN_EventType | Type of event associated with the ASN, such as creation, update, or cancellation. |
| ASN_TransferType | Indicates the transfer type, such as interstore, warehouse to store, or supplier to warehouse. |
| ASN_InventoryTransferID | Unique identifier for the inventory transfer associated with the ASN. |
| ASN_OrderID | Unique identifier of the order related to this ASN. |
| ASN_PONumber | Purchase order number that the ASN is fulfilling. |
| ASN_BillOfLadingID | Identification number found on the Bill of Lading, which is a legal document between the shipper and carrier. |
| ASN_TrackingNumber | Tracking number provided by the shipping carrier for the shipment. |
| ASN_FromID | Identifier of the location or entity from which the goods are shipped. |
| ASN_ToID | Identifier of the destination location or entity to which the goods are being sent. |
| ASN_ProductCount | Total number of different products included in the ASN. |
| ASN_ProductImageLinks | URLs linking to images of the products included in the ASN. |
| ASN_Status | Current status of the ASN, such as pending, in transit, or delivered. |
| ASN_CreatedOn | Date and time that the ASN was created. |
| ASN_DueOn | Expected date on which the goods arrive at their destination. |
| ASN_LastProcessedById | Unique identifier of the last user who processed the ASN. |
| ASN_LastProcessedByName | Name of the last user who processed the ASN. |
| ASN_UpdatedOn | Date and time that the ASN was last updated. |
| ASN_VendorID | Unique identifier of the vendor associated with the ASN. |
| ASN_ReceivedOn | Date and time that the goods were received. |
| ASN_CancelledOn | Date and time that the ASN was canceled, if applicable. |
| ASN_ExportDate | Date on which the ASN data was exported from the system. |
| ASN_ItemStatus | Status of individual items within the ASN, such as ordered, backordered, or canceled. |
| ASN_TransferID | Unique identifier for the transfer transaction associated with the ASN. |
| ASN_PalletID | Identification number of the pallet used in the shipment. |
| ASN_CartonID | Identification number of the carton used in the shipment. |
| ASN_ProductID | Unique identifier for each product listed in the ASN. |
| ASN_ProductTitle | Title or name of the product. |
| ASN_ProductImageURL | URL of the image representing the product. |
| ASN_QuantityOrdered | Quantity of the product ordered. |
| ASN_QuantityTransferred | Quantity of the product that’s been transferred. |
| ASN_QuantityReceived | Quantity of the product that’s been received. |
| ASN_Shipper | Company or individual responsible for shipping the goods. |
| ASN_ShippedOn | Date and time that the goods were shipped. |
| ASN_ItemTrackingNumber | Tracking number associated with a specific item in the shipment. |
| ASN_EstimatedDeliveryOn | Estimated date of delivery of the goods. |
| ASN_DeliveredOn | Actual date on which the goods were delivered. |
| ASN_ReceivedBy | Individual or department that received the goods. |
| ASN_ReasonCode | Code that explains the reason for a return or adjustment. |
| ASN_ReasonText | Text description accompanying the reason code, explaining the context or details. |
| ASN_Color | Color spec of the product, if applicable. |
| ASN_Size | Size spec of the product, if applicable. |
| ASN_GTIN | Global Trade Item Number, a unique identifier for trade items developed by GS1. |
| ASN_ExternalDocNumber | Reference number to an external document related to the ASN. |
| ASN_ExternalLineNumber | Line number from an external document that correlates with a specific item in the ASN. |
| ASN_Description | Detailed description of the ASN or items within it. |
| ASN_IsManualAdd | Indicates whether the ASN was added manually to the system. |
| ASN_SerialNumbers | Serial numbers of the products, if applicable. |
Blind Receive Inventory Events
Configure inventory events to receive shipping notifications without advanced notice information.
BLIND_RECEIVE_STARTED_EVENT
Within the POS app, under the tab, there's a deep link labeled "" that allows you to receive shipments without relying on ASN information. When you start the Blind Receive process, and if you've configured BLIND_RECEIVE_STARTED_EVENT, a file notification indicates that the blind receive process was initiated.
BLIND_RECEIVE_PAUSED_EVENT
After starting the Blind Receive process, you have the flexibility to either pause or complete it. If you select to pause the process, you'll receive a BLIND_RECEIVE_PAUSED_EVENT file notification, signifying that the Blind Receive process was temporarily paused. The received file contain the data of the items that you've received up to that moment.
BLIND_RECEIVE_IN_PROGRESS_EVENT
If a paused blind receive process is resumed, you'll receive a BLIND_RECEIVE_IN_PROGRESS_EVENT file notification. This indicates that the Blind Receive process was reinitiated and is currently in progress again. Similar to the previous event, the received file contains the data of the items received thus far.
BLIND_RECEIVE_COMPLETED_EVENT
You’ll receive a BLIND_RECEIVE_COMPLETED_EVENT file notification. This notification signifies that the Blind Receive process was fully executed and completed. The received file contains the comprehensive data of all the items that you received during the process.
Field Mappings
The table lists the available Field Mappings related to blind receivings.
| Field Mapping | Description |
|---|---|
| BLD_EventType | Type of event associated with the blind receiving, such as creation, update, or cancellation. |
| BLD_TransferType | Indicates the transfer, such as interstore, warehouse to store, or supplier to warehouse. |
| BLD_InventoryTransferID | Unique identifier for the inventory transfer associated with the blind receiving. |
| BLD_OrderID | Unique identifier of the order related to this blind receiving. |
| BLD_PONumber | Purchase order number that the blind receiving is fulfilling. |
| BLD_BillOfLadingID | Identification number found on the Bill of Lading, a legal document between the shipper and carrier. |
| BLD_TrackingNumber | Tracking number provided by the shipping carrier for the shipment. |
| BLD_FromID | Identifier of the location or entity from which the goods are shipped. |
| BLD_ToID | Identifier of the destination location or entity to which the goods are being sent. |
| BLD_ProductCount | Total number of different products included in the blind receiving. |
| BLD_ProductImageLinks | URLs linking to images of the products included in the blind receiving. |
| BLD_Status | Current status of the blind receiving, such as pending, in transit, or received. |
| BLD_CreatedOn | Date and time the blind receiving was created. |
| BLD_DueOn | Expected date on which the goods arrive at their destination. |
| BLD_LastProcessedById | Unique identifier of the last user who processed the blind receiving. |
| BLD_LastProcessedByName | Name of the last user who processed the blind receiving. |
| BLD_UpdatedOn | Date and time that the blind receiving was last updated. |
| BLD_VendorID | Unique identifier of the vendor associated with the blind receiving. |
| BLD_ReceivedOn | Date and time that the goods were received. |
| BLD_CancelledOn | Date and time that the blind receiving was canceled, if applicable. |
| BLD_ExportDate | Date on which the blind receiving data was exported from the system. |
| BLD_ItemStatus | Status of individual items within the blind receiving, such as ordered, backordered, or canceled. |
| BLD_TransferID | Unique identifier for the transfer transaction associated with the blind receiving. |
| BLD_PalletID | Identification number of the pallet used in the shipment. |
| BLD_CartonID | Identification number of the carton used in the shipment. |
| BLD_ProductID | Unique identifier for each product listed in the blind receiving. |
| BLD_ProductTitle | Title or name of the product. |
| BLD_ProductImageURL | URL of the image representing the product. |
| BLD_QuantityOrdered | Quantity of the product ordered. |
| BLD_QuantityTransferred | Quantity of the product that’s been transferred. |
| BLD_QuantityReceived | Quantity of the product that’s been received. |
| BLD_Shipper | Company or individual responsible for shipping the goods. |
| BLD_ShippedOn | Date and time that the goods were shipped. |
| BLD_ItemTrackingNumber | Tracking number associated with a specific item in the shipment. |
| BLD_EstimatedDeliveryOn | Estimated date of delivery of the goods. |
| BLD_DeliveredOn | Actual date on which the goods were delivered. |
| BLD_ReceivedBy | Individual or department that received the goods. |
| BLD_ReasonCode | Code that explains the reason for a return or adjustment. |
| BLD_ReasonText | Text description accompanying the reason code, explaining the context or details. |
| BLD_Color | Color spec of the product, if applicable. |
| BLD_Size | Size spec of the product, if applicable. |
| BLD_GTIN | Global Trade Item Number, a unique identifier for trade items developed by GS1. |
| BLD_ExternalDocNumber | Reference number to an external document related to the blind receiving. |
| BLD_ExternalLineNumber | Line number from an external document that correlates with a specific item in the blind receiving. |
| BLD_Description | Detailed description of the blind receiving or items within it. |
| BLD_SerialNumbers | Serial numbers of the products, if applicable. |
Corporate Transfers Inventory Events
Track key stages such as transfer creation, completion, and cancellation to monitor and manage inventory flow
CTS_TRANSFER_STARTED_EVENT
When an STS transfer is created in CMS, a file is created indicating that the transfer was created.
CTS_TRANSFER_COMPLETED_EVENT
After the store associate is done scanning all items and taps the "Complete Transfer" deep link, the transfer process finishes and a CTS_TRANSFER_COMPLETED_EVENT is triggered. This event creates a file with data of all the transferred items.
Each box that is shipped in a corporate transfer triggers this event.
CTS_TRANSFER_CANCELLED_EVENT
A file is created if a transfer was canceled.
Field Mappings
The table lists the available Field Mappings related to corporate transfers.
| Field Mapping | Description |
|---|---|
| CTS_EventType | Type of event associated with the corporate transfer, such as creation, update, or cancellation. |
| CTS_TransferType | Indicates the transfer, such as interstore, warehouse to store, or supplier to warehouse. |
| CTS_InventoryTransferID | Unique identifier for the inventory transfer associated with the corporate transfer. |
| CTS_OrderID | Unique identifier of the order related to this corporate transfer. |
| CTS_PONumber | Purchase order number that the corporate transfer is fulfilling. |
| CTS_BillOfLadingID | Identification number found on the Bill of Lading, a legal document between the shipper and carrier. |
| CTS_TrackingNumber | Tracking number provided by the shipping carrier for the shipment. |
| CTS_FromID | Identifier of the location or entity from which the goods are shipped. |
| CTS_ToID | Identifier of the destination location or entity to which the goods are being sent. |
| CTS_ProductCount | Total number of different products included in the corporate transfer. |
| CTS_ProductImageLinks | URLs linking to images of the products included in the corporate transfer. |
| CTS_Status | Current status of the corporate transfer, such as pending, in transit, or received. |
| CTS_CreatedOn | Date and time the corporate transfer was created. |
| CTS_DueOn | Expected date on which the goods arrive at their destination. |
| CTS_LastProcessedById | Unique identifier of the last user who processed the corporate transfer. |
| CTS_LastProcessedByName | Name of the last user who processed the corporate transfer. |
| CTS_UpdatedOn | Date and time the corporate transfer was last updated. |
| CTS_VendorID | Unique identifier of the vendor associated with the corporate transfer. |
| CTS_ReceivedOn | Date and time the goods were received. |
| CTS_CancelledOn | Date and time the corporate transfer was canceled, if applicable. |
| CTS_ExportDate | Date on which the corporate transfer data was exported from the system. |
| CTS_ItemStatus | Status of individual items within the corporate transfer, such as ordered, back-ordered, or canceled. |
| CTS_TransferID | Unique identifier for the transfer transaction associated with the corporate transfer. |
| CTS_PalletID | Identification number of the pallet used in the shipment. |
| CTS_CartonID | Identification number of the carton used in the shipment. |
| CTS_ProductID | Unique identifier for each product listed in the corporate transfer. |
| CTS_ProductTitle | Title or name of the product. |
| CTS_ProductImageURL | URL of the image representing the product. |
| CTS_QuantityOrdered | Quantity of the product ordered. |
| CTS_QuantityTransferred | Quantity of the product that's been transferred. |
| CTS_QuantityReceived | Quantity of the product that's been received. |
| CTS_Shipper | Company or individual responsible for shipping the goods. |
| CTS_ShippedOn | Date and time the goods were shipped. |
| CTS_ItemTrackingNumber | Tracking number associated with a specific item in the shipment. |
| CTS_EstimatedDeliveryOn | Estimated date of delivery of the goods. |
| CTS_DeliveredOn | Actual date on which the goods were delivered. |
| CTS_ReceivedBy | Individual or department that received the goods. |
| CTS_ReasonCode | Code that explains the reason for a return or adjustment. |
| CTS_ReasonText | Text description accompanying the reason code, explaining the context or details. |
| CTS_Color | Color spec of the product, if applicable. |
| CTS_Size | Size spec of the product, if applicable. |
| CTS_GTIN | Global Trade Item Number, a unique identifier for trade items developed by GS1. |
| CTS_ExternalDocNumber | Reference number to an external document related to the corporate transfer. |
| CTS_ExternalLineNumber | Line number from an external document that correlates with a specific item in the corporate transfer. |
| CTS_Description | Detailed description of the corporate transfer or items within it. |
| CTS_UploadNumber | Transfer group in a multitransfer corporate transfer file. Learn More |
Cycle Count Inventory Events
Track and manage inventory efficiently, and obtain real-time updates on the cycle count status.
CYC_TRANSFER_CREATED_EVENT
The CYC_TRANSFER_CREATED_EVENT occurs if a new cycle count transfer is initiated within the inventory management system. This event signifies the creation of a transfer request specifically for cycle counting purposes. If this event is triggered, it means that a cycle count was scheduled or requested, but the counting process hasn't commenced.
CYC_TRANSFER_STARTED_EVENT
If the cycle-counting process begins, the CYC_TRANSFER_STARTED_EVENT is generated. This event indicates that the actual counting of inventory items started.
CYC_TRANSFER_COMPLETED_EVENT
When the cycle-counting process finishes, the CYC_TRANSFER_COMPLETED_EVENT is triggered. This event marks the end of the counting phase and indicates that all items scheduled for cycle counting were verified and accounted for.
CYC_TRANSFER_CANCELLED_EVENT
In certain situations, a cycle count transfer can be canceled before or during the counting process. The CYC_TRANSFER_CANCELLED_EVENT is generated if such a cancellation occurs. This event serves as a notification that the cycle count transfer was terminated, and no further counting activities cancoccur.
Field Mappings
The table lists the available Field Mappings related to cycle counts.
| Field Mapping | Description |
|---|---|
| CYC_StoreID | Identifies the store conducting the cycle count. |
| CYC_CycleCountID | Unique identifier for the cycle count event. |
| CYC_CycleCountType | Specifies the type of cycle count (for example full, partial). |
| CYC_CycleCountStatus | Status of the cycle count (for example planned, in progress, completed). |
| CYC_CreatedFrom | Origin of the cycle count creation (for example manual entry, system generated). |
| CYC_CycleCountDate | Date the cycle count is conducted. |
| CYC_Name | Name assigned to the cycle count event. |
| CYC_Description | Detailed description of the cycle count event. |
| CYC_PartialCycleCountProductAttribute | Attribute used for partial cycle counts (for example category, brand). |
| CYC_PartialCycleCountProductAttributeValues | Specific values of the attribute selected for partial cycle counts. |
| CYC_ProductCategories | Categories of products included in the cycle count. |
| CYC_ProductIDs | IDs of products included in the cycle count. |
| CYC_CreatedBy | Identifier of the user who created the cycle count record. |
| CYC_UpdatedBy | Identifier of the user who last updated the cycle count record. |
| CYC_StartedByStoreAssociateID | Store associate ID of who started the cycle count. |
| CYC_UpdatedByStoreAssociateID | Store associate ID who last updated the cycle count. |
| CYC_ExpectedQuantity | Total expected quantity of items before the cycle count. |
| CYC_ExternalReferenceID | External reference ID linked to the cycle count (if applicable). |
| CYC_CountedQuantity | Total quantity of items counted during the cycle count. |
| CYC_ExpectedProductValue | Total expected value of products before the cycle count. |
| CYC_CountedProductValue | Total value of products counted during the cycle count. |
| CYC_VariancePercentageQuantity | Percentage variance between expected and counted quantities. |
| CYC_VariancePercentageProductValue | Percentage variance between expected and counted product values. |
| CYC_VarianceQuantity | Difference between the expected and counted quantities. |
| CYC_VarianceProductValue | Difference between the expected and counted product values. |
| CYC_email | Email associated with the cycle count event or contact. |
| CYC_EventType | Type of event triggering the cycle count (if applicable). |
| CYC_StartTimeStamp | Timestamp of the cycle count that started. |
| CYC_ProductID | ID of a specific product involved in the cycle count. |
| CYC_GTIN | Global Trade Item Number of the product involved in the cycle count. |
| CYC_ProductTitle | Title or name of the product involved in the cycle count. |
| CYC_ProductImageURL | URL of the product image involved in the cycle count. |
| CYC_Color | Color attribute of the product involved in the cycle count. |
| CYC_Size | Size attribute of the product involved in the cycle count. |
| CYC_UnitProductValue | Unit value of the product involved in the cycle count. |
| CYC_Excluded | Indicates if the product is excluded from the cycle count (true/false). |
| CYC_ReasonCode | Code representing the reason for a variance or exclusion in the cycle count. |
| CYC_CreatedTimeStamp | Timestamp of the cycle count record that was created. |
| CYC_ModifiedTimeStamp | Timestamp of the cycle count record that was last modified. |
| CYC_ReasonText | Text explanation for the reason code assigned to a variance or exclusion. |
| CYC_ScannedProductSerialNumbers | Serial numbers of scanned products during the cycle count. |
| CYC_ItemVariancePercentageQuantity | Item-level percentage variance between expected and counted quantities. |
| CYC_ItemVariancePercentageProductValue | Item-level percentage variance between expected and counted product values. |
| CYC_ItemVarianceQuantity | Item-level difference between the expected and counted quantities. |
| CYC_ItemVarianceProductValue | Item-level difference between the expected and counted product values. |
| CYC_ItemExpectedQuantity | Expected quantity of a specific item before the cycle count. |
| CYC_ItemCountedQuantity | Counted quantity of a specific item during |
| CYC_ItemExpectedProductValue | Expected value of quantity of a specific item before the cycle count. |
| CYC_ItemCountedProductValue | Counted value quantity of a specific item during |
| CYC_ItemRecountCount | Number of times cycle count has been recounted |
| CYC_SerialNumbers | Serial numbers of product, if applicable. |
Inventory Adjustment Events
This event occurs if an adjustment has been made to a product.
For more information about inventory adjustments, refer to Managing Inventory: Inventory Adjustment Batch.
Field Mappings
The table lists the available Field Mappings related to inventory adjustments.
| Field Mapping | Description |
|---|---|
| INA_EventType | Identifies the type of inventory adjustment event (for example Inventory_Adjustment). |
| INA_StoreID | The ID of the store where the inventory adjustment takes place. |
| INA_ProductID | The ID of the product subject to inventory adjustment. |
| INA_ProductTitle | The title or name of the product being adjusted. |
| INA_ProductImageURL | The URL for the image of the product being adjusted. |
| INA_Color | The color of the product being adjusted, if applicable. |
| INA_Size | The size of the product being adjusted, if applicable. |
| INA_CountedQuantity | The quantity of the product after adjustment. |
| INA_StartedByStoreAssociateID | The ID of the store associate who initiated the inventory adjustment. |
| INA_UpdatedByStoreAssociateID | The ID of the store associate who last updated the inventory adjustment record. |
| INA_CreatedTimeStamp | The timestamp that the inventory adjustment record was created. |
| INA_ModifiedTimeStamp | The timestamp that the inventory adjustment record was last modified. |
| INA_Reason | A code identifying the reason for the inventory adjustment (for example correction, damage). |
| INA_ReasonText | A textual description of the reason for the inventory adjustment. |
| INA_Gtin | The Global Trade Item Number (GTIN) of the product being adjusted. |
| INA_ScannedProductSerialNumbers | The serial numbers of the product being adjusted, if scanned during the process. |
| INA_ID | The unique identifier for the inventory adjustment record. |
| INA_ItemHierarchyId | Identifies the hierarchy level or category of the product within the inventory system. |
| INA_SerialNumbers | Serial numbers of product, if applicable. |
Inventory Bucket Adjustment Events
This event occurs if an adjustment to an inventory bucket is made for a product.
For more information about these events, refer to Inventory Movement via POS App.
Field Mappings
The table lists the available Field Mappings related to inventory bucket adjustments.
| Field Mapping | Description |
|---|---|
| INBA_StoreId | Exports the store ID where inventory adjustments occurred. |
| INBA_ProductId | Exports the ID of the adjusted product in inventory. |
| INBA_QuantityOnHand | Exports the current total available quantity of the product in the store. |
| INBA_Quantity | Exports the quantity change for the product during the adjustment event. |
| INBA_AllocatedQuantity | Exports the quantity of the product allocated for orders. |
| INBA_QuantityInTransit | Exports the quantity of the product en route to the store. |
| INBA_QuantityOnOrder | Exports the quantity of the product ordered from suppliers but not yet received. |
| INBA_FloorDemoQuantity | Exports the quantity of the product reserved for in-store demos. |
| INBA_NotForSaleQuantity | Exports the quantity of the product not available for sale (for example damaged, reserved). |
| INBA_ReturnedItemsQuantity | Exports the quantity of returned products awaiting restocking or processing. |
| INBA_SafetyStockQuantity | Exports the minimum stock level maintained to prevent stockouts (safety stock). |
Purchase Order Inventory Events
Track the lifecycle of purchase order transfers, which helps to analyze purchase order data and manage inventory effectively
PO_TRANSFER_STARTED_EVENT
This event marks the initiation of a purchase order transfer, indicating that the process of transferring items from one location to another has commenced.
PO_TRANSFER_COMPLETED_EVENT
If you confirm a created purchase order on the POS app, this event is triggered. It means that the first steps in making the purchase order are done and the purchase order is ready to process further.
PO_TRANSFER_SHIPPED_EVENT
This event is generated if items from a purchase order transfer are shipped from the source location to their intended destination.
PO_TRANSFER_RECEIVED_EVENT
When the transferred items are received, this event confirms that the items were accepted and received at the designated location.
PO_TRANSFER_ERRORED_EVENT
In case of any errors or issues during a purchase order transfer, this event is triggered to alert relevant parties about the encountered problems.
PO_TRANSFER_CANCELLED_EVENT
If a client decides to cancel a purchase order transfer, this event indicates the termination of the transfer process.
Field Mappings
The table lists the available Field Mappings related to purchase orders.
| Field Mapping | Description |
|---|---|
| PO_TransferType | Specifies the type of purchase order event (for example PO_TRANSFER_CANCELLED_EVENT) |
| PO_InventoryTransferID | A unique identifier for the inventory transfer linked to the purchase order. |
| PO_ToID | The ID of the destination location (for example store, warehouse) for the inventory being ordered. |
| PO_ProductCount | The total number of different products included in the purchase order. |
| PO_CreatedOn | The date and time that the purchase order was created. |
| PO_ProductID | The ID of a specific product included in the purchase order. |
| PO_ProductTitle | The title or name of the product ordered. |
| PO_QuantityOrdered | The quantity of the product ordered in the purchase order. |
| PO_CostPrice | The cost price of a unit of the product as specified in the purchase order. |
| PO_CasePackQuantity | The quantity of units in each case pack of the product ordered. |
| PO_TotalCost | The total cost of the purchase order, calculated as the sum of the cost price of all products ordered. |
Store-to-Store Inventory Transfer Events
Maintain accurate inventory and track the movement of goods with a comprehensive view of each transfer.
STS_TRANSFER_STARTED_EVENT
After a store associate creates or closes a new transfer, STS_TRANSFER_STARTED_EVENT is triggered. If you decide to listen to this event, a file is created on the destination site to indicate that a new store transfer started.
STS_TRANSFER_COMPLETED_EVENT
The STS_TRANSFER_COMPLETED_EVENT occurs when the transfer is received at the destination store. This event signifies that the entire transfer process, from the source store to the destination store, was finalized without any issues.
STS_TRANSFER_SHIPPED_EVENT
If the store transfer is shipped from the source store to the destination store, the STS_TRANSFER_SHIPPED_EVENT is generated. This event indicates that the items are now in transit to their destination.
STS_TRANSFER_CANCELLED_EVENT
In cases where a store transfer needs to be canceled for any reason, the STS_TRANSFER_CANCELLED_EVENT is triggered. This event informs all relevant parties that the transfer was canceled, with no further action taken to complete it.
STS_TRANSFER_ERRORED_EVENT
In situations where errors or issues occur during the store transfer process, the STS_TRANSFER_ERRORED_EVENT is triggered. This event alerts relevant parties about problems or failures encountered during the transfer.
Field Mappings
The table lists the available Field Mappings related to store-to-store transfers.
| Field Mapping | Description |
|---|---|
| STS_EventType | Type of event associated with the store-to-store transfer, such as creation, update, or cancellation. |
| STS_TransferType | Indicates the transfer, typically labeled as "Store to Store". |
| STS_InventoryTransferID | Unique identifier for the inventory transfer associated with the store-to-store transfer. |
| STS_OrderID | Unique identifier of the order related to this store-to-store transfer. |
| STS_PONumber | Purchase order number that the store-to-store transfer is fulfilling or associated with. |
| STS_BillOfLadingID | Identification number found on the Bill of Lading, a legal document between the shipper and carrier. |
| STS_TrackingNumber | Tracking number provided by the shipping carrier for the transfer. |
| STS_FromID | Identifier of the location or store from which the goods are being transferred. |
| STS_ToID | Identifier of the destination store to which the goods are being transferred. |
| STS_ProductCount | Total number of different products included in the store-to-store transfer. |
| STS_ProductImageLinks | URLs linking to images of the products included in the store-to-store transfer. |
| STS_Status | Current status of the store-to-store transfer, such as pending, in transit, or received. |
| STS_CreatedOn | Date and time that the store-to-store transfer was created. |
| STS_DueOn | Expected date on which the transferred goods arrive at the destination store. |
| STS_LastProcessedById | Unique identifier of the last user who processed the store-to-store transfer. |
| STS_LastProcessedByName | Name of the last user who processed the store-to-store transfer. |
| STS_UpdatedOn | Date and time that the store-to-store transfer was last updated. |
| STS_VendorID | Unique identifier of the vendor involved, if applicable. |
| STS_ReceivedOn | Date and time that the transferred goods were received at the destination store. |
| STS_CancelledOn | Date and time that the store-to-store transfer was canceled, if applicable. |
| STS_ExportDate | Date on which the store-to-store transfer data was exported from the system. |
| STS_ItemStatus | Status of individual items within the store-to-store transfer, such as transferred, received, or canceled. |
| STS_TransferID | Unique identifier for the transfer transaction associated with the store-to-store transfer. |
| STS_PalletID | Identification number of the pallet used in the transfer. |
| STS_CartonID | Identification number of the carton used in the transfer. |
| STS_ProductID | Unique identifier for each product listed in the store-to-store transfer. |
| STS_ProductTitle | Title or name of the product being transferred. |
| STS_ProductImageURL | URL of the image representing the product being transferred. |
| STS_QuantityOrdered | Quantity of the product originally ordered for the transfer. |
| STS_QuantityTransferred | Quantity of the product that's been transferred to the destination store. |
| STS_QuantityReceived | Quantity of the product that's been received by the destination store. |
| STS_Shipper | Company or individual responsible for shipping the transferred goods. |
| STS_ShippedOn | Date and time that the goods were shipped to the destination store. |
| STS_ItemTrackingNumber | Tracking number associated with a specific item in the transfer. |
| STS_EstimatedDeliveryOn | Estimated date of delivery for the transferred goods. |
| STS_DeliveredOn | Actual date on which the transferred goods were delivered to the destination store. |
| STS_ReceivedBy | Individual or department that received the transferred goods at the destination store. |
| STS_ReasonCode | Code that explains the reason for any adjustments or discrepancies. |
| STS_ReasonText | Text description accompanying the reason code, explaining the context or details. |
| STS_Color | Color spec of the product, if applicable. |
| STS_Size | Size spec of the product, if applicable. |
| STS_GTIN | Global Trade Item Number, a unique identifier for trade items developed by GS1. |
| STS_ExternalDocNumber | Reference number to an external document related to the store-to-store transfer. |
| STS_ExternalLineNumber | Line number from an external document that correlates with a specific item in the transfer. |
| STS_Description | Detailed description of the store-to-store transfer or items within it. |
| STS_SerialNumbers | Serial numbers of the products being transferred, if applicable. |
