Inventory snapshots

You can view a snapshot of the inventory in a store at any time. Snapshot includes the inventory picture in the store at a specified time. You can also schedule to publish the inventory snapshots. For more information, see Inventory snapshot events V2

Note: Inventory snapshot events is deprecated and no longer supported in future releases. For updated instructions on supported technologies, see Inventory snapshot events V2

A snapshot of an item is calculated by aggregating its inventory adjustments over a period of time. A collection of such aggregations of different items reflect the inventory snapshot of the store.

When you schedule an Inventory snapshot event V2, you can capture data for multiple stores in one snapshot by passing a comma-separated list of unique store IDs. For example, Store1,Store2,Store3. The inventory snapshot captures data at the scheduled time and provides a real-time and accurate reflection of the inventory picture for a store. If a delay prevents the publishing of the inventory snapshot at the scheduled time, it is published later with the latest data, including the time of the data in the timestamp attribute. For example, if the inventory snapshot was scheduled for 8:00 AM but is published at 10:00 AM because of a delay, the snapshot shows the inventory as of 10:00 AM.

To request an Inventory snapshot event V2 for a store, use the Create inventory snapshot scheduled for the associated stores API.

URI:
/:tenantId/v1/inventory-snapshot-V2/scheduled-jobs
Request body:
{
"payload" : {"stores":"s1", "snapshotTimestamp" :
"2019-08-01T18:00:00-04:00", "webhookId": "123"}
}

To create an inventory snapshot schedule, define the webhookId that refers to an endpoint by using the Create Webhooks API.

For more information, see Store Inventory Management APIs.