The stocktake object

AttributeDescription
idUnique identifier for the object.
stocktake_numberA string used to identify the stocktake.
location_idThe ID the stocktake location.
statusStatus of the order. Possible values are “NOT_STARTED”, “IN_PROGRESS”, "COUNTED", and “COMPLETED”.
reasonA descriptive field for your own information to enable better identification.
additional_infoA string attached to the object to add any internal comments, links to external files, additional instructions, etc.
stocktake_created_dateThe timestamp of creating the stocktake document. ISO 8601 format with time and timezone must be used.
started_dateThe timestamp of starting the stocktake. ISO 8601 format with time and timezone must be used.
completed_dateThe timestamp of completing the stocktake. ISO 8601 format with time and timezone must be used.
status_update_in_progressIndicates whether the status update is still in progress. You cannot make additional updates to stocktake or its rows while the status update is in progress.
set_remaining_items_as_countedIndicates what happens with the stock of items listed on the stocktake without quantity. If set to true, the stock levels for these item variants will be adjusted to 0 after the stocktake is completed.
stock_adjustment_idThe ID of the stock adjustment that was created as a result of the stocktake.
created_atThe timestamp when the stocktake was created.
updated_atThe timestamp when the stocktake was last updated.
deleted_atThe timestamp when the stocktake was deleted.