Inventory Change Logs

The inventory_change_log object

A record of a single change to an item's on-hand inventory.

Every inventory movement — production scans, manual user adjustments, and automatic system actions — produces one entry, forming an audit trail of how on-hand quantities changed over time.

idstring

Inventory change log ID.

objectstringenumValues:inventory_change_log

Resource type identifier.

action_typestringenumValues:scanuser_actionsystem_action

Action that produced this inventory change.

  • scan: change driven by a scan, typically a production step.
  • user_action: change made manually by a user.
  • system_action: change made automatically by the system.
  • user_correction: manual adjustment a user made to correct an inventory discrepancy.
quantityquantitynullable

Amount of inventory this change applied.

The value is signed: positive values increased on-hand inventory, negative values decreased it.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

itemitemnullable

Item affected by this change.

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code, unique within the account.

descriptionstringnullable

Item description.

notesstringnullable

Free-form notes about the item.

typestringenumValues:productmaterialpart

What kind of item this is.

  • product: a finished product.
  • material: a raw material or component consumed in production.
  • part: a part used in production.
categoryitem_categorynullable

The category this item belongs to.

The category's unit group determines the base unit the item's rates (unit_value, unit_cost, burn_rate) are expressed in.

Always returned as null in this endpoint.
unit_valueratenullable

Selling value per unit, expressed as a rate (e.g. $25.50 / kg).

Always returned as null in this endpoint.
unit_costratenullable

Cost per unit, expressed as a rate (e.g. $10.00 / kg).

For items a production flow produces, retrieving the item's costs recomputes this from the flow and stores the result here, so it can change without the item having been edited.

Always returned as null in this endpoint.
burn_rateratenullable

Rate at which this item is consumed in production, expressed as a quantity over time (e.g. 100 kg / hr).

Always returned as null in this endpoint.
attributeslistnullable

Attributes assigned to this item.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

responsible_userusernullable

The user who made this change.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address the user signs in with and receives platform email at.

namestringnullable

User's full display name.

usernamestringnullable

Username the user can sign in with instead of their email address.

Usernames are unique across the whole platform, not just within your account.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

Location of the user's profile image.

For photos uploaded through the API this holds an internal path rather than a fetchable image URL; call Get User Photo URL to obtain a temporary link to the image itself.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

responsible_scanning_stationscanning_stationnullable

The scanning station this change came from.

Present only for changes recorded on the production floor, which have an action type of scan.

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name of the scanning station.

Unique within the account.

notesstringnullable

Free-form notes about the scanning station.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type, determining which batch operation an operator performs when they scan here.

  • init_batch: starts a new batch at the beginning of a production flow.
  • merge_batch: combines several scanned batches into one.
  • move_batch: advances a batch through a production step connected to this station.
  • split_batch: divides a batch into several batches.

Fixed when the station is created.

label_sizestringnullableenumValues:1x11x31x4

Size of the labels printed at this station, given as width-by-height (for example, 1x1).

label_typestringnullableenumValues:tagtraveler

Type of label printed at this station.

  • tag: a label attached to the physical product.
  • traveler: a routing sheet that accompanies the batch through every production step.
operator_requirementstringenumValues:nonematerial_check

Whether operators must perform a material check at this station.

  • none: no additional operator check is required.
  • material_check: a material check is expected before the operation.
departmentdepartmentnullable

The department this scanning station belongs to.

Assigned when the station is created and cannot be reassigned afterward.

Always returned as null in this endpoint.
production_stepslistnullable

Production steps connected to this station.

A production step can be connected to at most one scanning station, so connecting a step here disconnects it from any other station. Manage the connections with Connect Production Steps to Scanning Station.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Timestamp when this change was recorded.

updated_atstring (date-time)

Timestamp when this record was last updated.

Used by

GETList Inventory Change LogsInventory Change LogsGETRetrieve Inventory Change LogInventory Change LogsGETExport Inventory Change LogsInventory Change Logs