Skip to main content
POST
Create production process

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload for POST /production-processes.

gtin
string<gtin>
required

GTIN (8, 12, 13 or 14 digits) of the product. Must be a product the caller's organization owns, else 404.

Required string length: 8 - 14
process_type_code
string
required

Code of an active process type (GET /process-types), else 404.

Required string length: 1 - 50
Pattern: ^[^\x00]{1,50}$
description
string
default:""

Free-text description.

Maximum string length: 1000
Pattern: ^[^\x00]{0,1000}$
start_date
string<date> | null

When the stage began.

end_date
string<date> | null

When the stage ended. Not before start_date, else 422.

process_reference
string
default:""

Your own batch or lot reference.

Maximum string length: 100
Pattern: ^[^\x00]{0,100}$

Response

Created

A production process stage of one of the organization's products.

id
string<shortuuid>
required

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}$
organization_id
string<shortuuid>
required

The organization that owns the product.

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

The product's GTIN, normalized to GTIN-14.

created
string<date-time>
required

Server-side ISO 8601 timestamp of creation (UTC).

modified
string<date-time>
required

Server-side ISO 8601 timestamp of last modification (UTC).

process_type_code
string
required

Code of the process type, from GET /process-types.

description
string
required

Free-text description. Empty when unset.

start_date
string<date> | null
required

When the stage began. Null when unset.

end_date
string<date> | null
required

When the stage ended. Null when unset.

process_reference
string
required

Your own batch or lot reference. Empty when unset.