Skip to main content
POST
Create supplier company

Authorizations

X-API-Key
string
header
required

Per-manufacturer API key in the X-API-Key header, format emidat-{key_id}-{secret} where key_id is a random public handle. Issued by an owner in the Emidat dashboard; carries its own permission scopes, optional plant restrictions, and optional expiry. A revoked, expired, or unknown key returns 401. See the Authentication guide for details.

Headers

Idempotency-Key
string

Optional client-generated key (e.g. a UUID) that makes a create idempotent — the only mechanism that does so. A replay carrying the same key returns the original response unchanged (200); reusing a key with a different request body is rejected with 409. Keys are scoped to your manufacturer and retained for 6h. See External IDs.

Body

application/json
plant_id
string<uuid>
required

UUID of the plant this supplier company belongs to.

name
string
required

Name of the supplier company. Must be unique case-insensitively among active supplier companies at this plant; duplicates return 409.

Example:

"Acme Materials GmbH"

external_id
string | null

Your own code for this supplier company. Optional. When provided it is unique among your active supplier companies — creating another with the same code returns 409 (see External IDs).

Example:

"SUPPLIER-ACME"

Response

Returned unchanged — an Idempotency-Key replay.

id
string<uuid>
required

UUID of the supplier company.

external_id
string | null
required

Your own code for this supplier company. null when none is set.

plant_id
string<uuid>
required

UUID of the plant this supplier company belongs to.

name
string
required
Example:

"Acme Materials GmbH"

created_at
string<date-time>
required