| Name | Description |
|---|---|
| Root | The top level document |
| SecurityFiling | An individual security filing. |
| Container | A container used to ship goods |
| Address | A physical location. |
| Organization | An organization associated to this filing. |
| ISFLine | An representation of a ISF Lines |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always security_filing_json | |
security_filings | Array<SecurityFiling> | Array of security filings | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
containers | Array<Container> | Containers associated with the filing. | |
eta | DateTime | Estimated port arrival date for the shipment. | |
etd | DateTime | Estimated departure date for the shipment. | |
house_bill | String | The house bill of lading number | |
isf_lines | Array<ISFLine> | Products within the shipment associated to the filing. | |
master_bill | String | The master bill of lading associated with the house bill | |
ocean_bill | String | The ocean bill of lading number used for straight or simple bills of lading | |
organizations | Array<Organization> | Organizations associated with the filing. | |
po_number | String | The purchase order number associated to the filing. | |
reference_number | String | The shipper reference number associated to the filing. | |
shipment_type | String | Shipment type associated to the filing. | |
vessel_name | String | The vessel name for the shipment. | |
voyage_number | String | The voyage number for the shipment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
container_number | String | Identifying container number (including SCAC prefix) | |
container_type | String | ISO 6346 container type code (like 20GP) |
| Name | Data Type | Description | Required |
|---|---|---|---|
address_1 | String | The first line of the address. | |
address_2 | String | The second line of the address. | |
city | String | The city. | |
country | String | The 2-Digit ISO 3166 Alpha-2 Country Code. Like 'US' | |
postal_code | String | The postal or ZIP code. | |
state | String | The state, province, or administrative division code |
| Name | Data Type | Description | Required |
|---|---|---|---|
address | Address | The address of the organization. | |
company_name | String | The name of the organization. | |
type | String | Organization type. Valid types are: importer, seller, buyer, consignee, ship_to, cntr_stuffing_location, and consolidator |
| Name | Data Type | Description | Required |
|---|---|---|---|
country_of_origin | String | The 2-letter ISO code of the country of origin for the product. | |
hts_number | String | The product's primary harmonized tariff code. | |
manufacturer | Address | The manufacturer of the product represented by the line. | |
part_description | String | A description of the product. | |
part_number | String | The part number used to identify the product. |