Karrio API (2023.4.6)
Download OpenAPI specification:Download
Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services.
The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API.
When backwards-incompatible changes are made to the API, a new, dated version is released.
The current version is 2023.4.6
.
Read our API changelog and to learn more about backwards compatibility.
As a precaution, use API versioning to check a new API version before committing to an upgrade.
The Karrio API offer the possibility to create and retrieve certain objects in test_mode
.
In development, it is therefore possible to add carrier connections, get live rates,
buy labels, create trackers and schedule pickups in test_mode
.
All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset.
Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100.
{
"count": 100,
"next": "/v1/shipments?limit=25&offset=50",
"previous": "/v1/shipments?limit=25&offset=25",
"results": [
{ ... },
]
}
Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects.
Metadata is useful for storing additional, structured information on an object. As an example, you could store your user's full name and corresponding unique identifier from your system on a Karrio Order object.
Do not store any sensitive information as metadata.
API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password.
$ curl https://instance.api.com/v1/shipments \
-u key_xxxxxx:
# The colon prevents curl from asking for a password.
If you need to authenticate via bearer auth (e.g., for a cross-origin request),
use -H "Authorization: Token key_xxxxxx"
instead of -u key_xxxxxx
.
All API requests must be made over HTTPS. API requests without authentication will also fail.
Response samples
- 200
{- "VERSION": "",
- "APP_NAME": "",
- "HOST": "",
- "ADMIN": "",
- "OPENAPI": "",
- "GRAPHQL": "",
- "AUDIT_LOGGING": true,
- "ALLOW_SIGNUP": true,
- "ALLOW_ADMIN_APPROVED_SIGNUP": true,
- "ALLOW_MULTI_ACCOUNT": true,
- "MULTI_ORGANIZATIONS": true,
- "ORDERS_MANAGEMENT": true,
- "APPS_MANAGEMENT": true,
- "DOCUMENTS_MANAGEMENT": true,
- "DATA_IMPORT_EXPORT": true,
- "CUSTOM_CARRIER_DEFINITION": true,
- "PERSIST_SDK_TRACING": true,
- "ORDER_DATA_RETENTION": true,
- "TRACKER_DATA_RETENTION": true,
- "SHIPMENT_DATA_RETENTION": true,
- "API_LOGS_DATA_RETENTION": true,
- "ORG_LEVEL_BILLING": true,
- "TENANT_LEVEL_BILLING": true
}
Obtain auth token pair
Authenticate the user and return a token pair
Request Body schema: application/json
email required | string |
password required | string |
Responses
Request samples
- Payload
{- "email": "string",
- "password": "string"
}
Response samples
- 201
{- "access": "string",
- "refresh": "string"
}
Get verified JWT token
Get a verified JWT token pair by submitting a Two-Factor authentication code.
Request Body schema: application/json
refresh required | string |
otp_token required | string The OTP (One Time Password) token received by the user from the configured Two Factor Authentication method. |
Responses
Request samples
- Payload
{- "refresh": "string",
- "otp_token": "string"
}
Response samples
- 201
{- "access": "string",
- "refresh": "string"
}
Response samples
- 200
{- "VERSION": "",
- "APP_NAME": "",
- "HOST": "",
- "ADMIN": "",
- "OPENAPI": "",
- "GRAPHQL": "",
- "AUDIT_LOGGING": true,
- "ALLOW_SIGNUP": true,
- "ALLOW_ADMIN_APPROVED_SIGNUP": true,
- "ALLOW_MULTI_ACCOUNT": true,
- "MULTI_ORGANIZATIONS": true,
- "ORDERS_MANAGEMENT": true,
- "APPS_MANAGEMENT": true,
- "DOCUMENTS_MANAGEMENT": true,
- "DATA_IMPORT_EXPORT": true,
- "CUSTOM_CARRIER_DEFINITION": true,
- "PERSIST_SDK_TRACING": true,
- "ORDER_DATA_RETENTION": true,
- "TRACKER_DATA_RETENTION": true,
- "SHIPMENT_DATA_RETENTION": true,
- "API_LOGS_DATA_RETENTION": true,
- "ORG_LEVEL_BILLING": true,
- "TENANT_LEVEL_BILLING": true,
- "ADDRESS_AUTO_COMPLETE": { },
- "countries": { },
- "currencies": { },
- "carriers": { },
- "customs_content_type": { },
- "incoterms": { },
- "states": { },
- "services": { },
- "connection_configs": { },
- "service_names": { },
- "options": { },
- "option_names": { },
- "package_presets": { },
- "packaging_types": { },
- "payment_types": { },
- "carrier_capabilities": { },
- "service_levels": { }
}
This is an object representing your a Karrio carrier account connectsions.
You can retrieve all configured connections available to your Karrio account.
The carrier_id
is a nickname you assign to your connection.
List all carriers
Returns the list of configured carriers
Authorizations:
query Parameters
active | boolean |
carrier_name | string The unique carrier slug. |
system_only | boolean |
Responses
Response samples
- 200
- 400
{- "count": 0,
- "results": [
- {
- "id": "string",
- "object_type": "carrier",
- "carrier_id": "string",
- "carrier_name": "amazon_mws",
- "display_name": "string",
- "test_mode": true,
- "active": true,
- "capabilities": [
- "string"
], - "metadata": { },
- "config": { }
}
]
}
Get carrier services
Retrieve a carrier's services
Authorizations:
path Parameters
carrier_name required | string The unique carrier slug. |
Responses
Response samples
- 200
- 404
- 500
{- "property1": null,
- "property2": null
}
This is an object representing your a Karrio shipping address. You can retrieve all addresses related to your Karrio account. Address objects are linked to your shipment history, and can be used for recurring shipping to / from the same locations.
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}
]
}
Create an address
Create a new address.
Authorizations:
Request Body schema: application/json
postal_code | string or null <= 10 characters The address postal code (required for shipment purchase) |
city | string or null <= 30 characters The address city. (required for shipment purchase) |
federal_tax_id | string or null <= 20 characters The party frederal tax id |
state_tax_id | string or null <= 20 characters The party state id |
person_name | string or null <= 30 characters Attention to (required for shipment purchase) |
company_name | string or null <= 30 characters The company name if the party is a company |
country_code required | string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AR" "AS" "AT" "AU" "AW" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BM" "BN" "BO" "BR" "BS" "BT" "BW" "BY" "BZ" "CA" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "IC" "ID" "IE" "IL" "IN" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KV" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PR" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SY" "SZ" "TC" "TD" "TG" "TH" "TJ" "TL" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WS" "XB" "XC" "XE" "XM" "XN" "XS" "XY" "YE" "YT" "ZA" "ZM" "ZW" The address country code
|
string or null The party email | |
phone_number | string or null <= 20 characters The party phone number. |
state_code | string or null <= 20 characters The address state code |
suburb | string or null <= 20 characters The address suburb if known |
residential | boolean or null Default: false Indicate if the address is residential or commercial (enterprise) |
street_number | string or null <= 20 characters The address street number |
address_line1 | string or null <= 50 characters The address line with street number |
address_line2 | string or null <= 50 characters The address line with suite number |
validate_location | boolean or null Default: false Indicate if the address should be validated |
Responses
Request samples
- Payload
{- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}
Retrieve an address
Retrieve an address.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 400
- 500
{- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}
Update an address
update an address.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
postal_code | string or null <= 10 characters The address postal code (required for shipment purchase) |
city | string or null <= 30 characters The address city. (required for shipment purchase) |
federal_tax_id | string or null <= 20 characters The party frederal tax id |
state_tax_id | string or null <= 20 characters The party state id |
person_name | string or null <= 30 characters Attention to (required for shipment purchase) |
company_name | string or null <= 30 characters The company name if the party is a company |
country_code | string Enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AN" "AO" "AR" "AS" "AT" "AU" "AW" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BM" "BN" "BO" "BR" "BS" "BT" "BW" "BY" "BZ" "CA" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GT" "GU" "GW" "GY" "HK" "HN" "HR" "HT" "HU" "IC" "ID" "IE" "IL" "IN" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KV" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PR" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SY" "SZ" "TC" "TD" "TG" "TH" "TJ" "TL" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WS" "XB" "XC" "XE" "XM" "XN" "XS" "XY" "YE" "YT" "ZA" "ZM" "ZW" The address country code
|
string or null The party email | |
phone_number | string or null <= 20 characters The party phone number. |
state_code | string or null <= 20 characters The address state code |
suburb | string or null <= 20 characters The address suburb if known |
residential | boolean or null Default: false Indicate if the address is residential or commercial (enterprise) |
street_number | string or null <= 20 characters The address street number |
address_line1 | string or null <= 50 characters The address line with street number |
address_line2 | string or null <= 50 characters The address line with suite number |
validate_location | boolean or null Default: false Indicate if the address should be validated |
Responses
Request samples
- Payload
{- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}
Response samples
- 200
- 400
- 404
- 409
- 500
{- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}
Discard an address
Discard an address.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 409
- 500
{- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}
This is an object representing your a Karrio shipping parcel. Parcel objects are linked to your shipment history, and can be used for recurring shipping using the same packaging.
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
]
}
Create a parcel
Create a new parcel.
Authorizations:
Request Body schema: application/json
weight required | number <double> The parcel's weight |
width | number or null <double> The parcel's width |
height | number or null <double> The parcel's height |
length | number or null <double> The parcel's length |
packaging_type | string or null <= 50 characters The parcel's packaging type. |
package_preset | string or null <= 50 characters The parcel's package preset. |
description | string or null <= 250 characters The parcel's description |
content | string or null <= 100 characters The parcel's content description |
is_document | boolean or null Default: false Indicates if the parcel is composed of documents only |
weight_unit required | string Enum: "KG" "LB" The parcel's weight unit
|
dimension_unit | string or null Enum: "CM" "IN" null The parcel's dimension unit
|
Array of objects (CommodityData) The parcel items. | |
reference_number | string or null <= 100 characters The parcel reference number. |
freight_class | string or null <= 6 characters The parcel's freight class for pallet and freight shipments. |
object Default: {} Parcel specific options.
|
Responses
Request samples
- Payload
{- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { }
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
Retrieve a parcel
Retrieve a parcel.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 500
{- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
Update a parcel
modify an existing parcel's details.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
weight | number <double> The parcel's weight |
width | number or null <double> The parcel's width |
height | number or null <double> The parcel's height |
length | number or null <double> The parcel's length |
packaging_type | string or null <= 50 characters The parcel's packaging type. |
package_preset | string or null <= 50 characters The parcel's package preset. |
description | string or null <= 250 characters The parcel's description |
content | string or null <= 100 characters The parcel's content description |
is_document | boolean or null Default: false Indicates if the parcel is composed of documents only |
weight_unit | string Enum: "KG" "LB" The parcel's weight unit
|
dimension_unit | string or null Enum: "CM" "IN" null The parcel's dimension unit
|
Array of objects (CommodityData) The parcel items. | |
reference_number | string or null <= 100 characters The parcel reference number. |
freight_class | string or null <= 6 characters The parcel's freight class for pallet and freight shipments. |
object Default: {} Parcel specific options.
|
Responses
Request samples
- Payload
{- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { }
}
Response samples
- 200
- 400
- 404
- 409
- 500
{- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
Remove a parcel
Remove a parcel.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 409
- 500
{- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
This is an object representing your a Karrio shipping customs declaration. You can retrieve all customs declarations used historically with your Karrio account shipments.
List all customs info
Retrieve all stored customs declarations.
Authorizations:
Responses
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}
]
}
Create a customs info
Create a new customs declaration.
Authorizations:
Request Body schema: application/json
required | Array of objects (CommodityData) The parcel content items |
object or null The payment details. | |
object or null The duty payor address. | |
content_type | string or null Enum: "documents" "gift" "sample" "merchandise" "return_merchandise" "other" "" null
|
content_description | string or null |
incoterm | string or null Enum: "CFR" "CIF" "CIP" "CPT" "DAF" "DDP" "DDU" "DEQ" "DES" "EXW" "FAS" "FCA" "FOB" null The customs 'term of trade' also known as 'incoterm'
|
invoice | string or null <= 50 characters The invoice reference number |
invoice_date | string or null The invoice date |
commercial_invoice | boolean or null Indicates if the shipment is commercial |
certify | boolean or null Indicate that signer certified confirmed all |
signer | string or null <= 50 characters |
object Default: {} Customs identification options.
|
Responses
Request samples
- Payload
{- "commodities": [
- {
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { }
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}
Retrieve a customs info
Retrieve customs declaration.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 500
{- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}
Update a customs info
modify an existing customs declaration.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
Array of objects (CommodityData) The parcel content items | |
object or null The payment details. | |
object or null The duty payor address. | |
content_type | string or null Enum: "documents" "gift" "sample" "merchandise" "return_merchandise" "other" "" null
|
content_description | string or null |
incoterm | string or null Enum: "CFR" "CIF" "CIP" "CPT" "DAF" "DDP" "DDU" "DEQ" "DES" "EXW" "FAS" "FCA" "FOB" null The customs 'term of trade' also known as 'incoterm'
|
invoice | string or null <= 50 characters The invoice reference number |
invoice_date | string or null The invoice date |
commercial_invoice | boolean or null Indicates if the shipment is commercial |
certify | boolean or null Indicate that signer certified confirmed all |
signer | string or null <= 50 characters |
object Default: {} Customs identification options.
|
Responses
Request samples
- Payload
{- "commodities": [
- {
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { }
}
Response samples
- 200
- 400
- 404
- 409
- 500
{- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}
Discard a customs info
Discard a customs declaration.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 409
- 500
{- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}
This is an object representing your a Karrio shipment. A Shipment guides you through process of preparing and purchasing a label for an order. A Shipment transitions through multiple statuses throughout its lifetime as the package shipped makes its journey to it's destination.
List all shipments
Retrieve all shipments.
Authorizations:
query Parameters
address | string |
carrier_name | string The unique carrier slug. |
created_after | string <date-time> |
created_before | string <date-time> |
keyword | string |
metadata_key | string |
metadata_value | string |
option_key | string |
option_value | string |
reference | string |
service | string |
status | string Valid shipment status. |
tracking_number | string |
Responses
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
]
}
Create a shipment
Create a new shipment instance.
Authorizations:
Request Body schema: application/json
required | object The address of the party. |
required | object The address of the party. |
required | Array of objects (ParcelData) The shipment's parcels |
object Default: {} The options available for the shipment.
| |
object Default: {"paid_by":"sender","currency":null,"account_number":null} The payment details | |
object or null The payor address. | |
object or null The customs details. | |
reference | string or null <= 35 characters The shipment reference |
label_type | string Default: "PDF" Enum: "PDF" "ZPL" "PNG" The shipment label file type.
|
service | string Specify a service to Buy a label in one call without rating. |
services | Array of strings or null Default: [] The requested carrier service for the shipment. |
carrier_ids | Array of strings or null Default: [] The list of configured carriers you wish to get rates from. |
object Default: {} User metadata for the shipment |
Responses
Request samples
- Payload
{- "shipper": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "recipient": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { }
}
], - "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "customs": {
- "commodities": [
- {
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { }
}, - "reference": "string",
- "label_type": "PDF",
- "service": "string",
- "services": [ ],
- "carrier_ids": [ ],
- "metadata": { }
}
Response samples
- 201
- 400
- 424
- 500
{- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
Retrieve a shipment
Retrieve a shipment.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 500
{- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
Update a shipment
This operation allows for updating properties of a shipment including label_type
, reference
, payment
, options
and metadata
.
It is not for editing the parcels of a shipment.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
label_type | string Default: "PDF" Enum: "PDF" "ZPL" "PNG" The shipment label file type.
|
object The payment details | |
object The options available for the shipment.
| |
reference | string or null The shipment reference |
object User metadata for the shipment |
Responses
Request samples
- Payload
{- "label_type": "PDF",
- "payment": {
- "paid_by": "sender",
- "currency": "EUR",
- "account_number": "string"
}, - "options": {
- "property1": null,
- "property2": null
}, - "reference": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
Response samples
- 200
- 400
- 404
- 409
- 424
- 500
{- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
Cancel a shipment
Void a shipment with the associated label.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 400
- 404
- 409
- 424
- 500
{- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
Buy a shipment label
Select your preferred rates to buy a shipment label.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
selected_rate_id required | string The shipment selected rate. |
label_type | string Default: "PDF" Enum: "PDF" "ZPL" "PNG" The shipment label file type.
|
object The payment details | |
reference | string or null The shipment reference |
object User metadata for the shipment |
Responses
Request samples
- Payload
{- "selected_rate_id": "string",
- "label_type": "PDF",
- "payment": {
- "paid_by": "sender",
- "currency": "EUR",
- "account_number": "string"
}, - "reference": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
Response samples
- 200
- 400
- 404
- 409
- 424
- 500
{- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
Fetch new shipment rates
Refresh the list of the shipment rates
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
services | Array of strings or null The requested carrier service for the shipment. |
carrier_ids | Array of strings or null The list of configured carriers you wish to get rates from. |
reference | string or null The shipment reference |
object User metadata for the shipment |
Responses
Request samples
- Payload
{- "services": [
- "string"
], - "carrier_ids": [
- "string"
], - "reference": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
Response samples
- 200
- 400
- 404
- 409
- 424
- 500
{- "id": "string",
- "object_type": "shipment",
- "shipper": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "recipient": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "parcels": [
- {
- "id": "string",
- "weight": 0,
- "width": 0,
- "height": 0,
- "length": 0,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { },
- "object_type": "parcel"
}
], - "services": [ ],
- "options": { },
- "payment": {
- "paid_by": "sender",
- "currency": null,
- "account_number": null
}, - "billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0,
- "value_currency": "EUR",
- "origin_country": "AD",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0,
- "account_number": "string"
}, - "duty_billing_address": {
- "id": "string",
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AD",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "suburb": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false,
- "object_type": "address",
- "validation": {
- "success": true,
- "meta": {
- "property1": null,
- "property2": null
}
}
}, - "content_type": "documents",
- "content_description": "string",
- "incoterm": "CFR",
- "invoice": "string",
- "invoice_date": "string",
- "commercial_invoice": true,
- "certify": true,
- "signer": "string",
- "options": { },
- "object_type": "customs_info"
}, - "rates": [ ],
- "reference": "string",
- "label_type": "PDF",
- "carrier_ids": [ ],
- "tracker_id": "string",
- "created_at": "string",
- "metadata": { },
- "messages": [ ],
- "status": "draft",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "shipment_identifier": "string",
- "selected_rate": {
- "id": "string",
- "object_type": "rate",
- "carrier_name": "string",
- "carrier_id": "string",
- "currency": "string",
- "service": "string",
- "total_charge": 0,
- "transit_days": 0,
- "extra_charges": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "test_mode": true
}, - "meta": {
- "property1": null,
- "property2": null
}, - "service": "string",
- "selected_rate_id": "string",
- "test_mode": true,
}
This is an object representing your a Karrio document upload record. A Document upload record keep traces of shipping trade documents uploaded to carriers to fast track customs processing.
List all upload records
Retrieve all shipping document upload records.
Authorizations:
query Parameters
created_after | string <date-time> |
created_before | string <date-time> |
shipment_id | string |
Responses
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "carrier_name": "string",
- "carrier_id": "string",
- "documents": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "reference": "string",
- "messages": [ ]
}
]
}
Upload documents
Upload a shipping document.
Authorizations:
Request Body schema: application/json
shipment_id required | string The documents related shipment. |
required | Array of objects (DocumentFileData) Shipping document files |
reference | string or null <= 50 characters Shipping document file reference |
Responses
Request samples
- Payload
{- "shipment_id": "string",
- "document_files": [
- {
- "doc_file": "string",
- "doc_name": "string",
- "doc_format": "string",
- "doc_type": "other"
}
], - "reference": "string"
}
Response samples
- 201
- 400
- 424
- 500
{- "id": "string",
- "carrier_name": "string",
- "carrier_id": "string",
- "documents": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "reference": "string",
- "messages": [ ]
}
Retrieve an upload record
Retrieve a shipping document upload record.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 500
{- "id": "string",
- "carrier_name": "string",
- "carrier_id": "string",
- "documents": [ ],
- "meta": {
- "property1": null,
- "property2": null
}, - "reference": "string",
- "messages": [ ]
}
This is an object representing your a Karrio shipment tracker. A shipment tracker is an object attached to a shipment by it's tracking number. The tracker provide the latest tracking status and events associated with a shipment
List all package trackers
Retrieve all shipment trackers.
Authorizations:
query Parameters
carrier_name | string The unique carrier slug. |
created_after | string <date-time> |
created_before | string <date-time> |
status | string Valid tracker status. |
tracking_number | string |
Responses
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "carrier_name": "string",
- "carrier_id": "string",
- "tracking_number": "string",
- "info": {
- "carrier_tracking_link": null,
- "customer_name": null,
- "expected_delivery": null,
- "note": null,
- "order_date": null,
- "order_id": null,
- "package_weight": null,
- "package_weight_unit": null,
- "shipment_package_count": null,
- "shipment_pickup_date": null,
- "shipment_delivery_date": null,
- "shipment_service": null,
- "shipment_origin_country": null,
- "shipment_origin_postal_code": null,
- "shipment_destination_country": null,
- "shipment_destination_postal_code": null,
- "shipping_date": null,
- "signed_by": null,
- "source": null
}, - "events": [
- {
- "date": "string",
- "description": "string",
- "location": "string",
- "code": "string",
- "time": "string",
- "latitude": 0,
- "longitude": 0
}
], - "delivered": true,
- "test_mode": true,
- "status": "pending",
- "estimated_delivery": "string",
- "meta": {
- "property1": null,
- "property2": null
}, - "object_type": "tracker",
- "metadata": { },
- "messages": [ ]
}
]
}