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

Identifier of the reference document.

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

Body

application/json

The reference-document fields to change. Send only the fields you are changing.

document_type
string | null

New kind of document; see create for the accepted values.

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

New document number, up to 128 characters.

Pattern: ^[^\x00]{0,}$
issued_date
string<date> | null

New issue date; null clears it.

notes
string | null

New notes.

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

Response

OK

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.