Karrio API (2024.9.7)
Download OpenAPI specification:Download
Karrio is a multi-carrier shipping API that simplifies the integration of logistics 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 2024.9.7
.
Read our API changelog 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": "",
- "APP_WEBSITE": "",
- "HOST": "",
- "ADMIN": "",
- "OPENAPI": "",
- "GRAPHQL": "",
- "AUDIT_LOGGING": true,
- "ALLOW_SIGNUP": true,
- "ALLOW_ADMIN_APPROVED_SIGNUP": true,
- "ALLOW_MULTI_ACCOUNT": true,
- "ADMIN_DASHBOARD": 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,
- "WORKFLOW_MANAGEMENT": true
}
Response samples
- 200
{- "VERSION": "",
- "APP_NAME": "",
- "APP_WEBSITE": "",
- "HOST": "",
- "ADMIN": "",
- "OPENAPI": "",
- "GRAPHQL": "",
- "AUDIT_LOGGING": true,
- "ALLOW_SIGNUP": true,
- "ALLOW_ADMIN_APPROVED_SIGNUP": true,
- "ALLOW_MULTI_ACCOUNT": true,
- "ADMIN_DASHBOARD": 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,
- "WORKFLOW_MANAGEMENT": 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": { }
}
Obtain auth token pair
Authenticate the user and return a token pair
Request Body schema: application/jsonrequired
email required | string |
password required | string |
Responses
Request samples
- Payload
{- "email": "string",
- "password": "string"
}
Response samples
- 201
{- "access": "string",
- "refresh": "string"
}
Refresh auth token
Authenticate the user and return a token pair
Request Body schema: application/jsonrequired
refresh required | string |
Responses
Request samples
- Payload
{- "refresh": "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/jsonrequired
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"
}
This is an object representing your Karrio carrier extension. You can retrieve all supported carrier extensions available.
Response samples
- 200
- 500
[- {
- "carrier_name": "dhl_express",
- "display_name": "DHL Express",
- "connection_fields": {
- "site_id": {
- "name": "site_id",
- "required": true,
- "type": "string"
}, - "password": {
- "name": "password",
- "required": true,
- "type": "string"
}, - "account_number": {
- "name": "account_number",
- "required": false,
- "type": "string"
}
}, - "capabilities": [
- "paperless",
- "shipping",
- "tracking",
- "rating",
- "pickup"
], - "config_fields": {
- "label_type": {
- "code": "label_type",
- "name": "label_type",
- "required": false,
- "type": "string"
}, - "skip_service_filter": {
- "code": "skip_service_filter",
- "name": "skip_service_filter",
- "required": false,
- "type": "string"
}, - "shipping_options": {
- "code": "shipping_options",
- "name": "shipping_options",
- "required": false,
- "type": "list"
}, - "shipping_services": {
- "code": "shipping_services",
- "name": "shipping_services",
- "required": false,
- "type": "list"
}
}
}
]
Get carrier services
Retrieve a carrier's services
path Parameters
carrier_name required | string The unique carrier slug. |
Responses
Response samples
- 200
- 404
- 500
{- "canadapost_regular_parcel": "DOM.RP",
- "canadapost_expedited_parcel": "DOM.EP",
- "canadapost_xpresspost": "DOM.XP",
- "canadapost_xpresspost_certified": "DOM.XP.CERT",
- "canadapost_priority": "DOM.PC",
- "canadapost_library_books": "DOM.LIB",
- "canadapost_expedited_parcel_usa": "USA.EP",
- "canadapost_priority_worldwide_envelope_usa": "USA.PW.ENV",
- "canadapost_priority_worldwide_pak_usa": "USA.PW.PAK",
- "canadapost_priority_worldwide_parcel_usa": "USA.PW.PARCEL",
- "canadapost_small_packet_usa_air": "USA.SP.AIR",
- "canadapost_tracked_packet_usa": "USA.TP",
- "canadapost_tracked_packet_usa_lvm": "USA.TP.LVM",
- "canadapost_xpresspost_usa": "USA.XP",
- "canadapost_xpresspost_international": "INT.XP",
- "canadapost_international_parcel_air": "INT.IP.AIR",
- "canadapost_international_parcel_surface": "INT.IP.SURF",
- "canadapost_priority_worldwide_envelope_intl": "INT.PW.ENV",
- "canadapost_priority_worldwide_pak_intl": "INT.PW.PAK",
- "canadapost_priority_worldwide_parcel_intl": "INT.PW.PARCEL",
- "canadapost_small_packet_international_air": "INT.SP.AIR",
- "canadapost_small_packet_international_surface": "INT.SP.SURF",
- "canadapost_tracked_packet_international": "INT.TP"
}
This is an object representing your Karrio carrier connections.
You can retrieve all carrier connections available to your account.
The carrier_id
is a friendly name you assign to your connection.
List carrier connections
Retrieve all carrier connections
Authorizations:
query Parameters
active | boolean |
carrier_name | string The unique carrier slug. |
metadata_key | string |
metadata_value | string |
system_only | boolean |
Responses
Response samples
- 200
- 400
{- "count": 0,
- "results": [
- {
- "id": "string",
- "object_type": "carrier-connection",
- "carrier_name": "allied_express",
- "display_name": "string",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "is_system": true,
- "active": true,
- "test_mode": true
}
]
}
Add a carrier connection
Add a new carrier connection.
Authorizations:
Request Body schema: application/jsonrequired
carrier_name required | string Enum: "allied_express" "allied_express_local" "amazon_shipping" "aramex" "asendia_us" "australiapost" "boxknight" "bpost" "canadapost" "canpar" "chronopost" "colissimo" "dhl_express" "dhl_parcel_de" "dhl_poland" "dhl_universal" "dicom" "dpd" "dpdhl" "easypost" "easyship" "eshipper" "fedex" "fedex_ws" "freightcom" "generic" "geodis" "hay_post" "laposte" "locate2u" "nationex" "purolator" "roadie" "royalmail" "sapient" "seko" "sendle" "tge" "tnt" "ups" "usps" "usps_international" "usps_wt" "usps_wt_international" "zoom2u" A carrier connection type. |
carrier_id required | string A carrier connection friendly name. |
required | zoom2u (object) or usps_wt_international (object) or usps_wt (object) or usps_international (object) or usps (object) or ups (object) or tnt (object) or tge (object) or sendle (object) or seko (object) or sapient (object) or royalmail (object) or roadie (object) or purolator (object) or nationex (object) or locate2u (object) or laposte (object) or hay_post (object) or geodis (object) or generic (object) or freightcom (object) or fedex_ws (object) or fedex (object) or eshipper (object) or easyship (object) or easypost (object) or dpdhl (object) or dpd (object) or dicom (object) or dhl_universal (object) or dhl_poland (object) or dhl_parcel_de (object) or dhl_express (object) or colissimo (object) or chronopost (object) or canpar (object) or canadapost (object) or bpost (object) or boxknight (object) or australiapost (object) or asendia_us (object) or aramex (object) or amazon_shipping (object) or allied_express_local (object) or allied_express (object) Carrier connection credentials. |
capabilities | Array of strings or null The carrier enabled capabilities. |
object Default: {} Carrier connection custom config. | |
object Default: {} User metadata for the carrier. | |
active | boolean Default: true The active flag indicates whether the carrier account is active or not. |
Responses
Request samples
- Payload
{- "carrier_name": "allied_express",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "active": true
}
Response samples
- 201
- 400
- 424
- 500
{- "id": "string",
- "object_type": "carrier-connection",
- "carrier_name": "allied_express",
- "display_name": "string",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "is_system": true,
- "active": true,
- "test_mode": true
}
Retrieve a connection
Retrieve carrier connection.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 400
- 500
{- "id": "string",
- "object_type": "carrier-connection",
- "carrier_name": "allied_express",
- "display_name": "string",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "is_system": true,
- "active": true,
- "test_mode": true
}
Update a connection
Update a carrier connection.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
carrier_name | string Enum: "allied_express" "allied_express_local" "amazon_shipping" "aramex" "asendia_us" "australiapost" "boxknight" "bpost" "canadapost" "canpar" "chronopost" "colissimo" "dhl_express" "dhl_parcel_de" "dhl_poland" "dhl_universal" "dicom" "dpd" "dpdhl" "easypost" "easyship" "eshipper" "fedex" "fedex_ws" "freightcom" "generic" "geodis" "hay_post" "laposte" "locate2u" "nationex" "purolator" "roadie" "royalmail" "sapient" "seko" "sendle" "tge" "tnt" "ups" "usps" "usps_international" "usps_wt" "usps_wt_international" "zoom2u" A carrier connection type. |
carrier_id | string A carrier connection friendly name. |
zoom2u (object) or usps_wt_international (object) or usps_wt (object) or usps_international (object) or usps (object) or ups (object) or tnt (object) or tge (object) or sendle (object) or seko (object) or sapient (object) or royalmail (object) or roadie (object) or purolator (object) or nationex (object) or locate2u (object) or laposte (object) or hay_post (object) or geodis (object) or generic (object) or freightcom (object) or fedex_ws (object) or fedex (object) or eshipper (object) or easyship (object) or easypost (object) or dpdhl (object) or dpd (object) or dicom (object) or dhl_universal (object) or dhl_poland (object) or dhl_parcel_de (object) or dhl_express (object) or colissimo (object) or chronopost (object) or canpar (object) or canadapost (object) or bpost (object) or boxknight (object) or australiapost (object) or asendia_us (object) or aramex (object) or amazon_shipping (object) or allied_express_local (object) or allied_express (object) Carrier connection credentials. | |
capabilities | Array of strings or null The carrier enabled capabilities. |
object Default: {} Carrier connection custom config. | |
object Default: {} User metadata for the carrier. | |
active | boolean Default: true The active flag indicates whether the carrier account is active or not. |
Responses
Request samples
- Payload
{- "carrier_name": "allied_express",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "active": true
}
Response samples
- 200
- 400
- 404
- 500
{- "id": "string",
- "object_type": "carrier-connection",
- "carrier_name": "allied_express",
- "display_name": "string",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "is_system": true,
- "active": true,
- "test_mode": true
}
Remove a carrier connection
Remove a carrier connection.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 404
- 409
- 500
{- "id": "string",
- "object_type": "carrier-connection",
- "carrier_name": "allied_express",
- "display_name": "string",
- "carrier_id": "string",
- "credentials": {
- "api_key": "string"
}, - "capabilities": [
- "string"
], - "config": { },
- "metadata": { },
- "is_system": true,
- "active": true,
- "test_mode": true
}
This is an object representing your 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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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/jsonrequired
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 <= 50 characters Attention to (required for shipment purchase) |
company_name | string or null <= 50 characters The company name if the party is a company |
country_code required | string Enum: "AC" "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" "EH" "IM" "BL" "MF" "SX" 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 |
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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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 <= 50 characters Attention to (required for shipment purchase) |
company_name | string or null <= 50 characters The company name if the party is a company |
country_code | string Enum: "AC" "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" "EH" "IM" "BL" "MF" "SX" 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 |
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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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 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.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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/jsonrequired
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" "OZ" "G" 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.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "reference_number": "string",
- "freight_class": "string",
- "options": { }
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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" "OZ" "G" 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.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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 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> |
has_manifest | boolean |
has_tracker | boolean |
id | string |
keyword | string |
meta_key | string |
meta_value | 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
{- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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/jsonrequired
required | object The address of the party. |
required | object The address of the party. |
object or null The return address for this shipment. Defaults to the shipper address. | |
object or null The payor address. | |
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 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
{- "recipient": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "shipper": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "commodities": [
- {
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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 Default: {} 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": { },
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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/jsonrequired
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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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. |
object Default: {} The options available for the shipment.
| |
reference | string or null The shipment reference |
object User metadata for the shipment |
Responses
Request samples
- Payload
{- "services": [
- "string"
], - "carrier_ids": [
- "string"
], - "options": { },
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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
}
}
}, - "return_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "billing_address": {
- "postal_code": "string",
- "city": "string",
- "federal_tax_id": "string",
- "state_tax_id": "string",
- "person_name": "string",
- "company_name": "string",
- "country_code": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "string",
- "residential": false,
- "street_number": "string",
- "address_line1": "string",
- "address_line2": "string",
- "validate_location": false
}, - "parcels": [
- {
- "id": "string",
- "weight": 0.1,
- "width": 0.1,
- "height": 0.1,
- "length": 0.1,
- "packaging_type": "string",
- "package_preset": "string",
- "description": "string",
- "content": "string",
- "is_document": false,
- "weight_unit": "KG",
- "dimension_unit": "CM",
- "items": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "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
}, - "customs": {
- "id": "string",
- "commodities": [
- {
- "id": "string",
- "weight": 0.1,
- "weight_unit": "KG",
- "title": "string",
- "description": "string",
- "quantity": 1,
- "sku": "string",
- "hs_code": "string",
- "value_amount": 0.1,
- "value_currency": "EUR",
- "origin_country": "AC",
- "parent_id": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "object_type": "commodity"
}
], - "duty": {
- "paid_by": "sender",
- "currency": "EUR",
- "declared_value": 0.1,
- "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": "AC",
- "email": "string",
- "phone_number": "string",
- "state_code": "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": [ ],
- "estimated_delivery": "string",
- "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 Karrio document upload record. A Document upload record keep traces of shipping trade documents uploaded to carriers to fast track customs and border processing.
Generate a document
Generate any document. This API is designed to be used to generate GS1 labels, invoices and any document that requires external data.
Authorizations:
Request Body schema: application/json
template_id | string The template name. Required if template is not provided. |
template | string The template content. Required if template_id is not provided. |
doc_format | string The format of the document |
doc_name | string The file name |
object Default: {} The template data |
Responses
Request samples
- Payload
{- "template_id": "string",
- "template": "string",
- "doc_format": "string",
- "doc_name": "string",
- "data": { }
}
Response samples
- 201
- 400
- 404
- 500
{- "template_id": "string",
- "doc_format": "string",
- "doc_name": "string",
- "doc_file": "string"
}
Response samples
- 200
- 404
- 500
{- "count": 0,
- "results": [
- {
- "id": "string",
- "name": "string",
- "slug": "string",
- "template": "string",
- "active": true,
- "description": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "related_object": "shipment",
- "object_type": "document-template"
}
]
}
Create a template
Create a new template.
Authorizations:
Request Body schema: application/jsonrequired
name required | string <= 255 characters The template name |
slug required | string <= 255 characters The template slug |
template required | string The template content |
active | boolean Default: true disable template flag. |
description | string <= 255 characters The template description |
object The template metadata | |
related_object | string Default: "other" Enum: "shipment" "order" "other" The template related object |
Responses
Request samples
- Payload
{- "name": "string",
- "slug": "string",
- "template": "string",
- "active": true,
- "description": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "related_object": "shipment"
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "name": "string",
- "slug": "string",
- "template": "string",
- "active": true,
- "description": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "related_object": "shipment",
- "object_type": "document-template"
}
Retrieve a template
Retrieve a template.
Authorizations:
path Parameters
id required | string |
Responses
Response samples
- 200
- 400
- 500
{- "id": "string",
- "name": "string",
- "slug": "string",
- "template": "string",
- "active": true,
- "description": "string",
- "metadata": {
- "property1": null,
- "property2": null
}, - "related_object": "shipment",
- "object_type": "document-template"
}
Update a template
update a template.
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
name | string <= 255 characters The template name |
slug | string <= 255 characters The template slug |
template | string The template content |
active | boolean Default: true disable template flag. |
description | string <= 255 characters |