BrokerageDocument

Type.

No description

Fields

•

ID!

Required

A unique ID for the document.

attributeKey

•

CompositionAttributeKey

Which material or composition property this document proves, such as COUNTRY_OF_SMELT. Required when documentType is one of the material or composition *_CERTIFICATE values.

createdAt

•

DateTime!

Required

When the document was uploaded.

documentType

•

BrokerageDocumentType!

Required

The kind of document.

expiresAt

•

DateTime

When the document expires. Expired documents are excluded from results by default. Null means it does not expire.

fileName

•

String

The name of the uploaded file.

fileType

•

CustomsDocumentFileType!

Required

The file format, such as PDF or PNG.

fileUrl

•

String!

Required

A URL where the file can be downloaded.

filingReferenceNumber

•

String

A reference number to send along with the document, such as an FDA facility registration number or a CPSC filing ID.

references

•

[DocumentReference!]!

Required

What this document is attached to. A document can be attached to more than one thing. An empty list means it applies to your whole organization, such as a power of attorney that covers every shipment.

shipFromCountry

•

[CountryCode!]

The origin countries this document covers. Leave empty to apply it to all origins.

shipToCountry

•

[CountryCode!]

The destination countries this document covers. Leave empty to apply it to all destinations.

status

•

BrokerageDocumentStatus!

Required

The current status of the document.

tradeAgreement

•

String

The free trade agreement this certificate is claimed under, such as USMCA or EU-UK_TCA. Set only when documentType is CERTIFICATE_OF_ORIGIN.

updatedAt

•

DateTime!

Required

When the document was last changed, including when it was deleted.

validFrom

•

DateTime

When the document becomes valid. This is the validity date on the document itself, not the date it was uploaded.

validTo

•

DateTime

When the document stops being valid.

Fields

Was this page helpful?