Shipment(JSON)

EVEROKAbout 14 min

Shipment(JSON) API

Standard Shipment Dataset

shipment API enable Everest application to push the shipment data to external client, shipment data includes shipper info, consignee's info, notify party's info, POL, POD, ETD, cargo ready date, package information, container information, MB/L, HB/L, shipment legs.

{
  "doc_type": "shipment",
  "version": "string",
  "agent_id": "string",
  "trans_id": "string",
  "shipments": [
    {
      "agent_reference": "string",
      "booking_submitted_actual": "string",
      "cargo_ready_estimated": "2023-05-29T00:00:00",
      "departure_estimated": "2023-05-29T00:00:00",
      "arrival_estimated": "2023-05-29T00:00:00",
      "inco_term": "string",
      "carrier_scac": "string",
      "containerization_type": "FCL",
      "freight_payment_terms": "CC",
      "house_bill": "string",
      "master_bill": "string",
      "vessel_name": "string",
      "voyage_number": "string",
      "transport_mode": "AIR",
      "release_type": "Original",
      "po_numbers": "string",
      "booking_reference": "string",
      "co_load_bill_of_lading": "string",
      "shipper_reference": "string",
      "total_package_num": 0,
      "total_gross_weight_kgs": 0,
      "total_volume_cbms": 0,
      "chargeable_weight": 0,
      "dimensional_weight": 0,
      "cancelled": true,
      "inco_term_place": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "co_loader": {
        "name": "string",
        "format_address": "string",
        "source_party_id": "string"
      },
      "origin_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "lading_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "arrival_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "delivery_place": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "carrier": {
        "name": "string",
        "format_address": "string",
        "source_party_id": "string"
      },
      "shipper": {
        "name": "string",
        "country": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "full_address": "string",
        "format_address": "string",
        "postal_code": "string",
        "source_party_id": "string"
      },
      "consignee": {
        "name": "string",
        "country": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "full_address": "string",
        "format_address": "string",
        "postal_code": "string",
        "target_party_id": "string",
        "source_party_id": "string"
      },
      "notify_party": {
        "name": "string",
        "country": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "full_address": "string",
        "format_address": "string",
        "postal_code": "string",
        "source_party_id": "string"
      },
      "revenue_invoices": [
        {
          "invoice_number": "string",
          "issued_date": "2019-08-24T14:15:22Z",
          "total_due": 0,
          "invoice_lines": [
            {
              "currency": "string",
              "line_number": 0,
              "charge_code": "string",
              "description": "string",
              "total_cost": 0
            }
          ]
        }
      ],
      "containers": [
        {
          "type_code": "string",
          "container_number": "string",
          "delivery_mode": "string",
          "seal_1": "string",
          "source_container_id": "string",
          "po_number": "string",
          "container_type": "string",
          "container_height": "string",
          "container_length": "string",
          "reefer_flag": "string",
          "avg_temp_value": "string",
          "avg_temp_unit": "TC"
        }
      ],
      "package_groups": [
        {
          "volume_cbms": 0,
          "gross_weight_kgs": 0,
          "package_type_description": "string",
          "package_type_code": "string",
          "package_quantity": 0,
          "source_container_id": "string",
          "marks_and_numbers": "string",
          "description_of_goods": "string",
          "package_length_cms": 0,
          "package_width_cms": 0,
          "package_height_cms": 0,
          "is_dgr": true,
          "dgr_number": "string",
          "dgr_class": "string",
          "dgr_packing_group": "string",
          "dgr_description": "string",
          "package_item_list": [
            {
              "HTS_number": "string",
              "item_name": "string",
              "po_no": "string",
              "po_item_no": "string",
              "source_item_id": "string"
            }
          ]
        }
      ],
      "shipment_legs": [
        {
          "arrival_actual": "string",
          "arrival_estimated": "string",
          "carrier_scac": "string",
          "arrival_port": {
            "unlocode": "string",
            "iata_code": "string",
            "country_code": "string",
            "description": "string"
          },
          "departure_actual": "string",
          "departure_estimated": "string",
          "lading_port": {
            "unlocode": "string",
            "iata_code": "string",
            "country_code": "string",
            "description": "string"
          },
          "leg_sequence_number": "string",
          "leg_type": "Main",
          "vessel_Lloyds_IMO": "string",
          "transport_mode": "AIR",
          "voyage_number": "string",
          "vessel_name": "string"
        }
      ],
      "event": {
        "event_code": "string",
        "event_description": "string",
        "estimated_event_date": "2023-05-29T00:00:00",
        "actual_event_date": "2023-05-29T00:00:00"
      },
      "security_filings": [
        {
          "filing_type": "ISF10",
          "filing_id": "string",
          "filing_date": "2023-05-29T00:00:00",
          "filing_status": "Completed",
          "filing_result": "string",
          "reference_number": "string",
          "vessel_name": "string",
          "voyage_number": "string",
          "departure_estimated": "2023-05-29T00:00:00",
          "arrival_estimated": "2023-05-29T00:00:00",
          "carrier_scac": "string",
          "forwardor_scac": "string",
          "transport_mode": "AIR",
          "containerization_type": "FCL",
          "containers": [
            {
              "type_code": "string",
              "container_number": "string",
              "container_type": "string",
              "container_height": "string",
              "container_length": "string",
              "reefer_flag": "string",
              "avg_temp_value": "string",
              "avg_temp_unit": "TC"
            }
          ],
          "origin_country": "string",
          "commodities": [
            {
              "HTS_number": "string"
            }
          ],
          "lading_port": {
            "unlocode": "string",
            "iata_code": "string",
            "country_code": "string",
            "description": "string"
          },
          "arrival_port": {
            "unlocode": "string",
            "iata_code": "string",
            "country_code": "string",
            "description": "string"
          },
          "delivery_place": {
            "unlocode": "string",
            "iata_code": "string",
            "country_code": "string",
            "description": "string"
          },
          "addresses": [
            {
              "name": "string",
              "country": "string",
              "address_1": "string",
              "address_2": "string",
              "city": "string",
              "state": "string",
              "full_address": "string",
              "format_address": "string",
              "postal_code": "string",
              "source_party_id": "string",
              "address_type": "BUY",
              "government_assigned_id": "string",
              "government_assigned_id_type": "string"
            }
          ],
          "bills_of_lading": [
            {
              "house_bill": "string",
              "master_bill": "string"
            }
          ],
          "filing_by": "string"
        }
      ]
    }
  ]
}

Params

Name	Location	Type	Required	Title	Description
body	body	object	no		none
» doc_type	body	string	yes		none
» version	body	string	yes		none
» agent_id	body	string	yes		none
» trans_id	body	string	yes		none
» shipments	body	[shipment]	yes		none
»» agent_reference	body	string	yes		Booking ID geerated by system
»» booking_submitted_actual	body	string	yes		actual booking submitted date
»» cargo_ready_estimated	body	string(date-time)	yes		estimated cargo ready date
»» departure_estimated	body	string(date-time)	yes		ETD
»» arrival_estimated	body	string(date-time)	yes		ETA
»» inco_term	body	string	yes		INCOTERM, such as FOB,DDP,etc.
»» carrier_scac	body	string	no		Carrier's Standard Carrier Alpha Code (SCAC)
»» containerization_type	body	string	yes		How the shipment will be containerized
»» freight_payment_terms	body	string	yes		The terms by which the freight will be paid,
»» house_bill	body	string	no		HBL
»» master_bill	body	string	no		MBL
»» vessel_name	body	string	no		Name of vessel
»» voyage_number	body	string	no		Voyage or flight number
»» transport_mode	body	string	yes		Transportation mode
»» release_type	body	string	no		B/L release type
»» po_numbers	body	string	no		PO number related to shipment
»» booking_reference	body	string	no		none
»» co_load_bill_of_lading	body	string	no		none
»» shipper_reference	body	string	no		none
»» total_package_num	body	number	no		total package quantity
»» total_gross_weight_kgs	body	number	no		total gross weight
»» total_volume_cbms	body	number	no		total volume
»» chargeable_weight	body	number	no		only for air shipment
»» dimensional_weight	body	number	no		only for air shipment
»» cancelled	body	boolean	yes		none
»» inco_term_place	body	[location]	yes		none
»» co_loader	body	object	no		Co-loader's information
»»» name	body	string	no		name of address
»»» format_address	body	string	no		output standard address format by automated address validation process
»»» source_party_id	body	string	no		identifior of the party in Everok platform
»» origin_port	body	[location]	no		none
»» lading_port	body	[location]	yes		none
»» arrival_port	body	[location]	yes		none
»» delivery_place	body	[location]	yes		none
»» carrier	body	object	no		information of party who physically transporting the shipment
»»» name	body	string	no		name of address
»»» format_address	body	string	no		output standard address format by automated address validation process
»»» source_party_id	body	string	no		identifior of the party in Everok platform
»» shipper	body	object	yes		shipper info
»»» name	body	string	no		name of address
»»» country	body	string	no		2 character ISO country code
»»» address_1	body	string	no		street and street number
»»» address_2	body	string	no		building number if any
»»» city	body	string	no		city name
»»» state	body	string	no		state or province name
»»» full_address	body	string	no		original address text from customer
»»» format_address	body	string	no		output standard address format by automated address validation process
»»» postal_code	body	string	no		postal code
»»» source_party_id	body	string	no		identifior of the party in Everok platform
»» consignee	body	object	yes		consigee info
»»» name	body	string	no		name of address
»»» country	body	string	no		2 character ISO country code
»»» address_1	body	string	no		street and street number
»»» address_2	body	string	no		building number if any
»»» city	body	string	no		city name
»»» state	body	string	no		state or province name
»»» full_address	body	string	no		original address text from customer
»»» format_address	body	string	no		output standard address format by automated address validation process
»»» postal_code	body	string	no		postal code
»»» target_party_id	body	string	no		identifior of the party in destination system
»»» source_party_id	body	string	no		identifior of the party in Everok platform
»» notify_party	body	object	yes		notified party info
»»» name	body	string	no		name of address
»»» country	body	string	no		2 character ISO country code
»»» address_1	body	string	no		street and street number
»»» address_2	body	string	no		building number if any
»»» city	body	string	no		city name
»»» state	body	string	no		state or province name
»»» full_address	body	string	no		original address text from customer
»»» format_address	body	string	no		output standard address format by automated address validation process
»»» postal_code	body	string	no		postal code
»»» source_party_id	body	string	no		identifior of the party in Everok platform
»» revenue_invoices	body	[invoice]	no		The invoices from the service provider to the shipper.
»»» invoice_number	body	string	yes		unique invoice number
»»» issued_date	body	string(date-time)	yes	2023-05-29T00:00:00	invoice issued date
»»» total_due	body	number	yes		total amount of invoice
»»» invoice_lines	body	[invoice line]	no		none
»» containers	body	[container]	no		Containers on the shipment
»»» type_code	body	string	no		ISO 6346 container type code (like 20GP)
»»» container_number	body	string	yes		identifying container number (including SCAC prefix)
»»» delivery_mode	body	string	yes		the mode of delivery like CY/CY, CFS/CY, etc.
»»» seal_1	body	string	no		container seal number
»»» source_container_id	body	string	no		linkage between package group and container
»»» po_number	body	string	no		relative PO number
»»» container_type	body	string	no		container type, such as TRL (Trailer) , TRLCAR (Car Trailer) , TRLFLA (Flat Trailer) , TRLSEM (Semi-Trailer) , TRLSBY (Swap Body)
»»» container_height	body	string	no		height of container
»»» container_length	body	string	no		length of container
»»» reefer_flag	body	string	no		reefer flag on container
»»» avg_temp_value	body	string	no		Average Temperature
»»» avg_temp_unit	body	string	no		Temperature Unit of Measure
»» package_groups	body	[package group]	yes		Collections of identical packages
»» shipment_legs	body	[shipment leg]	no		Array of shipment segments that the shipment will take
»» event	body	event	no		event during shipment
»»» event_code	body	string	yes		code of event during whole bill
»»» event_description	body	string	no		none
»»» estimated_event_date	body	string(date-time)	no		estimated event date
»»» actual_event_date	body	string(date-time)	no		actual event date
»» security_filings	body	[security filing]	no		none

Name	Value
»» containerization_type	FCL
»» containerization_type	LCL
»» containerization_type	Break Bulk Cargo
»» containerization_type	RORO
»» freight_payment_terms	CC
»» freight_payment_terms	PP
»» transport_mode	AIR
»» transport_mode	SEA
»» transport_mode	RAIL
»» transport_mode	ROAD
»» release_type	Original
»» release_type	FCR
»» release_type	Telex Released
»»» avg_temp_unit	TC
»»» avg_temp_unit	TF

Data Schema

address

{
  "name": "string",
  "country": "string",
  "address_1": "string",
  "address_2": "string",
  "city": "string",
  "state": "string",
  "full_address": "string",
  "format_address": "string",
  "postal_code": "string",
  "unlocode": "string",
  "target_party_id": "string",
  "source_party_id": "string",
  "address_type": "BUY",
  "government_assigned_id": "string",
  "government_assigned_id_type": "string"
}

Name	Type	Required	Restrictions	Description
name	string	false	none	name of address
country	string	false	none	2 character ISO country code
address_1	string	false	none	street and street number
address_2	string	false	none	building number if any
city	string	false	none	city name
state	string	false	none	state or province name
full_address	string	false	none	original address text from customer
format_address	string	false	none	output standard address format by automated address validation process
postal_code	string	false	none	postal code
unlocode	string	false	none	valid UN/LOCODE
target_party_id	string	false	none	identifior of the party in destination system
source_party_id	string	false	none	identifior of the party in Everok platform
address_type	string	false	none	different address type, such as importer, consignee, shipper, notify party, etc.
government_assigned_id	string	false	none	number assigned by government, such as EIN
government_assigned_id_type	string	false	none	type of the assigned number

Name	Value
address_type	BUY
address_type	CSG
address_type	CSS
address_type	CTS
address_type	IMP
address_type	MNF
address_type	SEL
address_type	STP
address_type	BKP

shipment

{
  "agent_reference": "string",
  "booking_submitted_actual": "string",
  "cargo_ready_estimated": "2023-05-29T00:00:00",
  "departure_estimated": "2023-05-29T00:00:00",
  "arrival_estimated": "2023-05-29T00:00:00",
  "inco_term": "string",
  "carrier_scac": "string",
  "containerization_type": "FCL",
  "freight_payment_terms": "CC",
  "house_bill": "string",
  "master_bill": "string",
  "vessel_name": "string",
  "voyage_number": "string",
  "transport_mode": "AIR",
  "release_type": "Original",
  "po_numbers": "string",
  "booking_reference": "string",
  "co_load_bill_of_lading": "string",
  "shipper_reference": "string",
  "total_package_num": 0,
  "total_gross_weight_kgs": 0,
  "total_volume_cbms": 0,
  "chargeable_weight": 0,
  "dimensional_weight": 0,
  "cancelled": true,
  "inco_term_place": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "co_loader": {
    "name": "string",
    "format_address": "string",
    "source_party_id": "string"
  },
  "origin_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "lading_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "arrival_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "delivery_place": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "carrier": {
    "name": "string",
    "format_address": "string",
    "source_party_id": "string"
  },
  "shipper": {
    "name": "string",
    "country": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "full_address": "string",
    "format_address": "string",
    "postal_code": "string",
    "source_party_id": "string"
  },
  "consignee": {
    "name": "string",
    "country": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "full_address": "string",
    "format_address": "string",
    "postal_code": "string",
    "source_party_id": "string"
  },
  "notify_party": {
    "name": "string",
    "country": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "string",
    "full_address": "string",
    "format_address": "string",
    "postal_code": "string",
    "source_party_id": "string"
  },
  "revenue_invoices": [
    {
      "invoice_number": "string",
      "issued_date": "2019-08-24T14:15:22Z",
      "total_due": 0,
      "invoice_lines": [
        {
          "currency": "string",
          "line_number": 0,
          "charge_code": "string",
          "description": "string",
          "total_cost": 0
        }
      ]
    }
  ],
  "containers": [
    {
      "type_code": "string",
      "container_number": "string",
      "delivery_mode": "string",
      "seal_1": "string",
      "source_container_id": "string",
      "po_number": "string",
      "container_type": "string",
      "container_height": "string",
      "container_length": "string",
      "reefer_flag": "string",
      "avg_temp_value": "string",
      "avg_temp_unit": "TC"
    }
  ],
  "package_groups": [
    {
      "volume_cbms": 0,
      "gross_weight_kgs": 0,
      "package_type_description": "string",
      "package_type_code": "string",
      "package_quantity": 0,
      "source_container_id": "string",
      "marks_and_numbers": "string",
      "description_of_goods": "string",
      "package_length_cms": 0,
      "package_width_cms": 0,
      "package_height_cms": 0,
      "is_dgr": true,
      "dgr_number": "string",
      "dgr_class": "string",
      "dgr_packing_group": "string",
      "dgr_description": "string",
      "package_item_list": [
        {
          "HTS_number": "string",
          "item_name": "string",
          "po_no": "string",
          "po_item_no": "string",
          "source_item_id": "string"
        }
      ]
    }
  ],
  "shipment_legs": [
    {
      "arrival_actual": "string",
      "arrival_estimated": "string",
      "carrier_scac": "string",
      "arrival_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "departure_actual": "string",
      "departure_estimated": "string",
      "lading_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "leg_sequence_number": "string",
      "leg_type": "Main",
      "vessel_Lloyds_IMO": "string",
      "transport_mode": "AIR",
      "voyage_number": "string",
      "vessel_name": "string"
    }
  ],
  "event": {
    "event_code": "string",
    "event_description": "string",
    "estimated_event_date": "2023-05-29T00:00:00",
    "actual_event_date": "2023-05-29T00:00:00"
  },
  "security_filings": [
    {
      "filing_type": "ISF10",
      "filing_id": "string",
      "filing_date": "2023-05-29T00:00:00",
      "filing_status": "Completed",
      "filing_result": "string",
      "reference_number": "string",
      "vessel_name": "string",
      "voyage_number": "string",
      "departure_estimated": "2023-05-29T00:00:00",
      "arrival_estimated": "2023-05-29T00:00:00",
      "carrier_scac": "string",
      "forwardor_scac": "string",
      "transport_mode": "AIR",
      "containerization_type": "FCL",
      "containers": [
        {
          "type_code": "string",
          "container_number": "string",
          "container_type": "string",
          "container_height": "string",
          "container_length": "string",
          "reefer_flag": "string",
          "avg_temp_value": "string",
          "avg_temp_unit": "TC"
        }
      ],
      "origin_country": "string",
      "commodities": [
        {
          "HTS_number": "string"
        }
      ],
      "lading_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "arrival_port": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "delivery_place": {
        "unlocode": "string",
        "iata_code": "string",
        "country_code": "string",
        "description": "string"
      },
      "addresses": [
        {
          "name": "string",
          "country": "string",
          "address_1": "string",
          "address_2": "string",
          "city": "string",
          "state": "string",
          "full_address": "string",
          "format_address": "string",
          "postal_code": "string",
          "source_party_id": "string",
          "address_type": "BUY",
          "government_assigned_id": "string",
          "government_assigned_id_type": "string"
        }
      ],
      "bills_of_lading": [
        {
          "house_bill": "string",
          "master_bill": "string"
        }
      ],
      "filing_by": "string"
    }
  ]
}

Name	Type	Required	Restrictions	Description
agent_reference	string	true	none	Booking ID geerated by system
booking_submitted_actual	string	true	none	actual booking submitted date
cargo_ready_estimated	string(date-time)	true	none	estimated cargo ready date
departure_estimated	string(date-time)	true	none	ETD
arrival_estimated	string(date-time)	true	none	ETA
inco_term	string	true	none	INCOTERM, such as FOB,DDP,etc.
carrier_scac	string	false	none	Carrier's Standard Carrier Alpha Code (SCAC)
containerization_type	string	true	none	How the shipment will be containerized
freight_payment_terms	string	true	none	The terms by which the freight will be paid,
house_bill	string	false	none	HBL
master_bill	string	false	none	MBL
vessel_name	string	false	none	Name of vessel
voyage_number	string	false	none	Voyage or flight number
transport_mode	string	true	none	Transportation mode
release_type	string	false	none	B/L release type
po_numbers	string	false	none	PO number related to shipment
booking_reference	string	false	none	none
co_load_bill_of_lading	string	false	none	none
shipper_reference	string	false	none	none
total_package_num	number	false	none	total package quantity
total_gross_weight_kgs	number	false	none	total gross weight
total_volume_cbms	number	false	none	total volume
chargeable_weight	number	false	none	only for air shipment
dimensional_weight	number	false	none	only for air shipment
cancelled	boolean	true	none	none
inco_term_place	[location]	true	none	none
co_loader	object	false	none	Co-loader's information
» name	string	false	none	name of address
» format_address	string	false	none	output standard address format by automated address validation process
» source_party_id	string	false	none	identifior of the party in Everok platform
origin_port	[location]	false	none	none
lading_port	[location]	true	none	none
arrival_port	[location]	true	none	none
delivery_place	[location]	true	none	none
carrier	object	false	none	information of party who physically transporting the shipment
» name	string	false	none	name of address
» format_address	string	false	none	output standard address format by automated address validation process
» source_party_id	string	false	none	identifior of the party in Everok platform
shipper	object	true	none	shipper info
» name	string	false	none	name of address
» country	string	false	none	2 character ISO country code
» address_1	string	false	none	street and street number
» address_2	string	false	none	building number if any
» city	string	false	none	city name
» state	string	false	none	state or province name
» full_address	string	false	none	original address text from customer
» format_address	string	false	none	output standard address format by automated address validation process
» postal_code	string	false	none	postal code
» source_party_id	string	false	none	identifior of the party in Everok platform
consignee	object	true	none	consigee info
» name	string	false	none	name of address
» country	string	false	none	2 character ISO country code
» address_1	string	false	none	street and street number
» address_2	string	false	none	building number if any
» city	string	false	none	city name
» state	string	false	none	state or province name
» full_address	string	false	none	original address text from customer
» format_address	string	false	none	output standard address format by automated address validation process
» postal_code	string	false	none	postal code
» source_party_id	string	false	none	identifior of the party in Everok platform
notify_party	object	true	none	notified party info
» name	string	false	none	name of address
» country	string	false	none	2 character ISO country code
» address_1	string	false	none	street and street number
» address_2	string	false	none	building number if any
» city	string	false	none	city name
» state	string	false	none	state or province name
» full_address	string	false	none	original address text from customer
» format_address	string	false	none	output standard address format by automated address validation process
» postal_code	string	false	none	postal code
» source_party_id	string	false	none	identifior of the party in Everok platform
revenue_invoices	[invoice]	false	none	The invoices from the service provider to the shipper.
containers	[container]	false	none	Containers on the shipment
package_groups	[package group]	true	none	Collections of identical packages
shipment_legs	[shipment leg]	false	none	Array of shipment segments that the shipment will take
event	event	false	none	event during shipment
security_filings	[security filing]	false	none	none

Name	Value
containerization_type	FCL
containerization_type	LCL
containerization_type	Break Bulk Cargo
containerization_type	RORO
freight_payment_terms	CC
freight_payment_terms	PP
transport_mode	AIR
transport_mode	SEA
transport_mode	RAIL
transport_mode	ROAD
release_type	Original
release_type	FCR
release_type	Telex Released

security filing

{
  "filing_type": "ISF10",
  "filing_id": "string",
  "filing_date": "2023-05-29T00:00:00",
  "filing_status": "Completed",
  "filing_result": "string",
  "reference_number": "string",
  "vessel_name": "string",
  "voyage_number": "string",
  "departure_estimated": "2023-05-29T00:00:00",
  "arrival_estimated": "2023-05-29T00:00:00",
  "carrier_scac": "string",
  "forwardor_scac": "string",
  "transport_mode": "AIR",
  "containerization_type": "FCL",
  "containers": [
    {
      "type_code": "string",
      "container_number": "string",
      "container_type": "string",
      "container_height": "string",
      "container_length": "string",
      "reefer_flag": "string",
      "avg_temp_value": "string",
      "avg_temp_unit": "TC"
    }
  ],
  "origin_country": "string",
  "commodities": [
    {
      "HTS_number": "string"
    }
  ],
  "lading_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "arrival_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "delivery_place": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "addresses": [
    {
      "name": "string",
      "country": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "full_address": "string",
      "format_address": "string",
      "postal_code": "string",
      "source_party_id": "string",
      "address_type": "BUY",
      "government_assigned_id": "string",
      "government_assigned_id_type": "string"
    }
  ],
  "bills_of_lading": [
    {
      "house_bill": "string",
      "master_bill": "string"
    }
  ],
  "filing_by": "string"
}

Name	Type	Required	Restrictions	Description
filing_type	string	true	none	security filing type, only ISF10 and ISF5 supported at current phase
filing_id	string	true	none	filing ID from Customs
filing_date	string(date-time)	true	none	filing completion date
filing_status	string	true	none	none
filing_result	string	true	none	text result from Customs
reference_number	string	true	none	relative shipment ID
vessel_name	string	true	none	Name of vessel
voyage_number	string	true	none	Voyage or flight number
departure_estimated	string(date-time)	true	none	ETD
arrival_estimated	string(date-time)	true	none	ETA
carrier_scac	string	true	none	Carrier's Standard Carrier Alpha Code (SCAC)
forwardor_scac	string	true	none	Forwardor's Standard Carrier Alpha Code (SCAC)
transport_mode	string	true	none	Transportation mode
containerization_type	string	true	none	How the shipment will be containerized
containers	[container]	true	none	Container's info
» type_code	string	false	none	ISO 6346 container type code (like 20GP)
» container_number	string	true	none	identifying container number (including SCAC prefix)
» container_type	string	false	none	container type, such as TRL (Trailer) , TRLCAR (Car Trailer) , TRLFLA (Flat Trailer) , TRLSEM (Semi-Trailer) , TRLSBY (Swap Body)
» container_height	string	false	none	height of container
» container_length	string	false	none	length of container
» reefer_flag	string	false	none	reefer flag on container
» avg_temp_value	string	false	none	Average Temperature
» avg_temp_unit	string	false	none	Temperature Unit of Measure
origin_country	string	true	none	2 character ISO country code
commodities	[commodity]	true	none	Commodity's info
lading_port	[location]	true	none	none
arrival_port	[location]	true	none	none
delivery_place	[location]	true	none	none
addresses	[address]	true	none	Involved parties information
» name	string	false	none	name of address
» country	string	false	none	2 character ISO country code
» address_1	string	false	none	street and street number
» address_2	string	false	none	building number if any
» city	string	false	none	city name
» state	string	false	none	state or province name
» full_address	string	false	none	original address text from customer
» format_address	string	false	none	output standard address format by automated address validation process
» postal_code	string	false	none	postal code
» source_party_id	string	false	none	identifior of the party in Everok platform
» address_type	string	false	none	different address type, such as importer, consignee, shipper, notify party, etc.
» government_assigned_id	string	false	none	number assigned by government, such as EIN
» government_assigned_id_type	string	false	none	type of the assigned number
bills_of_lading	[object]	true	none	B/L
» house_bill	string	false	none	none
» master_bill	string	false	none	none
filing_by	string	true	none	none

Name	Value
filing_type	ISF10
filing_type	ISF5
filing_status	Completed
filing_status	Declared
filing_status	Waiting
transport_mode	AIR
transport_mode	SEA
transport_mode	RAIL
transport_mode	ROAD
containerization_type	FCL
containerization_type	LCL
containerization_type	Break Bulk Cargo
containerization_type	RORO
avg_temp_unit	TC
avg_temp_unit	TF
address_type	BUY
address_type	CSG
address_type	CSS
address_type	CTS
address_type	IMP
address_type	MNF
address_type	SEL
address_type	STP
address_type	BKP

commodity

{
  "HTS_number": "string",
  "item_name": "string",
  "po_no": "string",
  "po_item_no": "string",
  "source_item_id": "string"
}

Name	Type	Required	Restrictions	Description
HTS_number	string	true	none	none
item_name	string	false	none	item name
po_no	string	false	none	po number
po_item_no	string	false	none	po item number
source_item_id	string	false	none	source item id

event

{
  "event_code": "string",
  "event_description": "string",
  "estimated_event_date": "2023-05-29T00:00:00",
  "actual_event_date": "2023-05-29T00:00:00"
}

Name	Type	Required	Restrictions	Description
event_code	string	true	none	code of event during whole bill
event_description	string	false	none	none
estimated_event_date	string(date-time)	false	none	estimated event date
actual_event_date	string(date-time)	false	none	actual event date

shipment leg

{
  "arrival_actual": "string",
  "arrival_estimated": "string",
  "carrier_scac": "string",
  "arrival_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "departure_actual": "string",
  "departure_estimated": "string",
  "lading_port": {
    "unlocode": "string",
    "iata_code": "string",
    "country_code": "string",
    "description": "string"
  },
  "leg_sequence_number": "string",
  "leg_type": "Main",
  "vessel_Lloyds_IMO": "string",
  "transport_mode": "AIR",
  "voyage_number": "string",
  "vessel_name": "string"
}

Name	Type	Required	Restrictions	Description
arrival_actual	string	true	none	ATA
arrival_estimated	string	true	none	ETA
carrier_scac	string	true	none	Carrier's Standard Carrier Alpha Code (SCAC)
arrival_port	[location]	true	none	none
departure_actual	string	true	none	ATD
departure_estimated	string	true	none	ETD
lading_port	[location]	true	none	none
leg_sequence_number	string	true	none	The order of this leg in the context of the whole shipment
leg_type	string	true	none	type of shipment leg, could be main shipment or pre-carriage shipment
vessel_Lloyds_IMO	string	false	none	vessel IMO number
transport_mode	string	true	none	Transportation mode
voyage_number	string	true	none	Voyage or flight number
vessel_name	string	true	none	Name of vessel

Name	Value
leg_type	Main
leg_type	PreCarriage
transport_mode	AIR
transport_mode	SEA
transport_mode	RAIL
transport_mode	ROAD

package group

{
  "volume_cbms": 0,
  "gross_weight_kgs": 0,
  "package_type_description": "string",
  "package_type_code": "string",
  "package_quantity": 0,
  "source_container_id": "string",
  "marks_and_numbers": "string",
  "description_of_goods": "string",
  "package_length_cms": 0,
  "package_width_cms": 0,
  "package_height_cms": 0,
  "is_dgr": true,
  "dgr_number": "string",
  "dgr_class": "string",
  "dgr_packing_group": "string",
  "dgr_description": "string",
  "package_item_list": [
    {
      "HTS_number": "string",
      "item_name": "string",
      "po_no": "string",
      "po_item_no": "string",
      "source_item_id": "string"
    }
  ]
}

Name	Type	Required	Restrictions	Description
volume_cbms	number	true	none	The total volume of all of the packages in the group
gross_weight_kgs	number	true	none	The total gross weight of all of the packages in the group
package_type_description	string	true	none	Description of the type of packaging
package_type_code	string	true	none	The code that represents the type of packaging
package_quantity	number	true	none	The total number of packages within the group.
source_container_id	string	true	none	Use to associate to package group
marks_and_numbers	string	true	none	Marks and numbers on the packages
description_of_goods	string	true	none	Description of the goods within the packaging
package_length_cms	number	false	none	The length of the package group measured in centimeters.
package_width_cms	number	false	none	The width of the package group measured in centimeters.
package_height_cms	number	false	none	The height of the package group measured in centimeters.
is_dgr	boolean	false	none	Dangerous item flag
dgr_number	string	false	none	UN number
dgr_class	string	false	none	UN transport hazard class
dgr_packing_group	string	false	none	Packing group
dgr_description	string	false	none	UN proper shipping name
package_item_list	[commodity]	false	none	Package item list

container

{
  "type_code": "string",
  "container_number": "string",
  "delivery_mode": "string",
  "seal_1": "string",
  "source_container_id": "string",
  "po_number": "string",
  "container_type": "string",
  "container_height": "string",
  "container_length": "string",
  "reefer_flag": "string",
  "avg_temp_value": "string",
  "avg_temp_unit": "TC"
}

Name	Type	Required	Restrictions	Description
type_code	string	false	none	ISO 6346 container type code (like 20GP)
container_number	string	true	none	identifying container number (including SCAC prefix)
delivery_mode	string	true	none	the mode of delivery like CY/CY, CFS/CY, etc.
seal_1	string	false	none	container seal number
source_container_id	string	false	none	linkage between package group and container
po_number	string	false	none	relative PO number
container_type	string	false	none	container type, such as TRL (Trailer) , TRLCAR (Car Trailer) , TRLFLA (Flat Trailer) , TRLSEM (Semi-Trailer) , TRLSBY (Swap Body)
container_height	string	false	none	height of container
container_length	string	false	none	length of container
reefer_flag	string	false	none	reefer flag on container
avg_temp_value	string	false	none	Average Temperature
avg_temp_unit	string	false	none	Temperature Unit of Measure

Name	Value
avg_temp_unit	TC
avg_temp_unit	TF

invoice

{
  "invoice_number": "string",
  "issued_date": "2019-08-24T14:15:22Z",
  "total_due": 0,
  "invoice_lines": [
    {
      "currency": "string",
      "line_number": 0,
      "charge_code": "string",
      "description": "string",
      "total_cost": 0
    }
  ]
}

Name	Type	Required	Restrictions	Title	Description
invoice_number	string	true	none		unique invoice number
issued_date	string(date-time)	true	none	2023-05-29T00:00:00	invoice issued date
total_due	number	true	none		total amount of invoice
invoice_lines	[invoice line]	false	none		none

invoice line

{
  "currency": "string",
  "line_number": 0,
  "charge_code": "string",
  "description": "string",
  "total_cost": 0
}

Name	Type	Required	Restrictions	Description
currency	string	true	none	The 3-character ISO 4217 currency code of the currency
line_number	integer	true	none	sequence number for each line
charge_code	string	true	none	charge code generated by the issuer
description	string	false	none	description of invoice line
total_cost	number	true	none	total amount for line

location

{
  "unlocode": "string",
  "iata_code": "string",
  "country_code": "string",
  "description": "string"
}

Name	Type	Required	Restrictions	Description
unlocode	string	true	none	valid UN/LOCODE
iata_code	string	false	none	3 digits IATA code for airline case
country_code	string	false	none	2-ISO country code
description	string	false	none	Description of location

Shipment(JSON)

# Shipment(JSON) API

# Standard Shipment Dataset

# Params

# Data Schema

# address

# shipment

# security filing

# commodity

# event

# shipment leg

# package group

# container

# invoice

# invoice line

# location