Backend API

Fields
idobjectId

Unique identifier for the stock adjustment.

date_createddateauto

Date and time the stock adjustment was created.

date_updateddateauto

Date and time the stock adjustment was last updated.

descriptionstring

A brief description of the stock entry.

levelint

New stock level after the adjustment is applied.

locationstring

Location associated to the stock entry, if applicable.

transfer_locationstring

Second location used in a transfer operation.

referenced_transfer_idobjectId

ID of the referenced transfer operation that removed stock.

cancelation_group_idstring

Identifier used to restore all archived stock entries as a group.

numberstringauto

Auto-incremented stock adjustment number.

orderOrder

Expandable link to an order, if applicable to the stock adjustment.

order_idobjectId

ID of an order when the stock adjustment was either reduced by the sale of a product, or increased by cancelling an order. Adjustments from orders are created automatically when stock tracking is enabled.

parentProduct

Expandable link to the parent product.

parent_idobjectIdrequired

ID of the parent product.

prevStock

Link to the previous stock adjustment.

prev_idobjectId

ID of the previous stock adjustment.

quantityintrequired

Quantity of the adjustment. A positive number means stock was increased, and a negative number means stock was decreased.

reasonenum

Enumerated reason for the stock adjustment. Can be received, returned, canceled, sold, missing, damaged, transfer_remove, or transfer_add.

Possible enum values:

receivedreturnedcanceledsoldmissingdamagedtransfer_removetransfer_add
reason_messagestring

A brief description of the reason for the stock adjustment.

variantProduct variant

Expandable link to the parent variant, if applicable.

variant_idobjectId

ID of the parent variant, if applicable.

The stock model
{
  "id": "60f199509111e7000000005f",
  "parent_id": "60f199509111e70000000062",
  "date_created": "2021-07-16T14:36:00.321Z",
  "date_updated": "2021-07-16T14:36:00.321Z",
  "level": 20,
  "number": 1029376,
  "reason": "received",
  "reason_message": "Restock - PO #47362",
  "variant_id": "60f199509111e70000000061"
}