Consignment

Type.

No description

Fields

•

ID!

Required

No description

assessedLandedCost

•

LandedCost

CBP assessed landed cost (duty, tax, fees). Resolved via federation.

consigneeName

•

String

Consignee display name, captured from the DESTINATION party when the consignment was created. Null on older consignments — read the parties for those. The party record remains authoritative.

createdAt

•

DateTime!

Required

No description

createdBy

•

ID!

Required

Identifier of the user or service that created the record.

currencyCode

•

CurrencyCode!

Required

Currency of declared value.

declaredValue

•

Decimal!

Required

Declared commercial value.

exportingCountry

•

CountryCode!

Required

Last country the goods were exported from. May differ from shipFromCountry (e.g., goods made in CN, exported from AU).

handlingUnits

•

[HandlingUnit!]!

Required

Handling units in this consignment.

items

•

[Item!]!

Required

Items in this consignment. Resolved via federation.

landedCost

•

LandedCost

Zonos LandedCost estimate (pre-filing quote). Resolved via federation.

natureOfTransaction

•

BrokerageNatureOfTransaction

Nature of the import transaction.

parties

•

[Party!]!

Required

Parties on this consignment. Resolved via federation.

pgaAgencies

•

[ConsignmentPgaAgency!]

Partner Government Agency requirements applicable to this consignment, derived from item HTS codes and ship-to country at creation. REQUIRED entries always trigger a filing data gather; CONDITIONAL entries are resolved before filing.

referenceNumber

•

String

External identifier used for de-duping.

requiredPgaAgencies

•

[String!]

Partner Government Agency codes requiring clearance (e.g. FDA, AMS, EPA). Derived from item HTS codes.

shipFromCountry

•

CountryCode!

Required

Ship-from country (country of origin).

status

•

ConsignmentStatus!

Required

Current status of this consignment.

statusTransitions

•

[StatusTransition!]!

Required

Append-only history of status changes for this consignment.

trackingNumber

•

String!

Required

Package tracking number. Not renamed to houseBillOfLading because for Type 11 postal/express entries this is a parcel tracking number, not a bill of lading.

updatedAt

•

DateTime!

Required

No description

updatedBy

•

ID!

Required

Identifier of the user or service that last updated the record.

Fields

Was this page helpful?