| Attribute | Type | Description | 
|---|---|---|
| id | string | Unique identifier for the object | 
| ccn | string | The cargo control number | 
| importer | organization address object | The importer information | 
| supplier | organization address object | The supplier information | 
| shipper | organization address object | The shipper information | 
| currency | currency | Three-letter ISO currency code, in uppercase. Currently only accepts CAD and USD | 
| commercial_invoices | array of commercial invoice objects | An array of commercial invoice objects | 
| total_packages | int | The total number of packages in the consolidated shipment | 
| goods_description | string | A brief description of the goods | 
| total_weight | float | The total weight of the declaration | 
| weight | weight unit | The unit of weight. Accepted weight units are 'g', 'kg', 'oz', 'lb' | 
| destination_port | string | Code for trade and transport locations. Valid codes can be found here. | 
| sublocation | int | The sublocation code. Must be 4 digits long | 
| port_of_clearance | int | The port of clearance. Must be 4 digits long | 
| eta | date | The estimate date of arrival | 
| date_created | date | The date the airway bill was created. Defaulted to today if not provided | 
| transport_mode | enum('road', 'air) | The transportation mode for the shipment. Must be 'road' or 'air' | 
| created | date | The date the consolidated shipment object was created | 
The commercial invoice object
| Attribute | Type | Description | 
|---|---|---|
| invoice_no | string | The invoice number | 
| treatment_code | string | The treatment code to be applied. Default is '02' | 
| vfd_code | string | The value for duty code to be applied. Default is '13' | 
| subtotal_price | float | The total price of just the line items | 
| total_weight | float | The total weight of the line items in the invoice | 
| weight_unit | weight unit | The unit of weight. Accepted weight units are 'g', 'kg', 'oz', 'lb' | 
| packages | int | The total number of packages within the commercial invoice | 
| unique_consignee | organization address object | The unique consignee information associated with the commercial invoice | 
| line_items | array of line item objects | An array of line item objects | 
| date_created | datetime | The date the invoice was created. Defaults to the time the consolidated shipment object is created | 
The line item object
| Attribute | Type | Description | 
|---|---|---|
| product_code | string | The product code | 
| description | string | The product description | 
| country | string | The product country of origin. Two-letter country code (ISO 3166-1 alpha-2) | 
| classification_code | string | The tariff code of the product. More details can be found here. | 
| quantity | integer | The quantity of the product in the shipment | 
| weight | float | The weight of the product | 
| weight_unit | string | The unit of weight. Accepted weight units are 'g', 'kg', 'oz', 'lb'. | 
| unit_price | float | The price of the product | 
| line_price | float | The total price for the line item | 
| customs_value | float | The amount charged to the customer | 
The supplier address object
| Attribute | Type | Description | 
|---|---|---|
| name | string | Full name | 
| string | Email address | |
| phone | string | Phone number of the recipient | 
| address1 | string | Address line 1 | 
| address2 | string | Address line 2 | 
| city | string | City name | 
| state | string | State name | 
| postal_code | string | ZIP or postal code | 
| country | string | Two-letter country code (ISO 3166-1 alpha-2) | 
| unloco | string | Code for trade and transport locations. Valid codes can be found here. | 
The organization address object
| Attribute | Type | Description | 
|---|---|---|
| name | string | Full name | 
| string | Email address | |
| phone | string | Phone number of the recipient | 
| address1 | string | Address line 1 | 
| address2 | string | Address line 2 | 
| city | string | City name | 
| state | string | State name | 
| postal_code | string | ZIP or postal code | 
| country | string | Two-letter country code (ISO 3166-1 alpha-2). Currently only supports CA or US | 
