Download OpenAPI specification:
API for use by Freightcom customers. This API uses polling for some long running requests. In those cases the initial request will return a 202 Accepted status.
Version 2.10.0, released in July 2026, that introduces changes related to CPSC (Consumer Product Safety Commission) regulations.
Regulations Validation
cpsc regulated or not by analyzing the customer input product information.Intended Use Details
regulation to a map of valid intended use code and their description.Citation Codes Details
certificate to a map of description and the citation code to use based on the description.How to provide the required CPSC details (if the product comes under CPSC) for shipments going to United States (US) for full customs clearance
cpsc_regulated in customs_data and customs_invoice objects.cpsc_regulated is false then we can omit all the fields mentioned below.product_id and product_id_type (mandatory if cpsc_regulated is true).cpsc_registered_product_information if the product is regulated and registered on the CPSC Registry.cpsc_non_registered_product_information if the product is regulated not registered on the CPSC Registry.cpsc_certificate_not_required_information if the product is exempted under CPSC.The following is only a list of all fields added or modified in version 2.10.0. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /shipment/regulations-validate - new endpointGET /shipment/intended-use-details - new endpointGET /shipment/citation-code-details - new endpointPOST /ratePOST /shipmentGET /shipment/{shipment_id}Version 2.9.0, released in July 2026, that introduces changes related to EU-DE Minimis threshold removal.
shipment_classification in details.The following is only a list of all fields added or modified in version 2.9.0. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /shipmentGET /shipment/{shipment_id}Version 2.8.0, released in April 2026, that introduces HTS validation and enables the continued access to guaranteed Delivered Duty Paid(DDP) guaranteed rates for eligible shipments.
HTS Validation
How to use the new API to get guaranteed rates
hscode (recommended HTS code) and description (recommended description) with the provided_hscode and provided_description as well.The following is only a list of all fields added or modified in version 2.8.0. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /shipment/hts-validate - new endpointPOST /ratePOST /shipmentGET /shipment/{shipment_id}Version 2.7.0, released in March 2026, adds a new way to pay for shipments: Prepaid Shipping. When activated in the customer portal,
The following is only a list of all fields added or modified in version 2.7.0. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /shipmentGET /finance/payment-methods - description updatedGET /finance/payment-method/{payment_method_id}/available-balances - new endpointPOST /finance/reload-prepaid-balance - new endpointVersion 2.6.3, released in March 2026, adds a new endpoint:
The following is only a list of all fields added or modified in version 2.6.3. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /shipment/schedule/validate - new endpointVersion 2.6.2, released in November 2025, adds the following new field.
The following is only a list of all fields added or modified in version 2.6.2. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /ratePOST /shipmentGET /shipment/{shipment_id}Version 2.6.1, released in November 2025, includes the following changes:
This version also includes the following changes that apply only to package and courier pak shipments from Canada to the US. All other shipments will be unaffected by these changes.
The following is only a list of all fields added or modified in version 2.6.1. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /rateGET /rate/{rate_id}POST /shipmentGET /shipment/{shipment_id}Version 2.6.0, released in September 2025, introduces the following features. For a complete list of modified endpoints and fields, see the section below.
There is also a new restriction:
The following is only a list of all fields added or modified in version 2.6.0. Please read the fields' descriptions in the endpoints' documentation for more information.
POST /rateGET /rate/{rate_id}POST /shipmentGET /shipment/{shipment_id}Request a rate estimate.
| services | Array of strings List of service IDs for which to get rates. If not provided then all services will be queried for rates. |
| excluded_services | Array of strings Excluded list of service IDs for which to ignore rates from. |
object (ShippingDetails) Details on a shipment. |
{- "services": [
- "string"
], - "excluded_services": [
- "string"
], - "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}
}{- "request_id": "string"
}Retrieve a requested rate. Also includes details on the number of pending rate lookups to perform if any.
| rate_id required | string The rate ID to retrieve details on. |
{- "status": {
- "done": true,
- "total": 0,
- "complete": 0
}, - "rates": [
- {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}
]
}Calculate freight class for pallet dimensions.
object (Box) |
{- "box": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}
}{- "freight_class": "50"
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Retrieve details on a shipment.
| shipment_id required | string The shipment ID to retrieve details on. |
{- "shipment": {
- "id": "string",
- "unique_id": "string",
- "state": "draft",
- "transaction_number": "string",
- "primary_tracking_number": "string",
- "tracking_numbers": [
- "string"
], - "tracking_url": "string",
- "return_tracking_number": "string",
- "bol_number": "string",
- "pickup_confirmation_number": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": null,
- "month": null,
- "day": null
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "transport_data": { },
- "labels": [
- {
- "size": "letter",
- "format": "pdf",
- "url": "string",
- "padded": true
}
], - "customs_invoice_url": "string",
- "rate": {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}, - "order_source": "string",
- "paperless_customs_documents": [
- {
- "id": "string",
- "type": "string",
- "type_other_name": "string",
- "file_name": "string",
- "url": "string"
}
]
}
}Retrieve tracking events for a shipment.
| shipment_id required | string The shipment ID to retrieve details on. |
{- "events": [
- {
- "type": "label-created",
- "when": "string",
- "where": {
- "city": "string",
- "region": "string",
- "country": "string"
}, - "message": "string"
}
]
}Get details on scheduling.
| shipment_id required | string The shipment ID to get the scheduling status. |
{- "status": "pending",
- "error": "string",
- "pickup_confirmation_number": "string"
}Schedule a dispatch or pickup.
| shipment_id required | string The shipment ID to schedule. |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. |
{- "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}
}If date/ready_at/ready_until are omitted, defaults are used. The response returns the validated pickup window. If the requested window is not available, the window may be adjusted to the next available window. When a full window is provided, exact_match indicates whether the returned window matches the requested window. Supported packaging types: package, courier-pak, envelope.
| carrier_id required | string |
| service_id required | string |
required | object |
required | object |
object (Date) | |
object (TimeOfDay) Time of day in 24 hour time. | |
object (TimeOfDay) Time of day in 24 hour time. |
{- "carrier_id": "string",
- "service_id": "string",
- "origin": {
- "package_type": "string",
- "postal_code": "string",
- "country": "string",
- "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "region": "string",
- "city": "string",
- "unit_number": "string"
}
}, - "destination": {
- "postal_code": "string",
- "country": "string"
}, - "pickup_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "open_time": {
- "hour": 15,
- "minute": 6
}, - "close_time": {
- "hour": 15,
- "minute": 6
}
}{- "pickup_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "open_time": {
- "hour": 15,
- "minute": 6
}, - "close_time": {
- "hour": 15,
- "minute": 6
}
}Use Recommended HTS code for your customs' products. All fields are optional but must be provided for the most accurate results.
Array of objects |
{- "data": [
- {
- "code": "string",
- "name": "string",
- "description": "string"
}
]
}[- {
- "provided_code": "string",
- "provided_description": "string",
- "recommended_array": [
- {
- "valid_code": "string",
- "valid_description": "string"
}
]
}
]Validate regulations for your customs' products.
All fields are optional but must be provided for the most accurate results.
id is used for mapping request to response and does not have any impact over the returned results.
| regulation_type | enum Value: "CPSC" Regulation Type to check for, only |
Array of objects |
{- "regulation_type": "CPSC",
- "data": [
- {
- "id": "string",
- "code": "string",
- "name": "string",
- "description": "string",
- "country_of_origin": "string"
}
]
}[- {
- "regulated": true,
- "id": "string",
- "cpsc_regulated_data": {
- "certificate_type": "CPC",
- "disclaimer_code": "A"
}
}
]Returns a map of product categories to a map of use case codes and descriptions.
{- "MedicalDevices": {
- "081.001": "For Human Medical Use as a Medical Device",
- "081.002": "Import of a foreign-manufactured device for domestic refurbishing"
}, - "Food": {
- "210.000": "For Personal Use as Human Food",
- "970.000": "Import for Export"
}, - "Cosmetic": {
- "100.000": "Importation for Personal Use",
- "970.000": "Import for Export"
}, - "Biological": {
- "080.000": "For Human Medical Use as a Non-Food Pruduce under Controlled Distribution",
- "970.000": "Import for Export"
}, - "CPSC": {
- "081.001": "Import of a device, accessory, or component (regulated as a finished Medical Device) intended to be used as a finished medical device",
- "970.000": "For Export – if subcode below does not apply"
}
}Returns accepted citation codes and descriptions grouped by CertificateTypeCPC and CertificateTypeGCC.
{- "CertificateTypeCPC": {
- "4.1 - ASTM F963: Material quality": "4.1",
- "4.3.5.1(2) - ASTM F963: Paint and Similar Surface Coating Materials": "4.3.5.1(2)",
- "1203 - 16 CFR 1203: Safety Standard for Bicycle Helmets": "1203",
- "1307 - 16 CFR 1307: Prohibition of Children's Toys and Child Care Articles Containing Specified Phthalates": "1307"
}, - "CertificateTypeGCC": {
- "1203 - 16 CFR 1203: Safety Standard for Bicycle Helmets": "1203",
- "1211 - 16 CFR 1211: Safety Standard for Automatic Residential Garage Door Operators": "1211",
- "1303 - 16 CFR 1303: Ban of Lead-Containing Paint and Certain Consumer Products Bearing Lead-Containing Paint": "1303"
}
}Get the payment methods available for your account.
(UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, your credit card payment methods will still be returned, but you can no longer use credit cards to book shipments. Credit cards can be used to reload your prepaid balance, and your prepaid payment method can be used to book shipments.
[- {
- "id": "string",
- "type": "credit-card",
- "label": "string"
}
]Get the available balances for a Net Terms or Prepaid payment method.
(NEW in 2.7.0)
| payment_method_id required | string The Net Terms or Prepaid payment method ID to get available balances for. |
{- "id": "string",
- "type": "net-terms",
- "label": "string",
- "available_balances": [
- {
- "currency": "CAD",
- "value": "4250"
}
]
}Reload your Prepaid balance from a credit card payment method with a one-time payment.
(NEW in 2.7.0)
The amount currency, CAD or USD, will determine which currency will be charged to your credit card and which Prepaid balance the funds will be added to: your CAD balance or your USD balance.
The amount must be at least $25 CAD or USD.
This is a one-time transaction. You can set up automatic reload and email warnings in the customer portal.
The 200 response contains the amount that was reloaded, the Prepaid balance after the reload, and information about the credit card receipt generated for the transaction.
If another Prepaid activity occurs at the same time, such as booking a shipment or reloading twice with the same currency,
the available_balance in the response may reflect the balance before or after the other activity.
In this case, you can find accurate balances before and after each activity on your statement in the customer portal.
| from_payment_method_id | string The credit card payment method id that will be charged. |
object (Money) |
{- "from_payment_method_id": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}{- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "available_balance": {
- "currency": "CAD",
- "value": "4250"
}, - "receipt_document_id": "string",
- "receipt_email_recipients": [
- "string"
]
}Get a list of documents in a date range.
| start_date required | string Example: start_date=2021-07-01 The start date in UTC to search in. |
| end_date required | string Example: end_date=2021-07-31 The end date in UTC. |
{- "id": "string",
- "type": "string",
- "number": "string",
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "due_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "owing": {
- "currency": "CAD",
- "value": "4250"
}
}Get a particular document with details.
| document_id required | string The document to retrieve details on. |
{- "id": "string",
- "type": "string",
- "number": "string",
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "due_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "owing": {
- "currency": "CAD",
- "value": "4250"
}, - "urls": { },
- "payments": [
- {
- "id": "string",
- "type": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "data": {
- "credit_card_auth": "string",
- "credit_card_number": "string",
- "credit_card_reference": "string"
}
}
], - "line_items": [
- {
- "id": "string",
- "type": "base",
- "sub_type": "string",
- "payment_id": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "message": "string"
}
]
}Get invoices for the shipment id
| shipment_id required | string The shipment id to retrieve invoices for. |
[- {
- "id": "string",
- "type": "string",
- "number": "string",
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "due_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "owing": {
- "currency": "CAD",
- "value": "4250"
}, - "urls": { },
- "payments": [
- {
- "id": "string",
- "type": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "data": {
- "credit_card_auth": "string",
- "credit_card_number": "string",
- "credit_card_reference": "string"
}
}
], - "line_items": [
- {
- "id": "string",
- "type": "base",
- "sub_type": "string",
- "payment_id": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "message": "string"
}
]
}
]Get invoices for the shipment transaction number
| transaction_number required | string The transaction number to retrieve invoices for. |
[- {
- "id": "string",
- "type": "string",
- "number": "string",
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "due_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "owing": {
- "currency": "CAD",
- "value": "4250"
}, - "urls": { },
- "payments": [
- {
- "id": "string",
- "type": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "data": {
- "credit_card_auth": "string",
- "credit_card_number": "string",
- "credit_card_reference": "string"
}
}
], - "line_items": [
- {
- "id": "string",
- "type": "base",
- "sub_type": "string",
- "payment_id": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "message": "string"
}
]
}
]Initiate a manifest request.
| carrier_id | string |
object Contains additional data that can be used to filter or limit the manifest request. Specific fields required depending upon the carrier. |
{- "carrier_id": "string",
- "manifest_data": {
- "tracking_numbers": [
- "string"
], - "manifest_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "origin_postal_code": "string"
}
}{- "request_id": "string"
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Get the payment methods available for your account.
(UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, your credit card payment methods will still be returned, but you can no longer use credit cards to book shipments. Credit cards can be used to reload your prepaid balance, and your prepaid payment method can be used to book shipments.
[- {
- "id": "string",
- "type": "credit-card",
- "label": "string"
}
]Get the available balances for a Net Terms or Prepaid payment method.
(NEW in 2.7.0)
| payment_method_id required | string The Net Terms or Prepaid payment method ID to get available balances for. |
{- "id": "string",
- "type": "net-terms",
- "label": "string",
- "available_balances": [
- {
- "currency": "CAD",
- "value": "4250"
}
]
}Reload your Prepaid balance from a credit card payment method with a one-time payment.
(NEW in 2.7.0)
The amount currency, CAD or USD, will determine which currency will be charged to your credit card and which Prepaid balance the funds will be added to: your CAD balance or your USD balance.
The amount must be at least $25 CAD or USD.
This is a one-time transaction. You can set up automatic reload and email warnings in the customer portal.
The 200 response contains the amount that was reloaded, the Prepaid balance after the reload, and information about the credit card receipt generated for the transaction.
If another Prepaid activity occurs at the same time, such as booking a shipment or reloading twice with the same currency,
the available_balance in the response may reflect the balance before or after the other activity.
In this case, you can find accurate balances before and after each activity on your statement in the customer portal.
| from_payment_method_id | string The credit card payment method id that will be charged. |
object (Money) |
{- "from_payment_method_id": "string",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}{- "amount": {
- "currency": "CAD",
- "value": "4250"
}, - "available_balance": {
- "currency": "CAD",
- "value": "4250"
}, - "receipt_document_id": "string",
- "receipt_email_recipients": [
- "string"
]
}Request a rate estimate.
| services | Array of strings List of service IDs for which to get rates. If not provided then all services will be queried for rates. |
| excluded_services | Array of strings Excluded list of service IDs for which to ignore rates from. |
object (ShippingDetails) Details on a shipment. |
{- "services": [
- "string"
], - "excluded_services": [
- "string"
], - "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}
}{- "request_id": "string"
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Retrieve details on a shipment.
| shipment_id required | string The shipment ID to retrieve details on. |
{- "shipment": {
- "id": "string",
- "unique_id": "string",
- "state": "draft",
- "transaction_number": "string",
- "primary_tracking_number": "string",
- "tracking_numbers": [
- "string"
], - "tracking_url": "string",
- "return_tracking_number": "string",
- "bol_number": "string",
- "pickup_confirmation_number": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": null,
- "month": null,
- "day": null
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "transport_data": { },
- "labels": [
- {
- "size": "letter",
- "format": "pdf",
- "url": "string",
- "padded": true
}
], - "customs_invoice_url": "string",
- "rate": {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}, - "order_source": "string",
- "paperless_customs_documents": [
- {
- "id": "string",
- "type": "string",
- "type_other_name": "string",
- "file_name": "string",
- "url": "string"
}
]
}
}Request a rate estimate.
| services | Array of strings List of service IDs for which to get rates. If not provided then all services will be queried for rates. |
| excluded_services | Array of strings Excluded list of service IDs for which to ignore rates from. |
object (ShippingDetails) Details on a shipment. |
{- "services": [
- "string"
], - "excluded_services": [
- "string"
], - "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}
}{- "request_id": "string"
}Retrieve a requested rate. Also includes details on the number of pending rate lookups to perform if any.
| rate_id required | string The rate ID to retrieve details on. |
{- "status": {
- "done": true,
- "total": 0,
- "complete": 0
}, - "rates": [
- {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}
]
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Retrieve details on a shipment.
| shipment_id required | string The shipment ID to retrieve details on. |
{- "shipment": {
- "id": "string",
- "unique_id": "string",
- "state": "draft",
- "transaction_number": "string",
- "primary_tracking_number": "string",
- "tracking_numbers": [
- "string"
], - "tracking_url": "string",
- "return_tracking_number": "string",
- "bol_number": "string",
- "pickup_confirmation_number": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": null,
- "month": null,
- "day": null
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "transport_data": { },
- "labels": [
- {
- "size": "letter",
- "format": "pdf",
- "url": "string",
- "padded": true
}
], - "customs_invoice_url": "string",
- "rate": {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}, - "order_source": "string",
- "paperless_customs_documents": [
- {
- "id": "string",
- "type": "string",
- "type_other_name": "string",
- "file_name": "string",
- "url": "string"
}
]
}
}Request a rate estimate.
| services | Array of strings List of service IDs for which to get rates. If not provided then all services will be queried for rates. |
| excluded_services | Array of strings Excluded list of service IDs for which to ignore rates from. |
object (ShippingDetails) Details on a shipment. |
{- "services": [
- "string"
], - "excluded_services": [
- "string"
], - "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}
}{- "request_id": "string"
}Retrieve a requested rate. Also includes details on the number of pending rate lookups to perform if any.
| rate_id required | string The rate ID to retrieve details on. |
{- "status": {
- "done": true,
- "total": 0,
- "complete": 0
}, - "rates": [
- {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}
]
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Retrieve details on a shipment.
| shipment_id required | string The shipment ID to retrieve details on. |
{- "shipment": {
- "id": "string",
- "unique_id": "string",
- "state": "draft",
- "transaction_number": "string",
- "primary_tracking_number": "string",
- "tracking_numbers": [
- "string"
], - "tracking_url": "string",
- "return_tracking_number": "string",
- "bol_number": "string",
- "pickup_confirmation_number": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": null,
- "month": null,
- "day": null
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "transport_data": { },
- "labels": [
- {
- "size": "letter",
- "format": "pdf",
- "url": "string",
- "padded": true
}
], - "customs_invoice_url": "string",
- "rate": {
- "carrier_name": "string",
- "service_name": "string",
- "service_id": "string",
- "valid_until": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "total": {
- "currency": "CAD",
- "value": "4250"
}, - "base": {
- "currency": "CAD",
- "value": "4250"
}, - "surcharges": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "taxes": [
- {
- "type": "fuel",
- "amount": {
- "currency": "CAD",
- "value": "4250"
}
}
], - "transit_time_days": 5,
- "transit_time_not_available": true,
- "transit_time_hours": 5,
- "carrier_cut_off_time": "12-04-2026 09:10AM",
- "estimated_delivery_time": "15-04-2026 06:30PM",
- "paperless": true,
- "customs_charge_data": {
- "duties_and_taxes_surcharge_keys": [
- "string"
], - "guarantee_fee_surcharge_keys": [
- "string"
], - "carrier_and_government_fees_surcharge_keys": [
- "string"
], - "processing_fees_surcharge_keys": [
- "string"
], - "is_rate_guaranteed": true
}
}, - "order_source": "string",
- "paperless_customs_documents": [
- {
- "id": "string",
- "type": "string",
- "type_other_name": "string",
- "file_name": "string",
- "url": "string"
}
]
}
}Request a rate estimate.
| services | Array of strings List of service IDs for which to get rates. If not provided then all services will be queried for rates. |
| excluded_services | Array of strings Excluded list of service IDs for which to ignore rates from. |
object (ShippingDetails) Details on a shipment. |
{- "services": [
- "string"
], - "excluded_services": [
- "string"
], - "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}
}{- "request_id": "string"
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}Book a shipment.
| unique_id required | string Maximum length of 128 characters. Uppercase and lowercase characters are considered equal for comparisons. Used to uniquely identify a shipment. If the unique_id matches a previously created shipment that is in the process of booking or booked successfully then a new shipment will NOT be created and the ID for the previously created shipment will be returned. If the previously created shipment had an error during booking or was cancelled then a new shipment with the unique_id will be created and unique_id will be associated with this new shipment. |
| payment_method_id required | string Payment method to use, obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| customs_and_duties_payment_method_id | string (NEW in 2.6.0) Payment method to use to pay for the customs charges when booking a DDP shipment (shipper pays the customs charges). If omitted, payment_method_id will be used to pay for all charges including customs charges. If you are booking a DDP shipment and payment_method_id is your Net Terms payment method, then you must specify a credit card payment method in this field to pay for the customs charges. Obtained from /finance/payment-methods. (UPDATED in 2.7.0) If you have activated Prepaid Shipping in the customer portal, you must use your prepaid payment method to book shipments. |
| service_id required | string Service to book with. |
required | object (ShippingDetails) Details on a shipment. |
object Customs invoice info. Required for international shipments. | |
object (PickupDetails) Courier pickup details, required if courier service utilized. | |
object (DispatchDetails) LTL dispatch details, required if dispatch service utilized. | |
Array of objects (NEW in 2.6.0) Paperless customs documents to upload to the carrier, if supported. Currently, we support paperless customs documents for international shipments with paperless rates from FedEx Courier and UPS. Each carrier limits the number of files that can be uploaded:
A paperless customs invoice is created automatically: it is not necessary to upload one. The paperless customs invoice does not count towards the maximum # of files that may be uploaded. Since an API request is limited to at most 6 MB, and files must be Base64 encoded, this puts an upper limit of approximately 4.5 MB (before Base64 encoding) on the total size of all files that may be uploaded in a single request. |
{- "unique_id": "string",
- "payment_method_id": "string",
- "customs_and_duties_payment_method_id": "string",
- "service_id": "string",
- "details": {
- "origin": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true
}, - "destination": {
- "name": "Philip J Fry",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "residential": true,
- "tailgate_required": true,
- "instructions": "string",
- "contact_name": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_addresses": [
- "user@example.com"
], - "receives_email_updates": true,
- "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "signature_requirement": "not-required"
}, - "expected_ship_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "packaging_type": "pallet",
- "packaging_properties": {
- "pallet_type": "ltl",
- "has_stackable_pallets": true,
- "dangerous_goods": "limited-quantity",
- "dangerous_goods_details": {
- "packaging_group": "string",
- "goods_class": "string",
- "description": "string",
- "united_nations_number": "string",
- "emergency_contact_name": "string",
- "emergency_contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "pallets": [
- {
- "measurements": {
- "weight": {
- "unit": "lb",
- "value": 2.95
}, - "cuboid": {
- "unit": "ft",
- "l": 5,
- "w": 5,
- "h": 5
}
}, - "description": "string",
- "freight_class": "string",
- "nmfc": "string",
- "contents_type": "string",
- "num_pieces": 0
}
], - "pallet_service_details": {
- "limited_access_delivery_type": "construction-site",
- "limited_access_delivery_other_name": "string",
- "in_bond": true,
- "in_bond_details": {
- "type": "immediate-exportation",
- "name": "string",
- "address": "string",
- "contact_method": "email-address",
- "contact_email_address": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "appointment_delivery": true,
- "protect_from_freeze": true,
- "threshold_pickup": true,
- "threshold_delivery": true,
- "amazon_or_fba_delivery": true,
- "amazon_or_fba_delivery_details": {
- "fba_number": "string",
- "order_id": "string"
}
}
}, - "insurance": {
- "type": "internal",
- "total_cost": {
- "currency": "CAD",
- "value": "4250"
}
}, - "reference_codes": [
- "string"
], - "shipment_classification": "B2B",
- "customs_data": {
- "products": [
- {
- "hs_code": "string",
- "hsverified": true,
- "product_name": "string",
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "product_id": "string",
- "product_id_type": "SKU",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "completed_kitchen_cabinets_or_vanities": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
], - "request_guaranteed_customs_charges": true
}
}, - "customs_invoice": {
- "source": "details",
- "broker": {
- "use_carrier": true,
- "name": "string",
- "account_number": "string",
- "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "fax_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "usmca_number": "string",
- "fda_number": "string"
}, - "details": {
- "tax_recipient": {
- "type": "shipper",
- "shipper_tax_identifier": "string",
- "receiver_tax_identifier": "string",
- "third_party_tax_identifier": "string",
- "other_tax_identifier": "string",
- "name": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "reason_for_export": "gift",
- "additional_remarks": "string",
- "comments": "string"
}, - "sold_to": {
- "company_name": "string",
- "attention_name": "string",
- "tax_identification": "string",
- "address": {
- "address_line_1": "200 University Avenue West",
- "address_line_2": "string",
- "unit_number": "42a",
- "city": "Waterloo",
- "region": "ON",
- "country": "CA",
- "postal_code": "string"
}, - "phone_number": {
- "number": "5554447777",
- "extension": "123"
}, - "email_address": "string",
- "account_number": "string"
}, - "products": [
- {
- "product_name": "string",
- "product_id": "string",
- "product_id_type": "SKU",
- "merchant_product_identifier": "string",
- "non_standardised_manufacturer_product_identifier": "string",
- "standardised_manufacturer_product_identifier": "string",
- "cpsc_regulated": true,
- "cpsc_registered_product_information": {
- "certifier_id": "string",
- "product_id": "string",
- "version_id": "string"
}, - "cpsc_non_registered_product_information": {
- "product_certificate_declaration": true,
- "certificate_type": "CPC",
- "product_details": {
- "sku_code": "string",
- "model_number": "string",
- "serial_number": "string",
- "alternate_id": "string",
- "gtin_code": "string",
- "upc_code": "string",
- "model_description": "string",
- "model_color": "string",
- "model_style": "string"
}, - "manufacturer_details": {
- "specialized_in_small_batch_production": true,
- "small_batch_manufacturer_registry_id": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "phone_number": "string",
- "country": "string",
- "manufacturer_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "lot_details": {
- "lot_number": "string",
- "lot_number_qualifier": "MANUFACTURER",
- "production_start_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "production_end_date": {
- "year": 0,
- "month": 1,
- "day": 1
}
}, - "citation_details": [
- {
- "previously_tested": true,
- "lab_id": "string",
- "lab_type": "CPSC_ACCEPTED",
- "citation_code": "string",
- "lab_test_date": {
- "year": 0,
- "month": 1,
- "day": 1
}, - "test_report_id": "string",
- "test_report_access_key": "string",
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
], - "point_of_contact": {
- "contact_name": "string",
- "company_name": "string",
- "email_address": "user@example.com",
- "phone_number": "string",
- "ext": "string",
- "address_line1": "string",
- "city": "string",
- "province_or_state": "string",
- "postal_code": "string",
- "country": "string"
}
}, - "cpsc_certificate_not_required_information": {
- "disclaimer_code": "string",
- "intended_use_code": "string",
- "intended_use_description": "string"
}, - "weight": {
- "unit": "lb",
- "value": 2.95
}, - "hs_code": "string",
- "hsverified": true,
- "provided_hscode": "string",
- "provided_description": "string",
- "country_of_origin": "CA",
- "num_units": 1,
- "unit_price": {
- "currency": "CAD",
- "value": "4250"
}, - "description": "string",
- "cusma_included": true,
- "non_auto_parts": true,
- "fda_regulated": "yes",
- "product_composition_allocation": {
- "provided": true,
- "steel_percentage": 1,
- "aluminum_percentage": 1,
- "copper_percentage": 1
}, - "product_composition_allocation_zero": true
}
]
}
}, - "pickup_details": {
- "pre_scheduled_pickup": true,
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}, - "pickup_location": "string",
- "contact_name": "string",
- "contact_phone_number": {
- "number": "5554447777",
- "extension": "123"
}
}, - "dispatch_details": {
- "date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "ready_at": {
- "hour": 15,
- "minute": 6
}, - "ready_until": {
- "hour": 15,
- "minute": 6
}
}, - "paperless_customs_documents": [
- {
- "type": "cusma-form",
- "type_other_name": "string",
- "file_name": "string",
- "file_base64": "string"
}
]
}{- "id": "string",
- "previously_created": true
}If date/ready_at/ready_until are omitted, defaults are used. The response returns the validated pickup window. If the requested window is not available, the window may be adjusted to the next available window. When a full window is provided, exact_match indicates whether the returned window matches the requested window. Supported packaging types: package, courier-pak, envelope.
| carrier_id required | string |
| service_id required | string |
required | object |
required | object |
object (Date) | |
object (TimeOfDay) Time of day in 24 hour time. | |
object (TimeOfDay) Time of day in 24 hour time. |
{- "carrier_id": "string",
- "service_id": "string",
- "origin": {
- "package_type": "string",
- "postal_code": "string",
- "country": "string",
- "address": {
- "address_line_1": "string",
- "address_line_2": "string",
- "region": "string",
- "city": "string",
- "unit_number": "string"
}
}, - "destination": {
- "postal_code": "string",
- "country": "string"
}, - "pickup_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "open_time": {
- "hour": 15,
- "minute": 6
}, - "close_time": {
- "hour": 15,
- "minute": 6
}
}{- "pickup_date": {
- "year": 2006,
- "month": 6,
- "day": 7
}, - "open_time": {
- "hour": 15,
- "minute": 6
}, - "close_time": {
- "hour": 15,
- "minute": 6
}
}Use Recommended HTS code for your customs' products. All fields are optional but must be provided for the most accurate results.
Array of objects |
{- "data": [
- {
- "code": "string",
- "name": "string",
- "description": "string"
}
]
}[- {
- "provided_code": "string",
- "provided_description": "string",
- "recommended_array": [
- {
- "valid_code": "string",
- "valid_description": "string"
}
]
}
]Validate regulations for your customs' products.
All fields are optional but must be provided for the most accurate results.
id is used for mapping request to response and does not have any impact over the returned results.
| regulation_type | enum Value: "CPSC" Regulation Type to check for, only |
Array of objects |
{- "regulation_type": "CPSC",
- "data": [
- {
- "id": "string",
- "code": "string",
- "name": "string",
- "description": "string",
- "country_of_origin": "string"
}
]
}[- {
- "regulated": true,
- "id": "string",
- "cpsc_regulated_data": {
- "certificate_type": "CPC",
- "disclaimer_code": "A"
}
}
]Returns a map of product categories to a map of use case codes and descriptions.
{- "MedicalDevices": {
- "081.001": "For Human Medical Use as a Medical Device",
- "081.002": "Import of a foreign-manufactured device for domestic refurbishing"
}, - "Food": {
- "210.000": "For Personal Use as Human Food",
- "970.000": "Import for Export"
}, - "Cosmetic": {
- "100.000": "Importation for Personal Use",
- "970.000": "Import for Export"
}, - "Biological": {
- "080.000": "For Human Medical Use as a Non-Food Pruduce under Controlled Distribution",
- "970.000": "Import for Export"
}, - "CPSC": {
- "081.001": "Import of a device, accessory, or component (regulated as a finished Medical Device) intended to be used as a finished medical device",
- "970.000": "For Export – if subcode below does not apply"
}
}Returns accepted citation codes and descriptions grouped by CertificateTypeCPC and CertificateTypeGCC.
{- "CertificateTypeCPC": {
- "4.1 - ASTM F963: Material quality": "4.1",
- "4.3.5.1(2) - ASTM F963: Paint and Similar Surface Coating Materials": "4.3.5.1(2)",
- "1203 - 16 CFR 1203: Safety Standard for Bicycle Helmets": "1203",
- "1307 - 16 CFR 1307: Prohibition of Children's Toys and Child Care Articles Containing Specified Phthalates": "1307"
}, - "CertificateTypeGCC": {
- "1203 - 16 CFR 1203: Safety Standard for Bicycle Helmets": "1203",
- "1211 - 16 CFR 1211: Safety Standard for Automatic Residential Garage Door Operators": "1211",
- "1303 - 16 CFR 1303: Ban of Lead-Containing Paint and Certain Consumer Products Bearing Lead-Containing Paint": "1303"
}
}