GET
View a stock correction
Company space For: Stock keeper, Manager · Permission: stock_regularizations.retrieve Part of Correct stock and declare damage.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

stockRegularization
string
required

Identifier of the stock correction (27-character KSUID).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, motif, input_mode, created_by_user_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: lines, lines.stockable, lines.stockableUnit.

Response

200 - application/json

Resource.

id

Identifier of the stock correction (27-character KSUID).

motif

Reason given for the correction, up to 250 characters.

input_mode

How line quantities were read: difference (signed change) or final_stock (counted quantity).

created_by_user_id

Identifier of the member who recorded the correction; null when it could not be determined.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).

lines
array

Lines of the correction; only present when selected with the include query parameter.