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

shipment
string
required

Body

application/json

A certificate of conformance to sign for a posted shipment, or a correction of its last one.

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.

correction_reason
string | null

Why the last certificate was wrong. Required when the shipment already has one, and kept with the new revision.

Maximum string length: 500

Response

ShipmentCertificateResource

data
ShipmentCertificateResource · object
required