Skip to main content
POST
Create shipment

Authorizations

x-api-key
string
header
required

API key for authentication. Contact your administrator to get an API key.

Body

application/json

Shipment input data for creation/update

code
string
required

Shipment code

site_id
string<uuid>
required

Site ID

Response

Successfully created shipment

Shipment entity (API response)

id
string<uuid>

Unique identifier

code
string

code code

account_id
string<uuid>

Account ID

site_id
string<uuid>

Site ID

created_at
string<date-time>

Creation timestamp

soft_deleted
string<date-time>

Soft deletion timestamp

soft_deleted_by
string

User who soft deleted the record

updated_at
string<date-time>

Last update timestamp

emails_to_notify
string[]

Email address

risk_score
number | null

Risk score