addedInput schema / properties / customs
Added value: +{
+ "additionalProperties": false,
+ "description": "Customs fields to add or correct",
+ "properties": {
+ "commodities": {
+ "description": "One line per kind of goods. A line with description, code, country of origin, value, quantity and weight is complete; anything missing is collected by the forwarder after booking.",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "country_of_origin": {
+ "description": "Where the goods were made, ISO alpha-2",
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "description": {
+ "description": "Plain description of the goods",
+ "type": "string"
+ },
+ "eccn": {
+ "description": "US exports: ECCN; leave empty for EAR99 goods",
+ "type": "string"
+ },
+ "hs_code": {
+ "description": "No US end (between two other countries): 6-10 digit HS code",
+ "type": "string"
+ },
+ "hts_code": {
+ "description": "US imports: 10-digit HTS code",
+ "type": "string"
+ },
+ "license_type": {
+ "description": "US exports: license type or exception, e.g. NLR",
+ "type": "string"
+ },
+ "quantity": {
+ "minimum": 1,
+ "type": "integer"
+ },
+ "schedule_b": {
+ "description": "US exports: 10-digit Schedule B code",
+ "type": "string"
+ },
+ "value_usd": {
+ "description": "Total value of this line, USD",
+ "minimum": 0,
+ "type": "number"
+ },
+ "weight_lbs": {
+ "description": "Total weight of this line, lb",
+ "exclusiveMinimum": 0,
+ "type": "number"
+ }
+ },
+ "required": [
+ "description"
+ ],
+ "type": "object"
+ },
+ "maxItems": 50,
+ "type": "array"
+ },
+ "consignee_tax_id": {
+ "description": "Consignee tax id in its country's format",
+ "type": "string"
+ },
+ "customs_bond": {
+ "description": "US imports: customs bond number",
+ "type": "string"
+ },
+ "ear99_no_license": {
+ "description": "US exports: every item is EAR99 and needs no export license",
+ "type": "boolean"
+ },
+ "eei_authorization": {
+ "description": "US exports: the shipper authorizes the forwarder to file the EEI in AES. Needed when any one Schedule B line is over $2,500 or a license is required, unless an ITN is given.",
+ "type": "boolean"
+ },
+ "exporter_of_record": {
+ "additionalProperties": false,
+ "description": "Only when someone other than the shipper is the exporter of record",
+ "properties": {
+ "city": {
+ "type": "string"
+ },
+ "contact_name": {
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "description": "Company name, Latin characters",
+ "type": "string"
+ },
+ "phone": {
+ "description": "International format, e.g. +862150000000",
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "street": {
+ "type": "string"
+ },
+ "street2": {
+ "type": "string"
+ },
+ "tax_id": {
+ "description": "Tax id in the party's country format (US: EIN)",
+ "type": "string"
+ },
+ "zipcode": {
+ "description": "Required where the country uses postal codes",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "street",
+ "city",
+ "country",
+ "contact_name",
+ "phone"
+ ],
+ "type": "object"
+ },
+ "importer_of_record": {
+ "additionalProperties": false,
+ "description": "Only when someone other than the consignee is the importer of record (e.g. the seller or a broker clears import)",
+ "properties": {
+ "city": {
+ "type": "string"
+ },
+ "contact_name": {
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "name": {
+ "description": "Company name, Latin characters",
+ "type": "string"
+ },
+ "phone": {
+ "description": "International format, e.g. +862150000000",
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "street": {
+ "type": "string"
+ },
+ "street2": {
+ "type": "string"
+ },
+ "tax_id": {
+ "description": "Tax id in the party's country format (US: EIN)",
+ "type": "string"
+ },
+ "zipcode": {
+ "description": "Required where the country uses postal codes",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "street",
+ "city",
+ "country",
+ "contact_name",
+ "phone"
+ ],
+ "type": "object"
+ },
+ "importer_of_record_number": {
+ "description": "US imports: the consignee's importer of record number (EIN or CBP number YYDDPP-NNNNN)",
+ "type": "string"
+ },
+ "importer_registration_number": {
+ "description": "Destination importer registration: Brazil CNPJ (14 digits) or CPF (11), Colombia NIT, Argentina CUIT (11 digits), Nigeria Form M (MF + 8-12 digits)",
+ "type": "string"
+ },
+ "isf": {
+ "additionalProperties": false,
+ "description": "Ocean imports into the US only: Importer Security Filing (10+2) parties. The forwarder files it with the customer after booking; country of origin and HTS come from commodities.",
+ "properties": {
+ "buyer": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "One-line address",
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "country"
+ ],
+ "type": "object"
+ },
+ "consignee_number": {
+ "type": "string"
+ },
+ "consolidator": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "One-line address",
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "country"
+ ],
+ "type": "object"
+ },
+ "container_stuffing_location": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "One-line address",
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "country"
+ ],
+ "type": "object"
+ },
+ "importer_of_record_number": {
+ "type": "string"
+ },
+ "manufacturer": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "One-line address",
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "country"
+ ],
+ "type": "object"
+ },
+ "seller": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "One-line address",
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "country"
+ ],
+ "type": "object"
+ },
+ "ship_to": {
+ "additionalProperties": false,
+ "properties": {
+ "address": {
+ "description": "One-line address",
+ "type": "string"
+ },
+ "country": {
+ "pattern": "^[A-Za-z]{2}$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "country"
+ ],
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "itn": {
+ "description": "US exports: the ITN, when the shipper files the EEI itself",
+ "type": "string"
+ },
+ "no_hazmat": {
+ "description": "The shipper confirms nothing is hazardous: no batteries (also inside devices), aerosols, perfume or paint. Ask the user; without it the forwarder asks before moving the freight.",
+ "type": "boolean"
+ },
+ "shipper_tax_id": {
+ "description": "Shipper tax id. US exports: the EIN (9 digits); if omitted, the EIN on the account's customs profile is used.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+}