| Name | Description |
|---|---|
| Root | The top level document |
| Shipment | A shipment of products. |
| Container | A container used to ship goods |
| User | A person with an account on a related system. |
| ServiceInvoice | An invoice for supply chain related services (not a commercial invoice) |
| ServiceInvoiceLine | A line on an invoice |
| PackageGroup | A set of identically-packed packages at any level within a shipment. Each package in a package group must be identical, including its contents. |
| PackItem | An individual item within a package group. This represents the actual product being transported |
| PurchaseOrder | An order for a physical product from a supplier to a customer. |
| PurchaseOrderLine | The lines representing the items ordered on a purchase order. |
| Address | A physical location. |
| Locode | A UN/LOCODE |
| NativeReferenceNumber | A raw reference number value received from a source system. This document is meant to relay a platform's native reference number values in as close to the native format as possible and should not be utilized for any business logic purposes. If a reference number is required for any business logic aside from passing through reference number values, it should be added as an actual property to a canonical document. |
| Attachment | A file attachment |
| ShipmentLeg | A single movement that is part of a larger shipment. |
| Note | A textual message |
| Milestone | An event representing a point in time supply chain milestone, such as an actual departure or expected arrival date. The primary purpose of the milestone object is to associate a code and/or description with an actual or estimated datetime. |
| CustomsDeclaration | A filing with a customs authority to import or export product. |
| CustomsAgencyStatus | An overall declaration status message issued by a partnering customs agency. |
| UsCustomsDeclaration | Information specific to filing customs declarations with US Customs and Border Protection |
| HazardousMaterial | A listed hazardous material being transported |
| HazmatContactParty | Contact information for the emergency response POC for the hazardous material. |
| CommercialInvoice | An invoice used to calculate tariffs, international commercial terms, and is commonly used for customs purposes (not a service invoice) |
| CommercialInvoiceLine | A line on a commercial invoice representing information for a single product. |
| CustomsDispositionUs | US Customs disposition status update messages. |
| NativeReferenceNumber | A raw reference number value received from a source system. This document is meant to relay a platform's native reference number values in as close to the native format as possible and should not be utilized for any business logic purposes. If a reference number is required for any business logic aside from passing through reference number values, it should be added as an actual property to a canonical document. |
| TriggerEvent | Data related to the system event that resulted in this shipment data being extract from the source system. |
| TriggerEvent | Data related to the system event that resulted in this shipment data being extract from the source system. |
| CommercialInvoiceLineTariff | A single harmonized tariff assessment associated with a commercial invoice line. Use these when a line carries multiple tariff assessments (e.g. US Chapter 99 special tariffs applied in addition to the line's primary tariff). The line's own tariff_number remains the primary classification; each additional assessment is represented as one entry here. |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always shipment_json | |
shipments | Array<Shipment> | Array of shipment | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
action_type | String | Intent of the shipment information. Should be one of the following values: create, update, delete, create_or_update or duplicate. | |
additional_terms | String | Additional shipment terms to be noted. | |
agent_reference | String | Reference number provided by the agent | |
ams_filer | Boolean | Whether AMS filing is needed for this shipment | |
approved_to_ship_date | DateTime | The timestamp when all parties involved have agreed the goods are approved to be shipped. | |
arrival_cfs | Address | The local CFS (Container Freight Station) the shipment will arrive into. This is largely utilized when relaying delivery information to a 3rd party, usually a carrier. | |
arrival_cto | Address | The local CTO (Combined Transport Operator) that is handling the shipment at the place of arrival. This is largely utilized when relaying delivery information to a 3rd party, usually a carrier. | |
arrival_port | Locode | The port of arrival in the final destination country | |
arrival_port_actual | DateTime | Actual date the shipment arrived at the final air or ocean port (not including final inland transportation) | |
arrival_port_estimated | DateTime | Estimated date the shipment will arrive at the final air or ocean port (not including final inland transportation) | |
attachments | Array<Attachment> | Attachments related to this object | |
bill_of_lading_notification_party | Address | The party receiving bill of lading notifications on a shipment. | |
bill_of_lading_notification_type | String | The document type of the bill of lading notification (eg. Draft Unrated, Final Rated, etc.) | |
bill_of_lading_origin | Locode | The origin location of the bill of lading | |
bill_of_lading_release | Locode | The bill of lading release location or release office | |
bill_of_lading_type | String | Type of bill of lading like Straight | |
booked_by_party | Address | The party that placed the booking with the carrier or logistics provider. | |
booked_by_party | Address | The party that placed the booking with the carrier or logistics provider. | |
booking | Boolean | Does this shipment data represent a booking or an in-progress shipment? | YES |
booking_accept_status | String | Response type of the booking. Used to know if the booking was successful or not. | |
booking_accept_status_description | String | A description giving further information on the bookings accept status. | |
booking_accept_status_reason_code | String | A reason code for the bookings accept status. | |
booking_confirmation_number | String | Confirmation number from party receiving initial booking | |
booking_confirmed_actual | DateTime | The time that the party receiving the initial booking confirmed it. If there is a forwarder or NVO involved, then this is the time they confirmed the booking with the shipper, not the time they confirmed the booking with the carrier. | |
booking_notification_party | Address | The address for the booking notification party | |
booking_portal_reference | String | Additional reference number assigned to the booking by the booking party. | |
booking_reference | String | Booking reference number provided by the party making the booking | |
booking_submitted_actual | DateTime | The date the booking was submitted by the shipper | |
buyer | Address | The buying party responsible for the underlying purchase orders on this shipment. This may represent a specific buying office or buyer within the consignee's organization. | |
cancelled | Boolean | Does this shipment data represent a cancelled shipment? | YES |
cargo_ready_actual | DateTime | Actual date and time the cargo was be available | |
cargo_ready_estimated | DateTime | Estimated date and time the cargo will be available | |
carrier | Address | The party physically transporting the shipment. For example, an airline, trucking company, or ocean carrier. | |
carrier_booking_number | String | The booking number provided by the carrier | |
carrier_instructions | String | Instructions to the carrier. | |
carrier_payment_terms | String | The terms of payment that the forwarder / NVOCC has agreed to with the carrier issuing the master bill of lading. | |
carrier_scac | String | Carrier's Standard Carrier Alpha Code (SCAC) | |
cfs_receipt_date | Date | The date the goods were receipted by the CFS/Transit Warehouse. | |
chargeable_weight | Decimal | Greater of the dimensional or actual gross weight | |
co_load_bill_of_lading | String | The master Bill of Lading Number associated with the co-loader. | |
co_load_booking_reference | String | The booking reference/confirmation number issued by the co-loader. | |
co_loader | Address | The party responsible for the co_loading the consolidation associated with the shipment. | |
commercial_invoice_number | String | The invoice number or numbers for the commercial invoice(s) used as the instrument of payment for the goods provided in the shipment. | |
commercial_invoices | Array<CommercialInvoice> | An invoice used to calculate tariffs, international commercial terms, and is commonly used for customs purposes (not a service invoice). | |
consignee | Address | The party to whom the goods are consigned | |
consignee_reference | String | A reference number provided by the consignee which will be used to identify the shipment upon receipt. | |
consignor | Address | The party who is consigning the goods | |
consolidation_forwarder_reference | String | The forwarder's reference number for a consolidation associated with this shipment | |
consolidation_type_code | String | The type code for the consolidation. | |
containerization_type | String | How the shipment will be containerized (FCL, LCL, Loose, FTL, LTL) | |
containerization_type_description | String | A full description of the containerization type on the shipment (eg. Full Container Load) | |
containers | Array<Container> | Containers on the shipment | |
contract_number | String | The contract number for the shipment. | |
cost_invoices | Array<ServiceInvoice> | The invoices representing costs incurred by the service provider. Do not send these to your customers if you do not want them to see your costs. | |
cost_invoices | Array<ServiceInvoice> | The invoices representing costs incurred by the service provider. Do not send these to your customers if you do not want them to see your costs. | |
created_by | User | Deprecated - Please see version > 1.92 and use the operator property or trigger_event.triggered_by instead.User who created the shipment. | |
created_on | DateTime | Time this record was created in the source system. | |
customer_reference_numbers | String | Reference numbers utilized by the forwarder's client to identity or track the goods. In general, these will be numbers that should be unrelated to any supply chain documents or movements. They may be reference numbers from a customer's internal tracking system or something similiar. | |
customs_declarations | Array<CustomsDeclaration> | A filing with a customs authority. | |
customs_direction | String | The direction of the customs action | |
cutoff_time_bol | DateTime | The final cutoff date and time for submitting the final bill of lading instructions | |
cutoff_time_physical | DateTime | The final cutoff date and time for the physical delivery of the freight | |
cutoff_time_shipment_instructions | DateTime | Timestamp of when the shipment instructions are due. | |
cutoff_time_vgm | DateTime | The final cutoff date and time for submitting the verified gross mass (VGM) information | |
delivery_actual | DateTime | The time when the shipment was delivered to its final location. | |
delivery_agent | Address | The agent responsible for coordinating the delivery of goods at the destination location. | |
delivery_appointment_actual | DateTime | The delivery dock appointment date. | |
delivery_estimated | DateTime | The estimated time of the shipment's final delivery. | |
delivery_mode | String | The mode of delivery like CY/CY, CFS/CY, etc. | |
delivery_note_id | String | A reference printed on the delivery note or packing list used to identify the shipment upon receipt. | |
delivery_order_number | String | The delivery order number(s) releasing the cargo from the port, terminal or depot. | |
delivery_reference | String | The delivery reference for the shipment | |
delivery_requested_date | Date | The actual date of pickup for the container(s) from the starting point of the shipment. | |
delivery_transport_company | Address | The party responsible for transporting the goods to the final destination. | |
departure_actual | DateTime | Actual date and time the cargo departed from its origin point | |
departure_cfs | Address | The remote CFS (Container Freight Station) the shipment will depart from. This is largely utilized when relaying pickup information to a 3rd party, usually a carrier. | |
departure_cto | Address | The remote CTO (Combined Transport Operator) that is handling the shipment at the place of departure. This is largely utilized when relaying pickup information to a 3rd party, usually a carrier. | |
departure_estimated | DateTime | Estimated date and time the cargo will depart from it's origin point | |
description_of_goods | String | Description of goods in the shipment | |
dimensional_weight | Decimal | Calculated dimensional (volumetric weight) of the shipment | |
earliest_delivery_date | Date | The earliest date the selling party may deliver the product to the handover location. | |
earliest_drop_off_full | Date | The earliest date when the filled containers can be dropped off at the CY or CFS. | |
earliest_empty_pick_up | Date | The earliest date when the empty containers can be picked up from the container depot. | |
earliest_pickup_date | Date | The earliest date the carrier can pickup the shipment from the ship from location. | |
empty_pick_up_party | Address | The party responsible for picking the empty container for the shipment. | |
environmental_pollutant_indicator | Boolean | Does the shipment contain Environmental Pollutants? | |
export_declaration_reference | String | The unique number used in filing of export declaration | |
export_license_expires_date | DateTime | The timestamp of when the export license will expire. | |
export_license_issued_date | DateTime | The timestamp of when the export license was issued. | |
export_license_number | String | Export license number used for this shipment. | |
export_port | Locode | The UN/LOCODE for the Port of Export. The place where goods are departed from the country which is exporting them. | |
federal_maritime_commission_number | String | The federal maritime commission number reference | |
final_destination_port | Locode | The final port including any inland transportation. | |
forwarder_branches | Array<Address> | A party that represents the branch at the forwarding company responsible for managing the shipment. | |
forwarder_controlling_branch_code | String | The forwarder's main branch responsible for the shipment | |
forwarder_controlling_branch_description | String | The forwarder's main branch responsible for the shipment | |
forwarder_controlling_company_code | String | The forwarder's main company responsible for the shipment | |
forwarder_controlling_company_description | String | The forwarder's main company responsible for the shipment | |
forwarder_controlling_department_code | String | The forwarder's main department responsible for the shipment | |
forwarder_controlling_department_description | String | The forwarder's main department responsible for the shipment | |
forwarder_customers | Array<Address> | The customer controlling the shipment from the forwarder's perspective. | |
forwarder_departments | Array<Address> | A party that represents the department at the forwarding company responsible for managing the shipment. | |
forwarder_origin_branch | String | The branch of freight forwarder responsible for shipment. | |
forwarder_origin_department | String | The department of freight forwarder responsible for shipment. | |
forwarder_reference | String | Shipment reference number assigned by the freight forwarder | |
forwarder_scac | String | SCAC or other assigned code for the freight forwarder | |
freight_forwarder | Address | The party responsible for managing and arranging the transportation of goods between one destination and another. | |
freight_payment_location | Locode | The freight payment location | |
freight_payment_terms | String | The terms by which the freight will be paid, like Prepaid or Collect | |
freight_payment_terms_charge_type | String | The type of freight charge reported, eg. all charges, basic freight, destination, origin, etc | |
freight_purchasing_party | Address | The party purchasing or paying for the shipment freight. | |
freight_selling_party | Address | The party that will be paid for the main leg freight costs by the shipping party. When a shipper is buying from an NVOCC, this is the NVOCC, not the carrier. When a shipper, forwarder, or NVOCC is buying from a carrier directly, this is the carrier. | |
freight_tariff_number | String | The tariff number for the freight being shipped. | |
full_drop_off_party | Address | The party responsible for dropping off the filled shipment | |
global_customer | Address | A global customer represents the controlling corporate entity associated with the localized customer on the shipment. Often a global customer is utilized for reporting or billing purposes to associate revenue or expenses with a higher corporate organization than the localized shipment customer when the localized customer is a subsidiary or division of a global customer. | |
gross_weight_kgs | Decimal | Gross weight of the shipment in kilograms | |
gross_weight_lbs | Decimal | Gross weight of the shipment in pounds. If both gross_weight_kgs and gross_weight_lbs are present only gross_weight_kgs will be used. | |
gross_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
hazmat_indicator | Boolean | Does the shipment contain Hazardous Materials? | |
hot_flag | Boolean | If true, then the shipment is considered important and should be tracked with additional care by the forwarder | |
house_bill | String | House bill of lading number | |
imo_number | String | International Maritime Organization (IMO) number | |
import_port | Locode | The port where the shipment will be declared to the import customs authority, generally provided on an international shipment | |
importer | Address | The address for the party identified as the importer by the forwarder. In general, you should utilize importer_of_record rather than this address. | |
importer_of_record | Address | The address for the importer of record | |
inco_term | String | The INCOTerm under which the product is moving like FOB, DDP, etc. | |
inco_terms_description | String | A full description of the inco terms on the shipment (eg. Delivered At Place) | |
insured_value | Decimal | The insurance valuation of all the goods on the shipment. | |
insured_value_currency | Decimal | The 3-character ISO 4217 currency code of the currency for the insurance value of the goods. | |
interim_receipt_number | String | A temporary tracking number issued by a freight forwarder to acknowledge receipt of a shipment from the shipper, essentially acting as a placeholder until the final shipping documents like a Bill of Lading are generated. | |
is_split_shipment | Boolean | Is this shipment being sent in parts | |
lading_port | Locode | The port of lading | |
loading_actual | DateTime | Actual date the shipment was loaded onto the vessel | |
loading_estimated | DateTime | Estimated date the shipment will be loaded onto the vessel | |
local_cartage_container_terminal_operator | Address | The address for the local cartage yard container terminal operator | |
local_cartage_yard | Address | The address for the local cartage yard | |
local_cartage_yard_exporter | Address | The address for the local cartage yard exporter | |
local_cartage_yard_importer | Address | The address for the local cartage yard importer | |
manufacturer | Address | The party who is manufacturing the goods - sometimes referred to as the factory. | |
maritime_mobile_service_identity | String | A Maritime Mobile Service Identity (MMSI) is a nine-digit number that uniquely identifies ship stations, ship earth stations, coast stations, coast earth stations, and group calls. | |
master_bill | String | Master bill of lading number | |
milestones | Array<Milestone> | Supply chain milestones related to this object. | |
must_deliver_by_date | DateTime | The date & time by which the carrier should deliver the shipment to the terimination point. | |
must_pickup_by_date | DateTime | The date by which the carrier must pickup the shipment from the ship from location. | |
net_weight_kgs | Decimal | Net weight of the shipment in kilograms. | |
net_weight_lbs | Decimal | Net weight of the shipment in pounds. If both net_weight_kgs and net_weight_lbs are present only net_weight_kgs will be used. | |
net_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
notes | Array<Note> | Notes related to this object | |
notify_parties | Array<Address> | Parties that need to be notified of any updates related to the shipment. This works the same way as notify_party, and is just a way to provide multiple parties to notify | |
notify_party | Address | The notify party on the bill of lading | |
number_of_bol_copies_requested | Integer | The number of copies of the bill of lading requested to be produced by the issuer. | |
number_of_original_bols_requested | Integer | The number of original bills of lading requested to be produced by the issuer. | |
number_of_outer_packages | Integer | The total number of the largest packaging group on the shipment, often pallets. | |
number_of_packages | Decimal | Number of packages in the shipment | |
number_of_pieces | Decimal | Number of pieces in the shipment | |
operator | Address | The user associated with processing the shipment data in the source system. | |
origin_gate_in_actual | DateTime | Actual date the shipment will gated in at origin | |
origin_gate_in_estimated | DateTime | Estimated date the shipment will gate in at origin | |
origin_pickup_actual | Date | The actual date of pickup for the container(s) from the starting point of the shipment. | |
origin_pickup_estimated | Date | The estimated date to pickup the container(s) from the starting point of the shipment. | |
origin_port | Locode | The origin point of the shipment. | |
out_of_gauge_freight_indicator | Boolean | Does the shipment contain out of gauge freight? | |
outer_pack_package_type_code | String | The code that represents the type of packaging referenced in "number_of_outer_packages". We recommend that you use standardized package type codes. | |
outer_pack_package_type_description | String | A full description of the outer packages type code. | |
package_group | Array<PackageGroup> | Collections of identical packages | |
package_type_code | String | The code that represents the type of packaging reference in number_of_packages. We recommend that you use standardized package type codes. | |
package_type_description | String | A description of the code used as the package_type_code attribute. | |
pickup_agent | Address | The agent responsible for coordinating the pickup of goods at the origin location. | |
pickup_appointment_date | DateTime | Appointment date to pickup the container from the starting point of the shipment. | |
pickup_requested_date | Date | The date the pickup was requested from the cartage company. This generally represents when cartage documents are sent to the cartage company. | |
pickup_transport_company | Address | The party responsible for transporting the goods from the origin to the handover location. | |
po_numbers | String | Purchase orders associated with the shipment | |
purchase_orders | Array<PurchaseOrder> | An order for a physical product from a supplier to a customer. | |
quote_reference | String | The reference number for the quote associated with the shipment. | |
radioactive | Boolean | Does the shipment contain radioactive materials? | |
rated_bill_of_lading_indicator | Boolean | Indicator for whether the bill of lading should be rated or unrated. | |
receiving_freight_forwarder | Address | The party arranging all importation services for the shipment. Sometimes called the Receiving Agent. | |
release_type | String | The bill of lading release type. Generally STRAIGHT, EBL, TELEX. | |
release_type_description | String | A full description of the release type on the shipment | |
requested_final_destination_date | Date | The date the customer is requesting for the goods to arrive at the final destination. | |
revenue_invoices | Array<ServiceInvoice> | The invoices from the service provider to the shipper. | |
sales_order_numbers | String | The sales order number(s) issued by the supplier associated with the goods. | |
sales_representative | User | The sales representative that is responsible for the shipment. | |
screening_method_code | String | Screening method required before cargo may be loaded on board aircraft. (e.g., EDD, EDS, XRAY, etc.) | |
screening_method_description | String | Freeform description of Screening method code (e.g., "Explosive Detection Dogs" "Explosive Detection System", etc.) | |
seller | Address | The party who is selling the goods - sometimes referred to as the vendor. | |
sent_date | DateTime | Time the record was sent by the source system. | |
service_level | String | Service level to be used (like EXP or STD). These will vary per service provider | |
service_level_description | String | Service level description like (Standard or Express Overnight) | |
ship_from | Address | The starting point of the shipment | |
ship_to | Address | The ending point of the shipment | |
ship_window_end | DateTime | The latest time that the shipment should depart origin | |
ship_window_start | DateTime | The earliest time that the shipment should depart origin | |
shipment_converted_from_booking | Boolean | If true, the shipment originated in the source TMS as a booking and was converted into a shipment | |
shipment_legs | Array<ShipmentLeg> | Array of shipment segments that the shipment will take (like multiple connecting flights or a road segment followed by an ocean segment) | |
shipment_status | String | A code or description indicating the current overall status of the shipment. This may be used to indicate anything from a shipment delay to stage the shipment is in (Transit, Picked-Up, etc). | |
shipment_type_code | String | Type code for the shipment | |
shipper | Address | The party that is responsible for causing the the goods to be shipped. Often the Beneficial Cargo Owner (BCO). | |
shipper_reference | String | Reference number provided by the shipper | |
shipping_instructions_requestor | Address | The party originating the shipping instructions. | |
source_account_uid | String | A unique identifying code for the account that controls the shipment in a multi-tenant environment. | |
source_system_uid | String | A unique identifying code from the system of record for this shipment. | YES |
split_original_booking_number | String | Original booking number of which this shipment is a part of. | |
split_reason_code | String | Reason code for this split shipment. | |
split_reason_description | String | Description of the reason this shipment was split. | |
split_sequence_description | String | Description of this split shipment's sequence. | |
supplier | Address | The party who is supplying the goods. | |
temperature_controlled_indicator | Boolean | Must the shipment be transported in temperature controlled conditions? | |
transaction_type_code | String | The transaction type code for the shipment sent on an EDI document. | |
transmission_uid | String | A one-time unique identifying code for this transmission of the shipment in question. Used for tracing and logging purposes. | |
transport_mode | String | Mode of transportation (AIR, ROAD, SEA, RAIL) | |
transshipment_port | Locode | The port of transshipment or first foreign port | |
trigger_event | TriggerEvent | Data related to the system event that resulted in this shipment data being extract from the source system. | |
ultimate_consignee | Address | The ultimate consignee for the goods. | |
value_of_goods | Decimal | The invoiced value of all goods on the shipment. | |
value_of_goods_currency | String | The 3-character ISO 4217 currency code of the currency for the value of goods. | |
vessel_name | String | Name of vessel (for multi-leg shipments, use the primary leg information) | |
volume_cbms | Decimal | Volume of the shipment in cubic meters | |
volume_cf | Decimal | Volume of the shipment in cubic feet. | |
volume_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of CBM or CF. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
voyage_number | String | Voyage or flight number (for multi-leg shipments, use the primary leg information) |
| Name | Data Type | Description | Required |
|---|---|---|---|
air_exchange_cbms_per_hour | Decimal | Air exchange per hour in cubic meters | |
air_exchange_cbms_per_hour | Decimal | A note related to a specific container move. | |
arrival_delivery_actual | DateTime | The actual date that the container was delivered from the container yard / port. | |
arrival_delivery_estimated | DateTime | The estimated date that the container will be delivered from the container yard / port. | |
carrier_cutoff_date | DateTime | The last date the container can be delivered to the carrier | |
carrier_supplied | Boolean | Should the carrier provide the container? | |
chargeable_weight_kgs | Decimal | The total chargeable weight of the container. | |
chassis_included | Boolean | A container booking flag indicating that a container chassis is required as part of the booking request. | |
container_number | String | Identifying container number (including SCAC prefix) | |
container_terminal_order_available | DateTime | The date the container terminal order is available allowing the container to be released from the terminal. | |
container_terminal_storage_start | DateTime | The date the container terminal starts counting storage days. Typically, the terminal will allow 3-7 days of storage from this date. | |
delivery_mode | String | The mode of delivery like CY/CY, CFS/CY, etc. | |
description_of_goods | String | A description of the goods within the container | |
destination_gate_out_actual | DateTime | The actual date the container exited the destination container yard. | |
drop_mode_code | String | Code for drop mode | |
empty_ready_actual | DateTime | The date the empty container became available to be returned. | |
empty_returned_actual | DateTime | The date the empty container was actually returned. | |
empty_returned_requested | DateTime | The date the empty container is expected to be returned by. | |
equipment_controlled_atmosphere | Boolean | Indicates that Equipment Controlled Atmosphere setting is requested. | |
final_destination_actual | DateTime | The actual date the container was delivered to the final destination. | |
full_drop_off_party | Address | The party responsible for dropping off the filled container | |
genset_required | Boolean | Indicates that GENSET is required. | |
gross_weight_kgs | Decimal | The gross weight of the container in kilograms. | |
gross_weight_lbs | Decimal | The gross weight of the container in pounds. If both gross_weight_kgs and gross_weight_lbs are present only gross_weight_kgs will be used. | |
gross_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
humidity_percentage | Decimal | Humidity per container measured in percent of moisture ini the air. | |
humidity_setting | Boolean | Indicates that humidity setting is required. | |
in_transit_cold_sterilization | Boolean | Indicates that In Transit Cold Sterilization is requested. | |
load_type | String | How will the container be loaded? FLOOR or PALLET | |
loading_actual | DateTime | The actual date the container was loaded onto the vessel. | |
net_weight_kgs | Decimal | The Net Weight of the goods in the container in kilograms. | |
net_weight_lbs | Decimal | The Net Weight of the goods in the container in pounds. If both net_weight_kgs and net_weight_lbs are present only net_weight_kgs will be used. | |
net_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
non_active_refer | Boolean | Will an inactive reefer be used? | |
notes | Array<Note> | A note related to a specific container move. | |
number_of_containers | Decimal | The number of containers | |
number_of_temperature_probes | Decimal | Number of temperature probes requested. | |
number_of_usd_probes | Decimal | Number of USD probes for ICT service. | |
origin_empty_pickup_gate_out | DateTime | The actual time the empty container was picked up from the container yard for delivery to the pickup location | |
origin_gate_in_actual | DateTime | The actual date the container was checked in at the origin container yard or freight station. | |
origin_pickup_actual | DateTime | The actual date that the container was picked up from the origin shipping point. | |
origin_pickup_estimated | DateTime | The estimated date that the container will be picked up from the origin shipping point. | |
owned_by_shipper | Boolean | Is the container owned by the shipper's company? | |
pickup_number | String | Number assigned to the pickup | |
po_number | String | Purchase order number associated with the container | |
seal_1 | String | Container seal one | |
seal_1_affixed_by | String | A code indicating the party responsible for applying Seal 1 to the container. | |
seal_2 | String | Container seal two | |
seal_2_affixed_by | String | A code indicating the party responsible for applying Seal 2 to the container. | |
seal_3 | String | Container seal three | |
seal_3_affixed_by | String | A code indicating the party responsible for applying Seal 3 to the container. | |
ship_empty | Boolean | Will the container be empty when shipped? | |
size_code | String | ISO 6346 container size code (like 20G0) | |
source_container_id | String | Identifier for the container to use it to link to the PackageGroup source_container_id in order to indicate which package groups are within each contaizer when both values are provided | |
status | String | A indicator of the status of the container. This might be used to indicate a container was damaged or lost. | |
super_freezer_service | Boolean | Indicates that super freezer service is requested. | |
tare_weight_kgs | Decimal | Net weight of the container in kilograms. | |
tare_weight_lbs | Decimal | Tare weight of the container in pounds. If both tare_weight_kgs and tare_weight_lbs are present only tare_weight_kgs will be used. | |
tare_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
temperature_cel | Decimal | Temperature setting for container in Celsius. | |
temperature_max_cel | Decimal | The maximum temperature in Celsius at which equipment is to be maintained. | |
temperature_min_cel | Decimal | The minimum temperature in Celsius at which equipment is to be maintained. | |
temperature_variance | Decimal | Temperature variance. | |
type_code | String | ISO 6346 container type code (like 20GP) | |
unloading_actual | DateTime | The actual date the container was unloaded from the vessel. | |
ventilation_code | String | Equipment vent settings. | |
vgm_verification_date | DateTime | The date the container's gross mass was verified. | |
vgm_verification_method | String | A code used to indicate the method used to determine the container's gross mass. | |
volume_cbms | Decimal | The gross volume of the loaded container. |
| Name | Data Type | Description | Required |
|---|---|---|---|
email | String | User's email address. | |
first_name | String | User's first name. | |
last_name | String | User's last name. | |
username | String | User's account in the related system. |
| Name | Data Type | Description | Required |
|---|---|---|---|
attachments | Array<Attachment> | Attachments related to this invoice. | |
bill_to_address_1 | String | First address line of the bill to party | |
bill_to_address_2 | String | Second addresss line of the bill to party | |
bill_to_city | String | City of the bill to party | |
bill_to_contact_email | String | Contact's email address at the bill to party | |
bill_to_contact_name | String | Contact's name at the bill to party | |
bill_to_contact_phone | String | Contact's phone number at the bill to party | |
bill_to_country | String | 2 character ISO country code of the bill to party | |
bill_to_id | String | Identifying code for the bill to party used by the invoicing party | |
bill_to_name | String | Name of the bill to party | |
bill_to_postal_code | String | Postal Code of the bill to party | |
bill_to_state | String | State of the bill to party | |
bill_to_target_id | String | Identifying code for the bill to party used by the paying party | |
cancel_reason_code | String | A reason code for when the invoice is cancelled. | |
cancel_reason_code_description | String | A reason code description for when the invoice is cancelled. | |
cancelled | Boolean | If True, this invoice data represents a cancelled invoice. | |
currency | String | 3 letter currency code | |
due_date | DateTime | The date that payment is due. | |
invoice_description | String | A description of the services rendered and covered by the invoice. | |
invoice_lines | Array<ServiceInvoiceLine> | The invoice's lines | |
invoice_number | String | The invoice number issued by the invoicing party | |
invoice_type | String | The invoice type determined by the invoicing party. | |
issued_date | DateTime | The time the issue was issued by the invoicing party | |
payment_term_days | Integer | Number of days until payment is due from the issued_date | |
payment_terms | String | Payment terms (like COD or NET30) | |
quote_valid_end | DateTime | The end date of when the entire quote is valid. | |
quote_valid_start | DateTime | The start date of when the entire quote is valid. | |
rate_valid_end | DateTime | The end date of when the entire rate is valid. | |
rate_valid_start | DateTime | The start date of when the entire rate is valid. | |
remit_to_address_1 | String | First address line of the remit to party | |
remit_to_address_2 | String | Second addresss line of the remit to party | |
remit_to_city | String | City of the remit to party | |
remit_to_contact_email | String | Contact's email address at the remit to party | |
remit_to_contact_name | String | Contact's name at the remit to party | |
remit_to_contact_phone | String | Contact's phone number at the remit to party | |
remit_to_country | String | 2 character ISO country code of the remit to party | |
remit_to_id | String | Identifying code for the remit to party used by the invoicing party | |
remit_to_name | String | Name of the remit to party | |
remit_to_postal_code | String | Postal Code of the remit to party | |
remit_to_state | String | State of the remit to party | |
remit_to_target_id | String | Identifying code for the remit to party used by the paying party | |
service_invoice_uid | String | A database level unique ID for the invoice. For the invoice number normally printed on the invoice, use invoice_number | |
total_due | Decimal | Total amount due |
| Name | Data Type | Description | Required |
|---|---|---|---|
branch_code | String | Code for the branch that should be associated with the revenue (use on the lines associated with revenue_invoices) | |
charge_code | String | Charge code assigned by the invoicing party | |
converted_currency | String | A second currency for the converted_* fields | |
converted_total_cost | Decimal | The total_cost for the invoice line after converting to the converted_currency. | |
currency | String | 3 character currency code. (If populated, overrides the currency code at the Invoice header) | |
department_code | String | The invoicing company's department responsible for issuing this invoice line. | |
description | String | Description of the invoice being charged | |
line_number | String | Unique identifier within the invoice for the line. (Usually a sequental number) | |
payment_terms | String | The shipment payment terms associated with the line. Expected terms values are 'collect', 'prepaid' or 'third-party'. This will typically only be utilized when relaying freight charges. | |
quantity | Decimal | The number of items being invoiced. | |
reference_number | String | A unique reference number for the invoice line. | |
revenue_invoice_line_number | String | The line_number of the invoice line in the revenue_invoices array that represents the revenue of the service being billed on this line. Only include this value on cost_invoices. If you include this field, also include revenue_invoice_uid | |
revenue_invoice_uid | String | The service_invoice_uid of the invoice in the revenue_invoices array that represents the revenue of the service being billed on this line. Only include this value on cost_invoices. If you include this field, also include revenue_invoice_line_number | |
shipment_uid | String | Foreign key link to the Shipment source_system_uid. Only required if multiple shipments are attached to the invoice. | |
tax_code | String | The code representing tax calculation used for the invoice line. | |
tax_rate_code | String | The code representing tax calculation used for the invoice line | |
total_cost | Decimal | The cost of all items being invoiced on the line | |
total_tax | Number | The total amount of tax added to invoice line. Use line level tax amounts when different tax rates are applied to individual lines. | |
unit_price | Decimal | The cost of one item | |
valid_end | DateTime | When this service invoice line represents a transport rate quote, this is the end date of when the quoted rate for this charge is valid. | |
valid_start | DateTime | When this service invoice line represents a transport rate quote, this is the start date of when the quoted rate for this charge is valid. |
| Name | Data Type | Description | Required |
|---|---|---|---|
chargeable_weight_kgs | Decimal | The total chargeable weight of all of the packages in the group. | |
commodity_type | String | Commodity representing the product being moved. Often at the 6 digit level for the package group. Include the full HTS in the PackItem.product_import_hts | |
commodity_type_code | String | A classification code describing the commodity code provided. For instance, this may be an indicator specifying that a US Schedule B code was provided as a commodity code. | |
description_of_goods | String | A description of the goods within the packaging. | |
final_destination_actual | DateTime | The actual date the container was delivered to the final destination. | |
final_destination_id | String | The identifier of the final location for these goods (possibly after BOL termination and transload or cross dock activities) | |
gross_weight_kgs | Decimal | The total gross weight of all of the packages in the group. To calculate the gross weight of an individual package within the group, divide the gross weight of the group by the number of packages. | |
gross_weight_lbs | Decimal | The total gross weight in lbs of all of the packages in the group. To calculate the gross weight of an individual package within the group, divide the gross weight of the group by the number of packages. If both gross_weight_kgs and gross_weight_lbs are present only gross_weight_kgs will be used. | |
gross_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
hazardous_material | HazardousMaterial | A listed hazardous material included in the package group | |
lot_number | String | Unique code assigned by a manufacturer to identify the batch of goods in which the products were produced | |
marks_and_numbers | String | Marks and numbers on the packages | |
net_weight_kgs | Decimal | The total net weight of all of the packages in the group. To calculate the net weight of an individual package within the group, divide the net weight of the group by the number of packages. | |
net_weight_lbs | Decimal | The total net weight in lbs of all of the packages in the group. To calculate the net weight of an individual package within the group, divide the net weight of the group by the number of packages. If both net_weight_kgs and net_weight_lbs are present only net_weight_kgs will be used. | |
net_weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
pack_items | Array<PackItem> | The package group's items | |
package_dimensions_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of CM or IN. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
package_height_cms | Decimal | The height of the package group measured in centimeters. | |
package_height_inches | String | The height of the package group measured in inches. | |
package_length_cms | Decimal | The length of the package group measured in centimeters. | |
package_length_inches | String | The length of the package group measured in inches. | |
package_number | String | An unique identifier for the package group. (If sending unique records per carton, use the SSCC number. If multiple packages in one group, use the license plate number or pallet number.) | |
package_quantity | Decimal | The total number of packages within the group. | |
package_type_code | String | The code that represents the type of packaging. Standardized package type codes preferred. | |
package_type_description | String | A description of the type of packaging. | |
package_width_cms | Decimal | The width of the package group measured in centimeters. | |
package_width_inches | String | The width of the package group measured in inches. | |
product_code | String | The product code of the items in the package group. | |
product_import_hts | String | The HTS of the items in the package group. If all items do not have the same HTS, use the hts number at the PackItem level. | |
reference_number | String | A reference number for the package group. | |
source_container_id | String | The package group's unique identification number within a container from the source system. | |
source_package_group_id | String | The package group's unique identification number at the same packaging level from the source system. | |
volume_cbms | Decimal | The total volume of all of the packages in the group. To calculate the volume for an individual package in the group, divide the total volume of the group by the number of packages. | |
volume_cf | String | The total volume of all of the packages in the group in cubic feet. | |
volume_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of CBM or CF. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. |
| Name | Data Type | Description | Required |
|---|---|---|---|
chargeable_weight_kgs | Decimal | The chargeable weight for the pack line in kilograms. | |
country_of_origin | String | The Country of Origin of the product for customs purposes. | |
customer_product_id | String | The product identifier (or style) of the product. Generally this is a higher level category which may have child variants specified by the SKU. | |
customer_sku | String | The customer’s stock keeping unit number. This represents the most detailed product. For example, this may be STYLE-COLOR-SIZE. | |
ean_code | String | The European Article Number code that is used to identify the product. | |
po_line_id | String | The line_id from the purchase order line associated with the item. | |
po_number | String | Purchase order number associated with the item. In reference to the Purchase Order specification, this is the customer_order_number | |
price_ticket_instructions | String | The instructions for the product tickets to detail whether or not the products will be ticketed and when in the process. For example: no tickets, supplier tickets, checkpoint tickets, cargo tickets. | |
product_description | String | A description of the product | |
product_import_hts | String | The HTS of the items. | |
product_name | String | The common or marketing name of product. | |
quantity_requested | Decimal | The original number of items requested on the purchase order. This number may differ from the total_item_quantity amount which represents the number of items actually fulfilled. | |
source_pack_item_id | String | The pack item's unique identification number within a package group from the source system. | |
source_po_line_id | String | The pack item's unique identification number within a purchase order from the source system. | |
total_item_quantity | Decimal | The number of items in each package. If you have 10 cartons with 4 items in each carton, then the correct value is 4 | |
unit_of_measure | String | The SKU's unit of measure. Some common units of measure are: EA, PCS, and M3. | |
unit_of_measure_description | String | A description of the SKU's unit of measure. | |
unit_price | Decimal | The price for a single unit of the product. |
| Name | Data Type | Description | Required |
|---|---|---|---|
currency | String | The 3 character ISO 4217 currency code for the currency that will be used for values on the purchase order. Like “EUR”, “USD”. | |
customer_order_number | String | The purchasing party's order number for the purchase order. | YES |
inco_term | String | The Incoterm under which the product will be purchased. | |
inco_term_named_place | String | The location at which handover will occur under the Incoterms. | |
latest_delivery_date | DateTime | The last moment the selling party may deliver the product to the handover location. | |
order_date | DateTime | The date and time that the order was issued by the purchasing party. | |
purchase_order_lines | Array<PurchaseOrderLine> | The lines representing the items ordered on a purchase order. | |
season | String | The target retail season for the goods on the purchase order. Generally consists of an identifier like 'Summer 2021 ' or 'Black Friday 2021'. | |
source_system_id | String | Record identifier in the system that hosts the master copy of this record. | |
supplier_order_number | String | An additional order number beyond the customer_order_number assigned by the supplier. |
| Name | Data Type | Description | Required |
|---|---|---|---|
arrival_port_actual | DateTime | Actual date the shipment arrived at the final air or ocean port (not including final inland transportation) | |
arrival_port_estimated | DateTime | Estimated date the shipment will arrive at the final air or ocean port (not including final inland transportation) | |
container_number | String | The container number associated with the order line. | |
customer_product_id | String | The purchasing party's product ID for the product. The product ID may be less specific than a SKU. For example, all colors of a particular style of t-shirt may have the same product ID, but each color and size combination would have it's own SKU. | |
customer_sku | String | The customer's product SKU. | |
departure_actual | DateTime | Actual date and time the vessel departed from it's origin point | |
departure_estimated | DateTime | Estimated date and time the vessel will depart from 's origin point | |
estimated_in_dc_date | DateTime | The date the line is estimated to be in the distribution center. | |
gross_weight_kgs | Decimal | The gross weight of the item in Kilograms. | |
hts_code | String | The product’s primary harmonized tariff code. | |
line_id | String | The line's position within the purchase order's lines. | |
outer_pack_package_height_cms | Float | The height of the outer pack in centimeters. | |
outer_pack_package_length_cms | Float | The length of the outer pack in centimeters. | |
outer_pack_package_type_code | String | The code that represents the type of packaging for the largest packaging group. We recommend that you use standardized package type codes. | |
outer_pack_package_width_cms | Float | The width of the outer pack in centimeters. | |
product_description | String | The product's description. | |
product_name | String | The common or marketing name of product. | |
quantity_requested | Decimal | The total number of products requested by the supplier. In a simple order scenario, this is the line quantity. | |
sales_order_quantity_requested | Float | The total number of products agreed to on the associated Sales Order line. | |
sku_description | String | A description of the item being ordered. | |
source_system_id | String | Record identifier in the system that hosts the master copy of this record. | |
unit_of_measure | String | A code representing the unit of measure of the item being ordered. | |
unit_of_measure_description | String | A human readable description of the unit of measure. | |
volume_cbms | Decimal | The volume of the item in Cubic Meters. |
| Name | Data Type | Description | Required |
|---|---|---|---|
address_1 | String | The first line of the address. | |
address_2 | String | The second line of the address. | |
address_type | String | The type of address represented by this element. Specific types may be defined on a per specification basis | |
branch_code | String | The branch code associated with the organization. | |
city | String | The city. | |
contact_first_name | String | The first name of a person acting as the point of contact at the address. | |
contact_last_name | String | The last name of a person acting as the point of contact at the address. | |
country | String | The 2-Digit ISO 3166 Alpha-2 Country Code. Like 'US' | |
country_name | String | The full name of the country like “United States” | |
customs_mid_code | String | The Manufacturer Identification Code (MID) used to identify the manufacturer to customs authorities. | |
drop_mode_code | String | Identifies the loading/unloading method supported at the location (e.g., dock, lift gate, ground level). Used to match carrier equipment capabilities with site requirements for successful pickup or delivery. | |
drop_mode_description | String | Human-readable description of the loading/unloading method supported at the location. Provides detailed explanation of the drop_mode_code for display purposes and operational clarity. | |
duns_number | String | Dun & Bradstreet unique identifier for businesses. | |
email | String | The contact email address | |
employer_identification_number | String | The Federal Tax Identification Number (EIN) for US business entities. | |
full_address | String | Unstructured text of the full address. Chain.io will convert this address into structured address data if the following conditions are met: (1) there is data in the full_address field, (2) there is a valid country code in the “country” field, (3) the “address_1” field is empty or not included, (4) you have selected “Free Text Address Lookup” in the Chain.io portal for this flow. Additional charges may be incurred for the Free Text Address Lookup feature. | |
government_assigned_id | String | Identifier used for reporting the address to a government authority | |
government_assigned_id_type | String | Type code for the government_assigned_id | |
name | String | The name associated with the address. | |
phone_number | String | The contact phone number | |
postal_code | String | The postal or ZIP code. | |
source_party_id | String | Identifier for the address in the sending system | |
state | String | The state, province, or administrative division code | |
state_name | String | The full name of the state, province, or administrative division. | |
target_party_id | String | Identifier for the address in the destination system | |
unlocode | String | The UN/LOCODE associated with the address. Like 'USCHI' | |
unlocode_description | String | The description UN/LOCODE associated with the address. |
| Name | Data Type | Description | Required |
|---|---|---|---|
description | String | A description of the port (like Long Beach) | |
unlocode | String | A valid UN/LOCODE (like USLGB) |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | A code identifying the type of reference number (ex. EDIREF, PO2, ). | |
data_source | String | An identifier describing the data source that this reference number was extracted from or should be inserted into. | |
description | String | A plain-text description of the reference number code. (ex. "EDI Reference Number", "Secondard PO Number"). | |
value | String | The reference number value. | |
value_context | String | Provides additional contextual hints at the type or classification of data present in the reference's value. |
| Name | Data Type | Description | Required |
|---|---|---|---|
content | Base64 | A Base64 encoded string of the file content | |
created_at | Date | The timestamp this document was attached. | |
created_by | User | The user account / party responsible for adding the attachment. | |
file_name | String | The name of the file | |
file_type_code | String | A short code representing the logical type of file. (You might use 'INV' for an invoice.) | |
file_type_description | String | A descriptive file type like 'Invoice to customer X' | |
media_type | String | The Media Type of the file (also known as MIME Type or Content-Type) | |
memo | String | Information regarding the contents of the file. | |
private | Boolean | If true, attachment is considered a private attachment. | |
source_system_uid | String | A unique identifying code from the system of record for this attachment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
arrival_actual | DateTime | Actual date the shipment arrived at the termination point of the leg | |
arrival_estimated | DateTime | Estimated date the shipment will arrive at the termination point of the leg | |
arrival_port | Locode | The termination point of the leg | |
carrier | Address | The party physically transporting the goods on this leg of the shipment. For example, an airline, trucking company, or ocean carrier. | |
carrier_scac | String | Carrier's Standard Carrier Alpha Code (SCAC) | |
cfs_cutoff_end_date | DateTime | The date/time the CFS (Container Freight Station) stops receiving cargo for consolidation/packing for the shipment leg. | |
cfs_cutoff_start_date | DateTime | The date/time the CFS (Container Freight Station) starts accepting cargo for consolidation/packing for the shipment leg. | |
cto_cutoff_end_date | DateTime | The date/time the CTO (Combined Transport Operator) stops receiving cargo for the shipment leg. | |
cto_cutoff_start_date | DateTime | The date/time the CTO (Combined Transport Operator) starts accepting cargo for the shipment leg. | |
departure_actual | DateTime | Actual date and time the cargo departed from it's origin point | |
departure_estimated | DateTime | Estimated date and time the cargo will depart from it's origin point | |
destination_waypoint_unlocode | String | The UN/LOCODE for a waypoint the shipment stops at on this leg before the destination/arrival location. Sometimes refered to as a via or stopover. | |
destination_waypoint_unlocode_description | String | The description of the UN/LOCODE for the destination waypoint, generally provided as the lading city. | |
docs_due_date | DateTime | The date/time that documentation is due for the shipment leg. | |
lading_port | Locode | The origin point of the leg | |
leg_sequence_number | Integer | The order of this leg in the context of the whole shipment. Use this field to order an array of shipment legs, not the position of the object in the array. | |
leg_type | String | Type of this shipment leg. Can be any of the following values: PreCarriage, Main, OnCarriage. | |
origin_waypoint_unlocode | String | The UN/LOCODE for a waypoint the shipment stops at on this leg AFTER the origin/lading location. Sometimes refered to as a via or stopover. | |
origin_waypoint_unlocode_description | String | The description of the UN/LOCODE for the origin waypoint, generally provided as the lading city. | |
source_system_id | String | Record identifier in the system that hosts the master copy of this record. | YES |
transport_mode | String | Mode of transportation (AIR, ROAD, SEA, RAIL) | |
vessel_name | String | Name of vessel | |
vessel_type_code | String | A code indicating the type of vessel performing the movement of goods for this shipment leg. The code may utilize a code set such as AIS Ship Types and will indicate that the vessel may be a cargo vessel, a barge, a tanker, a truck, etc. | |
vgm_cutoff_date | DateTime | The latest date/time by which all containers' Verified Gross Weights must be reported to the carrier or CTO (Combined Transport Operator). | |
voyage_number | String | Voyage or flight number |
| Name | Data Type | Description | Required |
|---|---|---|---|
body | String | The note body. | |
created_at | DateTime | Timestamp of the time this node was created. | |
created_by | User | User who created the note. | |
note_context | String | The note context provides an additional descriptive element to use to describe the situation the note is being utilized in. While the note's type field may indicate the note type as 'Marks & Numbers', the context may further describe them as being used in a 'booking' context. | |
note_type | String | The type of note. | |
updated_at | DateTime | Timestamp of the time this node was created. |
| Name | Data Type | Description | Required |
|---|---|---|---|
actual_date | DateTime | The date the event actually occurred. You should always include | |
estimated_date | DateTime | The date the event is estimated to occur. You should always include | |
event_code | String | Code representing the type of event | |
event_code_context | String | Additional context information about the event code. For example, if you send multiple DEPARTURE events on the same shipment for different legs, this field might contain the leg sequence number. | |
event_message | String | An additional message related to the event. This may be different each time an event occurs. | |
event_name | String | A description of the event. Some systems may have different descriptions for the same event across shipments. For example, a security filing event may include the filing number in the description. Therefore, you should always code against the | |
event_unlocode | Locode | An UN/LOCODE associated with the event. | |
shipment_identifier | String | A unique identifier for the shipment. For example, a bill of lading number for an ocean shipment. | |
shipment_identifier_code | String | A code that identifies the shipment. For example, a pro number for a truck shipment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
attachments | Array<Attachment> | Attachments related to this customs declaration. | |
broker_filer_code | String | The broker's identifier with the customs authority. | |
broker_reference | String | The Broker's file number for the customs declaration. | |
country_of_issue | String | The ISO 3166 2-character code of the country the customs authority belongs to. | |
customs_agency_statuses | Array<CustomsAgencyStatus> | An overall declaration status message issued by a partnering customs agency. | |
customs_transport_mode | String | The mode of transportation code defined by the customs authority. | |
customs_type | String | An indicator determining the customs type such as Import or Export. | |
declaration_currency | String | The 3 digit ISO 4217 currency code for the local currency of the customs authority. | |
declaration_date | DateTime | The official date listed on the customs declaration for acceptance. Typically this is the date used as the basis for all time sensitive calculations surrounding the declaration, such as duty rates and statement periods. | |
declaration_date_estimated | DateTime | An estimated version of the official date listed on the customs declaration for acceptance. | |
declaration_number | String | The customs declaration number presented to the customs authority. | |
declaration_type | String | The type of declaration as categorized by the customs authority. For the US, this may be a value of 01 for Consumption entries. For CA, this may be AB for high-value shipments. | |
declaration_type_description | String | A text description of the type of entry as categorized by the customs authority. | |
declared_value | Decimal | The total value of goods declared to the customs authority. | |
expiry_date | DateTime | After this date the declaration is no longer valid and cannot be used to clear goods for import/export. | |
export_country_code | String | The 2-letter ISO code of the export country - generally this represents the country of the lading port but does not necessarily correlate with the goods' country of origin. | |
export_date | DateTime | The declared export date of the shipment. | |
filed_date | DateTime | The date the customs declaration was submitted to the customs authority. | |
import_country_code | String | The 2-letter ISO code of the import country. | |
import_date | DateTime | The declared import date of the shipment. | |
importer_of_record | Address | The party listed on the customs declaration as the official importer. This is the party that is responsible for following all import regulations and is liable for all duties / fees incurred in the importation process. | |
port_of_arrival_code | String | The arrival port code in the code set recognized by the customs authority. For US customs, this would be a Schedule D code. | |
port_of_clearance_code | String | The port code representing the location the goods are cleared through customs utilizing the code set recognized by the customs authority. For US customs, this would be a Schedule D code. | |
port_of_clearance_description | String | A description of clearance port code. Generally, this would be the name of the city / airport. | |
port_of_lading_code | String | The loading port code in the code set recognized by the customs authority. For US customs imports, this would be a Schedule K code. | |
release_date | DateTime | The date the customs authority released the goods for import / export. | |
total_duty | Decimal | The total amount of duty owed to the customs authority. | |
total_fees | Decimal | The total amount of fees owed to the customs authority. | |
us_customs_declaration | UsCustomsDeclaration | Information specific to filing customs declarations with US Customs and Border Protection. |
| Name | Data Type | Description | Required |
|---|---|---|---|
agency_code | String | A code identifying the customs agency issuing the declaration status | |
agency_description | String | An free-text description of the agency | |
status_code | String | A code identifying the agency's issued status. Each customs government agency will generally issue a distinct public code list for each release / hold status. | |
status_date | DateTime | The datetime the status was issued. | |
status_message | String | Any additional message associated with the status code. |
| Name | Data Type | Description | Required |
|---|---|---|---|
bond_type | String | The bond type used for the filing. Generally, one of 0, 8, or 9. | |
cargo_release_status | String | The cargo release status represents the progress of the cargo release process. | |
cargo_release_status_description | String | A text description of the cargo release status code. | |
customs_disposition_us | Array<CustomsDispositionUs> | US Customs disposition status update messages. | |
destination_state | String | The US state the goods will be delivered to. | |
it_date | DateTime | The date the IT Date was obtained from US CBP. | |
it_number | String | The IT Number issued by US CBP that allows the shipment to travel in-bond to another location for clearance. | |
liquidation_date | DateTime | The date the entry is liquidated by US CBP. Generally 314 days after import. | |
location_of_goods | String | The location of goods as filed with US CBP. Generally, this will be a FIRMS code or a GO number. | |
surety_number | String | The three digit numeric code that identifies the surety company on the Customs Bond. |
| Name | Data Type | Description | Required |
|---|---|---|---|
acid_concentration | Decimal | Acid concentration percentage of the hazardous material | |
aggregation_state | String | The collected material state of the dangerous good. Generally one of 'Solid', 'Liquid', or 'Gas' | |
emergency_response_contact | HazmatContactParty | The contact party listed as an emergency response contact in the event of a hazmat emergency | |
empty_uncleaned_receptacle | Boolean | Indication of whether the item is an uncleaned empty receptacle used with a hazardous material | |
ems_number | String | The Emergency Response Procedure code denoting procedures for handling fire or spillage of the dangerous goods | |
flashpoint_temperature_cel | Decimal | The temperature in celcius at which the dangerous good ignites | |
flashpoint_temperature_fah | Decimal | The temperature in Fahrenheit at which the dangerous good ignites | |
flashpoint_temperature_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of C or F. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. | |
imo_class_code | String | The IMO (International Maritime Organization) classification code for the dangerous goods | |
inhalant_hazard | Boolean | Indication of whether the hazardous material is an inhalation hazard | |
marine_pollutant_status | String | The marine pollutant status of the goods, generally one of 'Marine Pollutant' or 'Severe Marine Pollutant' | |
notes | Array<Note> | Notes related to a specific hazardous material. | |
packing_group_code | String | Also known as UN Packing Group, this is the packing code describing the protective packaging for the dangerous goods | |
proper_shipping_name | String | The standard technical name to describe the hazard properties and the composition of dangerous goods | |
radioactivity | Decimal | Radioactivity level of the hazardous material | |
technical_name | String | The recognized chemical name of the substance as used by science | |
transport_in_limited_quantities | Boolean | If true, the dangerous goods are being shipped in a 'limited quantity' and granted relief from certain hazmat shipping requirements | |
undg_number | String | The UN Dangerous Goods Number designating the type of dangerous good being shipped | |
volume_cbms | Decimal | Volume of the hazardous material in cubic meters | |
weight_kgs | Decimal | Weight of the hazardous material in kilograms | |
weight_lbs | Decimal | Weight of the hazardous material in pounds | |
weight_uom | String | The unit of measure indicating the metric or imperial unit received by Chain.io. Should be one of KGS or LBS. Note: This property is only utilized on documents sent by Chain.io. It is not utilized on documents sent to Chain.io. |
| Name | Data Type | Description | Required |
|---|---|---|---|
email | String | The primary email address associated with the person | |
name | String | The person's name | |
phone | String | The primary phone number associated with the person |
| Name | Data Type | Description | Required |
|---|---|---|---|
attachments | Array<Attachment> | Attachments related to this commercial invoice. | |
buyer | Address | The party who is buying the goods. | |
commercial_invoice_lines | Array<CommercialInvoiceLine> | A line on a commercial invoice representing information for a single product. | |
country_of_origin | String | The 2-letter ISO code of the country of origin for the products on the invoice, as defined by the rules of origin. | |
currency | String | 3 letter currency code | |
gross_weight_kgs | Decimal | Total gross weight of all products included on the invoice, in KGS. | |
inco_terms | String | The INCOTerm under which the product is moving like FOB, DDP, etc. | |
invoice_number | String | The invoice number issued by the invoicing party | |
issued_date | DateTime | The date the provider's system issued the invoice. | |
net_weight_kgs | Decimal | Total net weight of all products included on the invoice, in KGS. | |
related_parties | Boolean | Whether the parties on the invoice are related to each other. | |
seller | Address | The party who is selling the goods - sometimes referred to as the vendor. | |
supplier | Address | The party who is supplying the goods. | |
total_due | Decimal | Total amount due |
| Name | Data Type | Description | Required |
|---|---|---|---|
add_indicator | String | Anti-Dumping Duty indicator for the invoice line. | |
commercial_invoice_line_tariffs | Array<CommercialInvoiceLineTariff> | Additional harmonized tariff codes associated with the invoice line. Used where a line has multiple tariff assessments (e.g. US Chapter 99 special or supplemental tariffs applied in addition to the primary tariff_number). | |
commercial_quantity | Decimal | The quantity on the commercial invoice being bought from a supplier. | |
commercial_quantity_uom | String | The unit of measure from the commercial invoice. | |
country_of_export | String | The 2-letter ISO code of the country from which the goods were exported. | |
country_of_origin | String | The 2-letter ISO code of the country of origin for the products on the invoice | |
currency | String | The 3-character ISO 4217 currency code. | |
customs_quantity | Decimal | Quantity to be declared to import customs authority. | |
customs_quantity_2 | Decimal | Secondary quantity to be declared to import customs authority. | |
customs_quantity_2_uom | String | Secondary unit of measure to be declared to import customs authority. | |
customs_quantity_uom | String | Unit of Measure to be declared to import customs authority. | |
cvd_indicator | String | Countervailing Duty indicator for the invoice line. | |
declaration_line_numbers | String | The declaration line numbers this commercial invoice line is associated with. | |
declaration_number | String | The declaration this commercial invoice is associated with. | |
description_of_goods | String | A description of the goods on the commercial invoice line. | |
extended_price | Decimal | The total price for the invoice line before taxes, fees, or discounts. This value is the quantity multipled by the unit_price. | |
gross_weight_kgs | Decimal | Total gross weight of all items represented by the line. | |
line_id | String | The line identifier on the commercial invoice. | |
manufacturer | Address | The manufacturer of the product represented by the line. | |
net_weight_kgs | Decimal | Total net weight of all items represented by the line. | |
part_number | String | The part number used to identify the product sold. | |
po_number | String | The buying party's purchase order number for the goods on the invoice line | |
privilege_status_date | DateTime | The date on which privileged foreign status was requested or applied to the merchandise while in a foreign trade zone. | |
related_parties | Boolean | Indicates whether the buyer and seller are related parties. | |
tariff_number | String | The primary harmonized tariff code associated with the invoice line. | |
trade_agreement_code | String | The trade agreement code applicable to the invoice line (e.g. USMCA, NAFTA). | |
unit_price | Decimal | The unit price prior to discounts, surcharges, and tax. | |
us_mid_code | String | The US Manufacturer Identification Code (MID) for the invoice line, used to identify the manufacturer to US customs. | |
zone_status | String | The foreign trade zone status for the invoice line. |
| Name | Data Type | Description | Required |
|---|---|---|---|
disposition_code | String | A 2-position alphanumeric code indicating the action that has been taken against the bill. | |
disposition_code_description | String | A text description associated with the disposition code. | |
disposition_date | String | The date in which the disposition was issued. | |
disposition_reason_code | String | A secondary code providing additional clarification behind the reason for the disposition code being issued. For example, a disposition code of 11 (Prior Notice Refusal) may be issued and the review reason code may indicate the underlying reason for the refusal (30 - Prior Notice Not Provided For All Foods). | |
order | String | The historical ordering, per disposition code, of when specific disposition codes were received from customs. This field should be used to sort the disposition data in chronological order. | |
pga_identifier | String | The code identifying which partner government agency issued the disposition update. | |
pga_program_code | String | The agency specific code identifying the customs program applicable to the disposition. | |
release_date | DateTime | The date associated with the disposition code update. This date is actual information relayed from customs indicating the date component of a disposition action. For example, a Disposition Code of 71 indicates an intensive hold and the release_date would indicate when the hold was applied, while the disposition_date indicates the actual timestamp the customs system logged the disposition information. | |
type_code | String | A code indicating the type of disposition response. This generally can be used to determine if US CBP issued the disposition update directly or another agency is responsible for the update. |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | A code identifying the type of reference number (ex. EDIREF, PO2, ). | |
description | String | A plain-text description of the reference number code. (ex. "EDI Reference Number", "Secondard PO Number"). | |
value | String | The reference number value. | |
value_context | String | Provides additional contextual hints at the type or classification of data present in the reference's value. |
| Name | Data Type | Description | Required |
|---|---|---|---|
trigger_code | String | A code that can be utilized to identify the type of trigger event. | |
trigger_date | DateTime | A timestamp indicating when the trigger event occurred in the source system. | |
trigger_event_unlocode | Locode | The UN/LOCODE identifying the location where the trigger event occurred. | |
trigger_name | String | <p>A description of the trigger event code.</p><p><em>Some systems may have different descriptions for the same trigger event across shipments, therefore, you should always code against the <code>trigger_code</code> to identify the event type and not the trigger_name.</em></p> | |
triggered_by | Address | The party that caused the trigger event to fire. The data may indicate either a user or company in the source system. |
| Name | Data Type | Description | Required |
|---|---|---|---|
trigger_code | String | A code that can be utilized to identify the type of trigger event. | |
trigger_date | DateTime | A timestamp indicating when the trigger event occurred in the source system. | |
trigger_name | String | <p>A description of the trigger event code.</p><p><em>Some systems may have different descriptions for the same trigger event across shipments, therefore, you should always code against the <code>trigger_code</code> to identify the event type and not the trigger_name.</em></p> | |
triggered_by | Address | The party that caused the trigger event to fire. The data may indicate either a user or company in the source system. |
| Name | Data Type | Description | Required |
|---|---|---|---|
supplemental_tariff_number | String | The supplemental harmonized tariff code for this tariff assessment. | |
tariff_number | String | The primary harmonized tariff code for this tariff assessment. |