Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

order
string
required

Body

application/json

A shipment and the fields of the certificate of conformance signed with it: the fields of a shipment, and those of a certificate.

lines
object[]
required
Required array length: 1 - 50 elements
id
string<uuid> | null

A UUIDv7 the client chose for the shipment, so it can name the shipment before it hears back.

shipped_on
string<date> | null

Today when left out.

carrier
string | null
Maximum string length: 64
tracking_number
string | null
Maximum string length: 128
note
string | null
Maximum string length: 1000
packages
object[] | null

The parcels it left in, as packed.

Maximum array length: 20
customer_reference
string | null

The customer's purchase order number, printed on the certificate.

Maximum string length: 64
contract_number
string | null

The contract the goods were bought under, printed on the certificate.

Maximum string length: 64
contact_id
string<uuid> | null

The customer contact to email the signed PDF to. None is emailed when left out.

Response

ShipmentResource

data
ShipmentResource · object
required