Skip to main content
POST
Create a reference document

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 reference document to create.

document_type
string
required

Kind of document: bill_of_lading, purchase_order, invoice, receipt, advance_ship_notice, transaction_statement or other. Anything else is refused with 422.

Pattern: ^[^\x00]{0,}$
document_number
string
required

The document's number, up to 128 characters; unique per type within the organization.

Required string length: 1 - 128
Pattern: ^[^\x00]{1,128}$
issued_date
string<date> | null

Date the document was issued (YYYY-MM-DD).

notes
string
default:""

Free-text notes.

Pattern: ^[^\x00]{0,}$

Response

Created

A bill of lading, purchase order or other document a Critical Tracking Event can cite.

id
string<shortuuid>
required

Identifier of the reference document.

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

Kind of document: bill_of_lading, purchase_order, invoice, receipt, advance_ship_notice, transaction_statement or other.

document_number
string
required

The document's number, unique per type within the organization.

notes
string
required

Free-text notes; may be empty.

issued_date
string<date> | null

Date the document was issued, or null when not recorded.