Skip to main content
PATCH
Update 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}$
partner_id
string<shortuuid>
required

Identifier of the trading partner.

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

Body

application/json

The trading-partner fields to change. Send only the fields you are changing.

name
string | null

New name, up to 255 characters, unique within the organization.

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

New location description.

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

New Global Location Number; null clears it.

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

New FDA Establishment Identifier, up to 32 characters.

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

New contact name, up to 255 characters.

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

New contact email address.

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

New contact phone number, up to 40 characters.

Pattern: ^[^\x00]{0,}$
is_exempt
boolean | null

New exemption flag.

Response

OK

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.