ConsignmentCreateWorkflowInput

Input.

No description

Fields

bondType

•

String

Customs-bond type code (0 = none, 8 = continuous, 9 = single-transaction). Batch uploads set this from the CSV; sourced spreadsheet-first onto the formal-entry bond, with the customer config as fallback.

consolidationId

•

Existing consolidation to assign to. Null if transport context is not yet known.

currencyCode

•

CurrencyCode!

Required

Currency of declared value.

declaredValue

•

Decimal!

Required

Declared commercial value.

entryType

•

BrokerageEntryType

CBP entry type. Defaults to Type 13 postal entry.

exportingCountry

•

CountryCode!

Required

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

forceNotifications

•

Boolean!

Required

Force notifications requested by this create workflow. Currently this forces the compliance questionnaire notification when a session opens. Additional notification types can use this switch in the future. TEST mode sends only when this value is true. This does not enable scheduled reminders.

handlingUnits

•

[HandlingUnitInput!]

Physical packages in the consignment. Optional — handling units can also be added later.

iorNumber

•

String

Importer-of-record number for this consignment. Batch uploads set this from the CSV; this gives the non-batch workflow path the same field (null on legacy/non-batch flows that don't supply one).

natureOfTransaction

•

BrokerageNatureOfTransaction!

Required

Nature of the import transaction.

postalOperatorCode

•

PostalOperatorCode

Postal operator code (e.g., 'J1CAEA').

referenceNumber

•

String

External identifier used for de-duping.

shipFromCountry

•

CountryCode!

Required

Ship-from country (country of origin).

shipperAccountId

•

String

Shipper account code. Used to resolve the owning organization via partner lookup or shipper_organization mapping.

status

•

ConsignmentStatus

Initial lifecycle status. Defaults to CANDIDATE. Pass DRAFT to keep this consignment out of the filing pipeline.

suretyCode

•

String

Customs-bond surety company code. Batch uploads set this from the CSV; sourced spreadsheet-first onto the formal-entry bond, with the customer config as fallback.

trackingNumber

•

String!

Required

Primary tracking number for the consignment.

Related user guides

Supply Chain > Brokerage>Create a consignment

Fields

Related user guides

Was this page helpful?