PUT
Label a stock lot
Company space For: Stock keeper, Manager · Permission: inventory_stocks.label Conditions
  • The lot (stock group) must sit at a location the current company is allowed to use.
  • stock_label_id is required, is 27 characters long and must be a label of the same organization as the lot; otherwise a validation error is returned.
What else happens
  • Puts the label on the lot, or replaces the previous label: a lot carries at most one label.
  • Adds nothing to stock quantities or costs.
Part of Check stock levels and label lots.

Authorizations

Authorization
string
header
required

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

Path Parameters

group_id
string
required

Identifier of the stock lot (stock group), a 27-character KSUID string shared by the stock rows of one lot, as returned in the groups of the stock listings.

Query Parameters

response
enum<string>
default:none

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

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: group_id.

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: label.

Body

application/json
stock_label_id
string
required

Identifier of the stock label to put on the lot (27-character KSUID string). It must belong to the same organization as the lot. Replaces any previous label of the lot.

Required string length: 27

Response

Resource (only with response=resource).

group_id

Identifier of the lot (stock group) that was labelled.

label
object | null

The label now set on the lot, with id and name. Returned only when requested with include=label and ?response=resource.