Inventory ledger updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

InventoryLedgerSchema · object

required

Show child attributes

data.id

string

The unique ID of the inventory item.

Example:

"inv_id"

data.created_date

string<date-time>

The date the inventory item was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the inventory item was last updated.

Example:

"2022-01-02T05:05:05Z"

data.entry_date

string<date-time>

The timestamp of the inventory ledger entry.

Example:

"2025-01-01T00:00:00Z"

data.inventory_item_id

string

The unique ID of the inventory item.

Example:

"inventory_item_id"

data.sku

string

The SKU of the inventory item.

Example:

"sku"

data.quantity

integer

The quantity of the inventory item being added or removed.

Example:

1

data.raw_event_type

string | null

The raw event that occurred resulting in the inventory ledger entry.

Example:

"receipt_into_system"

data.event_type

enum<string>

The event that occurred resulting in the inventory ledger entry.

Available options:

adjustment,

return_receipt,

inbound_receipt,

order_shipment,

supplier_return,

movement,

other

Example:

"inbound_receipt"

data.reason

string | null

The reason for the inventory ledger entry.

Example:

"reason"

data.object_id

string | null

The unique ID of the object that caused the inventory ledger entry.

Example:

"inbound_shipment_id"

data.object_type

enum<string> | null

The type of object that caused the inventory ledger entry.

Available options:

order,

inbound_shipment,

return

Example:

"inbound_shipment"

data.warehouse_id

string | null

The unique ID of the source warehouse.

Example:

"source_warehouse_id"

data.location_id

string | null

The unique ID of the source location.

Example:

"source_location_id"

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"inventory_ledger.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

previous_attributes

InventoryLedgerSchema · object

required

Show child attributes

previous_attributes.id

string

The unique ID of the inventory item.

Example:

"inv_id"

previous_attributes.created_date

string<date-time>

The date the inventory item was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.updated_date

string<date-time>

The date the inventory item was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.entry_date

string<date-time>

The timestamp of the inventory ledger entry.

Example:

"2025-01-01T00:00:00Z"

previous_attributes.inventory_item_id

string

The unique ID of the inventory item.

Example:

"inventory_item_id"

previous_attributes.sku

string

The SKU of the inventory item.

Example:

"sku"

previous_attributes.quantity

integer

The quantity of the inventory item being added or removed.

Example:

1

previous_attributes.raw_event_type

string | null

The raw event that occurred resulting in the inventory ledger entry.

Example:

"receipt_into_system"

previous_attributes.event_type

enum<string>

The event that occurred resulting in the inventory ledger entry.

Available options:

adjustment,

return_receipt,

inbound_receipt,

order_shipment,

supplier_return,

movement,

other

Example:

"inbound_receipt"

previous_attributes.reason

string | null

The reason for the inventory ledger entry.

Example:

"reason"

previous_attributes.object_id

string | null

The unique ID of the object that caused the inventory ledger entry.

Example:

"inbound_shipment_id"

previous_attributes.object_type

enum<string> | null

The type of object that caused the inventory ledger entry.

Available options:

order,

inbound_shipment,

return

Example:

"inbound_shipment"

previous_attributes.warehouse_id

string | null

The unique ID of the source warehouse.

Example:

"source_warehouse_id"

previous_attributes.location_id

string | null

The unique ID of the source location.

Example:

"source_location_id"

previous_attributes.additional_fields

object

Integration-specific fields

Show child attributes

previous_attributes.additional_fields.{key}

any

Example:

{ "key": "value" }

Response

200

Success

Home

How-To Guides

Use Cases

Inventory ledger updated

Body

Response