Skip to main content
POST
Create a trading partner

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

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

Body

application/json

A trading partner to create.

name
string
required

Name of the partner, up to 255 characters, unique within the organization.

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

Free-text description of the partner's location.

Pattern: ^[^\x00]{0,}$
gln
string | null

The partner's Global Location Number. One that is not in the registry is refused with 422.

Pattern: ^[^\x00]{0,}$
fda_fei
string
default:""

The partner's FDA Establishment Identifier, up to 32 characters.

Maximum string length: 32
Pattern: ^[^\x00]{0,32}$
contact_name
string
default:""

Name of a contact at the partner, up to 255 characters.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
contact_email
string
default:""

Email address of the contact. One that is not a valid address is refused with 422.

Pattern: ^[^\x00]{0,}$
contact_phone
string
default:""

Phone number of the contact, up to 40 characters.

Maximum string length: 40
Pattern: ^[^\x00]{0,40}$
is_exempt
boolean
default:false

Whether the partner is exempt from FSMA 204 recordkeeping.

Response

Created

A supplier, customer or other party the organization exchanges food with (FSMA 204 IPS / ISR).

id
string<shortuuid>
required

Identifier of the trading partner.

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

Name of the partner, unique within the organization.

location_description
string
required

Free-text description of the partner's location; may be empty.

fda_fei
string
required

The partner's FDA Establishment Identifier; empty when not set.

contact_name
string
required

Name of a contact at the partner; empty when not set.

contact_email
string
required

Email address of the contact; empty when not set.

contact_phone
string
required

Phone number of the contact; empty when not set.

is_exempt
boolean
required

Whether the partner is exempt from FSMA 204 recordkeeping, so the organization assigns lots.

gln
string | null

The partner's Global Location Number, or null when none is recorded.