Update a stocktake

Updates the specified stocktake by setting the values of the parameters passed.
Any parameters not provided will be left unchanged. Status updates can take a long time so 204 is returned.
If you need to continue with updates on same entity or its rows,
you need to poll if status update has ended (status_update_in_progress) and continue after that.
Moving to COUNTED or COMPLETED rechecks each row's stock (rechecked_in_stock_quantity). A COMPLETED request
leaves the stocktake COUNTED when a counted row's stock moved since counting started: recount those rows,
or send use_counts_for_changed_rows. See the Stocktaking workflows guides.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Stocktake id

Body Params

Stocktake fields to update. Location id should exist and belong to the factory.
Location id can be changed only when stocktake status is "notStarted".
Completed date can not be empty when stocktake status is "completed".

string
length ≥ 1
integer
≤ 2147483647
string
enum
Allowed:
string | null
string | null
string
length ≥ 1
string | null
boolean
Defaults to false
boolean

With status COMPLETED: rows whose stock moved during the count are completed with their counts, as long as their stock is still the one last rechecked (rechecked_in_stock_quantity). Without it, such rows leave the stocktake COUNTED for a recount.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
*/*
application/json