| Attribute | Type | Description |
|---|---|---|
| manifest_id | string | Unique identifier for the manifest |
| manifest_code | string | Unique code for the manifest |
| manifest_body | string | The manifest body object |
Manifest body object
| Attribute | Type | Description |
|---|---|---|
| cargo | array | An array of cargo objects |
Cargo object
| Attribute | Type | Description |
|---|---|---|
| transporting_carrier_code | string | Report the carrier code of the carrier or freight forwarder reporting the goods. Must transmit a valid, 4-character, CBSA-approved carrier code |
| associated_transport_document_number | string | The reference number assigned by the carrier or carrier’s representative to an original cargo. Usually represents the prime manifest |
| cargo_control_number | string | Cargo control number |
| supplementary_reference_number | string | Reference assigned by the carrier or his representative to the transport document. |
| delivery_country_code | string | Name of the country at which the goods are destined under Customs control of transit procedure, coded |
| place_of_delivery_city | string | Name of the city at which the goods are destined under Customs control of transit procedure |
| place_of_delivery_port | string | Name of the terminal, warehouse or yard where the goods are destined |
| customs_procedure_code | string | Numeric code used to identify cargo moving as import, in-transit, or FROB. 23 = In-transit 24 = Import 26 = Freight Remaining on Board (FROB) |
| currency | string | Must be a valid currency code, ie. CAD, USD |
| special_instructions | string | Special delivery instructions |
| consignee | address object | Name and address of the party to which the goods are consigned |
| consignor | address object | Name and address of the party, which, by contract with a carrier, consigns or sends goods with the carrier, or had them conveyed by him |
| delivery_address | address object | Must be transmitted if different from consignee or ultimate consignee address. When providing delivery destination address, contact name must also be provided |
| notify_party | address object | Name and address of the party to be notified |
| goods | array of goods objects | The items within the shipment |
Address object
| Attribute | Type | Description |
|---|---|---|
| party_identifier | enum | CN= Consignee, CZ = Consignor, DP = Delivery Party, NI = Notify Party, SF = Ship From Party, UC = Ultimate Consignee |
| name | string | |
| code_list_responsible_agency_code | string | |
| party_name | string | |
| address1 | string | Address line 1 |
| address2 | string | Address line 2 |
| post_office_box | string | Post office box number |
| city | string | Address city |
| state | string | Address state |
| country_sub_entity_code | string | |
| postal_identification_code | string | Address postal code |
| country_name_code | string | Address country code |
| country_name | string | Address country name |
| contact_name | string | Contact name |
| contact_phone | string | Contact phone |
| contact_email | string | Contact email |
Goods object
| Attribute | Type | Description |
|---|---|---|
| lading_quantity | integer | Number of packages per nature of commodity packed in such a way that they could not be divided without first undoing the packaging |
| packaging_type | string | Identification of description of the form in which goods are presented |
| description | string | Plain language description of the cargo in general terms only. |
| price | float | The unit price |
| cargo_weight_uom | string | Indicates the UOM in which weight (mass), capacity, length, area, volume, or other quantity is expressed |
| cargo_weight | float | Weight (mass) of goods at the item level including packing but excluding the carrier’s equipment |
| volume_uom | string | Indicates the UOM in which weight (mass), capacity, length, area, volume, or other quantity is expressed |
| volume | float | Volume (cubic) of goods at the item level including packing but excluding the carrier’s equipment. |
| country_of_origin | string | The country of origin of which the product is from |
| dangerous_goods | string | Must be transmitted if dangerous goods code applies to the commodity being reported |
| shipping_marks_numbers | array of string | Marks and numbers identifying individual packages. |
| hs_number | string | Tariff code. Must transmit if available |
{
"manifestID" : "123",
"manifestCode" : "123",
"manifestBody" : {
"transporting_carrier_code": "",
"associated_transport_document_number": "",
"cargo": [
{
"supplementary_reference_number": "",
"delivery_country_code": "",
"place_of_delivery_city": "",
"place_of_delivery_port": "",
"customs_procedure_code": "",
"currency": "",
"special_instructions": "",
"consignee": {
"party_identifier": "",
"name": "",
"code_list_responsible_agency_code": "",
"party_name": "",
"address1": "",
"address2": "",
"post_office_box": "",
"city": "",
"state": "",
"country_sub_entity_code": "",
"postal_identification_code": "",
"country_name_code": "",
"country_name": "",
"contact_name": "",
"contact_phone": "",
"contact_email": ""
},
"consignor" : {
"party_identifier": "",
"name": "",
"code_list_responsible_agency_code": "",
"party_name": "",
"address1": "",
"address2": "",
"post_office_box": "",
"city": "",
"state": "",
"country_sub_entity_code": "",
"postal_identification_code": "",
"country_name_code": "",
"country_name": "",
"contact_name": "",
"contact_phone": "",
"contact_email": ""
},
"delivery_address" : {
"party_identifier": "",
"name": "",
"code_list_responsible_agency_code": "",
"party_name": "",
"address1": "",
"address2": "",
"post_office_box": "",
"city": "",
"state": "",
"country_sub_entity_code": "",
"postal_identification_code": "",
"country_name_code": "",
"country_name": "",
"contact_name": "",
"contact_phone": "",
"contact_email": ""
},
"notify_party" : {
"party_identifier": "",
"name": "",
"code_list_responsible_agency_code": "",
"party_name": "",
"address1": "",
"address2": "",
"post_office_box": "",
"city": "",
"state": "",
"country_sub_entity_code": "",
"postal_identification_code": "",
"country_name_code": "",
"country_name": "",
"contact_name": "",
"contact_phone": "",
"contact_email": ""
},
"goods" : [
{
"lading_quantity": "",
"packaging_type": "",
"description": "",
"country_of_origin": "",
"price": "",
"cargo_weight_uom": "",
"cargo_weight": "",
"volume_uom": "",
"volume": "",
"dangerous_goods": "",
"shipping_marks_numbers": [],
"hs_number": ""
}
]
}
]
}
}