Type.

CustomsRequirement

A static, carrier-driven definition of a regulatory data field that must be collected for a given lane and HS code set.

Fields

•

ID!

Required

No description

conditions

•

[CustomsRequirementCondition!]

Boolean condition logic for CONDITIONAL requirements.

displayOrder

•

Int

Recommended display order within the field's group.

exportCountry

•

CountryCode

Export country this requirement applies to.

fieldAlias

•

String

Human-friendly alias used for matching against catalog/product attributes.

fieldKey

•

String!

Required

Stable identifier for this field.

fieldType

•

CustomsRequirementFieldType!

Required

Input type the field expects.

groupKey

•

String!

Required

Identifier for the group this field belongs to.

hsCodes

•

[String!]!

Required

HS codes that activate this requirement on this lane.

importCountry

•

CountryCode

Import country this requirement applies to.

isRequired

•

CustomsRequirementRequiredness!

Required

Whether the field must be provided.

label

•

String!

Required

Human-readable label.

refreshedAt

•

DateTime!

Required

When the lane this requirement belongs to was last refreshed from the carrier.

regulation

•

String!

Required

Regulating agency (e.g., "FDA").

regulationSections

•

[String!]!

Required

All regulation sub-sections this field applies to.

scope

•

CustomsRequirementScope!

Required

Whether the field is collected once per shipment or per product.

tooltip

•

String

Tooltip / help text describing the field.

validation

•

CustomsRequirementValidation

Validation rules applied to the field's value.

Fields

Was this page helpful?