Skip to main content
POST
Add lots to a lot group

Authorizations

X-API-Key
string
header
required

Path Parameters

group_id
string<shortuuid>
required

ID of the lot group.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

organization_id
string<shortuuid>

Organization that owns the addressed row. Optional: the row is found among every organization the caller can see. Naming one narrows the lookup to it.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload to add lots to a lot group.

lot_ids
string<shortuuid>[]
required

UUIDs of the lots to add (1 to 500), as the lots API returns them. A lot that is not one of the group's brand's is skipped, not added.

Required array length: 1 - 500 elements

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

What an add call did.

added
integer
required

How many of the sent ids were added or were already members. Ids that matched nothing of the group's brand are left out.