Connections
The management API offer two different queries to retrieve the list of carrier connections configured for your account.
User connections
The user connections are carrier accounts registered by the user, a team member or an organization administrator.
Query user connections
- Query
- Response
query getUserConnections {
user_connections {
__typename
... on AlliedExpressSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
username
password
account
service_type
}
... on AlliedExpressLocalSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
username
password
account
service_type
}
... on AmazonShippingSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
seller_id
developer_id
mws_auth_token
aws_region
config
}
... on AramexSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
username
password
account_pin
account_entity
account_number
account_country_code
config
}
... on AsendiaUSSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
username
password
account_number
api_key
config
}
... on AustraliaPostSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
api_key
password
account_number
config
}
... on BoxKnightSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
username
password
config
metadata
}
... on BelgianPostSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
account_id
passphrase
services {
id
active
service_name
service_code
carrier_service_code
description
currency
transit_days
transit_time
max_weight
max_width
max_height
max_length
weight_unit
dimension_unit
domicile
international
zones {
label
rate
min_weight
max_weight
transit_days
transit_time
radius
latitude
longitude
cities
postal_codes
country_codes
}
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on CanadaPostSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
username
password
customer_number
contract_id
config
}
... on CanparSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
config
}
... on ChronopostSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
password
account_number
account_country_code
config
}
... on ColissimoSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
password
contract_number
laposte_api_key
services {
id
active
service_name
service_code
carrier_service_code
description
currency
transit_days
transit_time
max_weight
max_width
max_height
max_length
weight_unit
dimension_unit
domicile
international
zones {
label
rate
min_weight
max_weight
transit_days
transit_time
radius
latitude
longitude
cities
postal_codes
country_codes
}
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on DHLParcelDESettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
customer_number
dhl_api_key
tracking_consumer_key
tracking_consumer_secret
config
services {
id
active
service_name
service_code
carrier_service_code
description
currency
transit_days
transit_time
max_weight
max_width
max_height
max_length
weight_unit
dimension_unit
domicile
international
zones {
label
rate
min_weight
max_weight
transit_days
transit_time
radius
latitude
longitude
cities
postal_codes
country_codes
}
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on DHLExpressSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
site_id
password
account_number
account_country_code
config
}
... on DHLPolandSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
username
password
account_number
services {
id
active
service_name
service_code
carrier_service_code
description
currency
transit_days
transit_time
max_weight
max_width
max_height
max_length
weight_unit
dimension_unit
domicile
international
zones {
label
rate
min_weight
max_weight
transit_days
transit_time
radius
latitude
longitude
cities
postal_codes
country_codes
}
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on DHLUniversalSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
consumer_key
consumer_secret
config
}
... on DicomSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
billing_account
config
}
... on DPDSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
config
capabilities
delis_id
password
depot
account_country_code
services {
active
currency
description
dimension_unit
domicile
id
international
max_height
max_length
max_weight
max_width
service_code
service_name
carrier_service_code
transit_days
transit_time
weight_unit
zones {
cities
postal_codes
country_codes
label
latitude
longitude
max_weight
min_weight
radius
rate
transit_days
transit_time
}
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on DPDHLSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
app_id
app_token
zt_id
zt_password
account_number
config
services {
id
active
service_name
service_code
carrier_service_code
description
currency
transit_days
transit_time
max_weight
max_width
max_height
max_length
weight_unit
dimension_unit
domicile
international
zones {
label
rate
min_weight
max_weight
transit_days
transit_time
radius
latitude
longitude
cities
postal_codes
country_codes
}
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on EShipperSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
config
}
... on EasyPostSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
api_key
config
}
... on FedexSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
account_number
api_key
secret_key
track_api_key
track_secret_key
account_country_code
config
}
... on FedexWSSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
account_number
password
meter_number
user_key
account_country_code
config
}
... on FreightcomSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
config
}
... on GenericSettingsType {
id
carrier_id
carrier_name
display_name
custom_carrier_name
account_number
test_mode
active
metadata
config
capabilities
account_country_code
services {
id
active
service_name
service_code
carrier_service_code
description
currency
transit_days
transit_time
max_weight
max_width
max_height
max_length
weight_unit
dimension_unit
domicile
international
zones {
label
rate
min_weight
max_weight
transit_days
transit_time
radius
latitude
longitude
cities
postal_codes
country_codes
}
}
label_template {
id
slug
template
template_type
shipment_sample
width
height
}
rate_sheet {
id
name
slug
carrier_name
metadata
}
}
... on GEODISSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
api_key
identifier
language
config
}
... on LaPosteSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
api_key
lang
config
}
... on Locate2uSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
account_country_code
client_id
client_secret
}
... on NationexSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
api_key
customer_id
billing_account
language
config
}
... on PurolatorSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
account_number
user_token
config
}
... on RoadieSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
api_key
config
}
... on RoyalMailSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
client_id
client_secret
config
}
... on SendleSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
sendle_id
api_key
account_country_code
config
}
... on TNTSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
account_number
account_country_code
config
}
... on UPSSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
client_id
client_secret
account_number
account_country_code
config
}
... on USPSSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
mailer_id
customer_registration_id
logistics_manager_mailer_id
config
}
... on USPSInternationalSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
metadata
capabilities
username
password
mailer_id
customer_registration_id
logistics_manager_mailer_id
config
}
... on Zoom2uSettingsType {
id
carrier_id
carrier_name
display_name
test_mode
active
capabilities
metadata
config
account_country_code
api_key
}
}
}
{
"data": {
"user_connections": [
{
"id": "car_d4353d4374cc4cd499c5f232243a59f4",
"carrier_id": "sendle-test",
"carrier_name": "sendle",
"display_name": "Sendle",
"test_mode": true,
"active": false,
"metadata": {},
"capabilities": [
"tracking",
"shipping",
"rating"
],
"sendle_id": "sendle_id",
"api_key": "api_key",
"account_country_code": "AU",
"config": null
},
{
"id": "car_4f62ec17088a45ad9d0ac8c3956959dc",
"carrier_id": "express-freight",
"carrier_name": "generic",
"display_name": "Express Freight",
"custom_carrier_name": "express_freight",
"account_number": "12345",
"test_mode": true,
"active": false,
"metadata": {},
"config": {
"text_color": "#f7f7f7",
"brand_color": "#d71414"
},
"capabilities": [
"rating",
"shipping"
],
"account_country_code": null,
"services": [
{
"id": "svc_803c193d5a24494e9590bfab3b7a012c",
"active": true,
"service_name": "Bpost Standard Service",
"service_code": "bpost_standard_service",
"carrier_service_code": null,
"description": null,
"currency": "EUR",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": true,
"international": true,
"zones": [
{
"label": "Zone 1",
"rate": 10,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
}
],
"label_template": null,
"rate_sheet": null
},
{
"id": "car_474c3b80810749f8a7d7634ded74f05f",
"carrier_id": "easypost",
"carrier_name": "easypost",
"display_name": "EasyPost",
"test_mode": true,
"active": false,
"metadata": {},
"capabilities": [
"rating",
"shipping",
"tracking"
],
"api_key": "EZ_____xxxx",
"config": null
},
{
"id": "car_9dac728533e841b09ec453178de5b3c3",
"carrier_id": "tst-overland",
"carrier_name": "generic",
"display_name": "TST Overland",
"custom_carrier_name": "tst_overland",
"account_number": "",
"test_mode": true,
"active": true,
"metadata": {
"APP_ID": "00",
"SERIAL": "00099999000"
},
"config": {
"text_color": "#ededed",
"brand_color": "#079745"
},
"capabilities": [
"rating",
"shipping"
],
"account_country_code": "CA",
"services": [
{
"id": "svc_8883fb2e28784658888c68301e0648dd",
"active": true,
"service_name": "Standard Service",
"service_code": "standard_service",
"carrier_service_code": null,
"description": null,
"currency": "CAD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": null,
"international": null,
"zones": [
{
"label": null,
"rate": 10,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
}
],
"label_template": null,
"rate_sheet": null
},
{
"id": "car_de5bfd5f544543c7b15624d808a7bf72",
"carrier_id": "dhl-poland",
"carrier_name": "dhl_poland",
"display_name": "DHL Parcel Poland",
"test_mode": true,
"active": false,
"capabilities": [
"rating",
"shipping",
"tracking"
],
"metadata": {},
"config": null,
"username": "username",
"password": "password",
"account_number": "6000000",
"services": [
{
"id": "svc_040541e15adb40e7a069189fa9cd3047",
"active": true,
"service_name": "DHL Poland International",
"service_code": "dhl_poland_international",
"carrier_service_code": null,
"description": "",
"currency": "USD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": null,
"international": true,
"zones": [
{
"label": null,
"rate": 12,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
},
{
"id": "svc_65195e7b4b8e4759b80898e615eb6f94",
"active": true,
"service_name": "DHL Poland Connect",
"service_code": "dhl_poland_connect",
"carrier_service_code": null,
"description": "",
"currency": "USD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": null,
"international": true,
"zones": [
{
"label": null,
"rate": 11,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
},
{
"id": "svc_8ab16a430b1d4a8bb7c353c5febedda6",
"active": true,
"service_name": "DHL Poland 12",
"service_code": "dhl_poland_12",
"carrier_service_code": null,
"description": "",
"currency": "USD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": true,
"international": null,
"zones": [
{
"label": null,
"rate": 15,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
},
{
"id": "svc_a94af75ad5574a0a905fd4ab0dc67c70",
"active": true,
"service_name": "DHL Poland 09",
"service_code": "dhl_poland_09",
"carrier_service_code": null,
"description": "",
"currency": "USD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": true,
"international": null,
"zones": [
{
"label": null,
"rate": 10,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
},
{
"id": "svc_ee7cf93b8c94479a9045ee366c19ff8b",
"active": true,
"service_name": "DHL Poland Polska",
"service_code": "dhl_poland_polska",
"carrier_service_code": null,
"description": "",
"currency": "USD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": true,
"international": null,
"zones": [
{
"label": null,
"rate": 5.5,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
},
{
"id": "svc_1fab4c8d52d3479b893b2712a17059b3",
"active": true,
"service_name": "DHL Poland Premium",
"service_code": "dhl_poland_premium",
"carrier_service_code": null,
"description": "",
"currency": "USD",
"transit_days": null,
"transit_time": null,
"max_weight": null,
"max_width": null,
"max_height": null,
"max_length": null,
"weight_unit": null,
"dimension_unit": null,
"domicile": true,
"international": null,
"zones": [
{
"label": null,
"rate": 25,
"min_weight": null,
"max_weight": null,
"transit_days": null,
"transit_time": null,
"radius": null,
"latitude": null,
"longitude": null,
"cities": null,
"postal_codes": null,
"country_codes": null
}
]
}
],
"rate_sheet": null
},
{
"id": "car_d52c07f498cc4c4fb82d312c026b7d14",
"carrier_id": "DHL-JM",
"carrier_name": "dhl_express",
"display_name": "DHL Express",
"test_mode": true,
"active": false,
"metadata": {},
"capabilities": [
"pickup",
"rating",
"shipping",
"tracking"
],
"site_id": "site_id",
"password": "password",
"account_number": "account_number",
"account_country_code": "JM",
"config": null
}
]
}
}
Create user connection
- Mutation
- Variables
- Response
mutation createConnection($data: CreateCarrierConnectionMutationInput!) {
create_carrier_connection(input: $data) {
errors {
field
messages
}
}
}
{
"data": {
"sendle": {
"carrier_id": "sendle-test",
"sendle_id": "test",
"api_key": "api-key",
"account_country_code": "US"
}
}
}
{
"data": {
"create_carrier_connection": {
"errors": null
}
}
}
Update user connection
- Mutation
- Variables
- Response
mutation update_connection($data: UpdateCarrierConnectionMutationInput!) {
update_carrier_connection(input: $data) {
errors {
field
messages
}
}
}
{
"data": {
"sendle": {
"id": "car_6ff24a802f8b4f93bfefb994a40ae87e",
"carrier_id": "sendle-test",
"active": true,
"metadata": {},
"sendle_id": "test",
"api_key": "api-key-update",
"account_country_code": "US",
"config": null
}
}
}
{
"data": {
"update_carrier_connection": {
"errors": null
}
}
}
Delete user connection
- Mutation
- Variables
- Response
mutation delete_connection($data: DeleteMutationInput!) {
delete_carrier_connection(input: $data) {
id
}
}
{
"data": {
"id": "car_6ff24a802f8b4f93bfefb994a40ae87e"
}
}
{
"data": {
"delete_carrier_connection": {
"id": "car_6ff24a802f8b4f93bfefb994a40ae87e"
}
}
}
System connections
The system connections are carrier accounts registered by the system super administrator and made publicly available to all users and organizations. organization admin can enable or disable the system connections for their account.
info
Note that the system connections are read-only and the credetials are hidden for security reasons. Only super admin can edit the system connections account details and related carrier API credentials.
Query system connections
- Query
- Response
query getSystemConnections {
system_connections {
id
carrier_id
test_mode
active
capabilities
carrier_name
display_name
enabled
config
}
}
{
"data": {
"system_connections": [
{
"id": "car_773f4a5577e4471e8918a9a1d47b208b",
"carrier_id": "canadapost",
"test_mode": true,
"active": true,
"capabilities": [
"rating",
"pickup",
"shipping",
"tracking"
],
"carrier_name": "canadapost",
"display_name": "Canada Post",
"enabled": true,
"config": null
}
]
}
}
Enable/Disable connection
note
By enabling a system connection, you are opting to use the carrier account provided by the system super administrator. Therefore, you will be provided with a billing agreement for your usage.
- Mutation
- Variables
- Response
mutation mutate_system_connection($data: SystemCarrierMutationInput!) {
mutate_system_connection(input: $data) {
carrier {
id
active
}
}
}
{
"data": {
"id": "car_773f4a5577e4471e8918a9a1d47b208b",
"enable": false
}
}
{
"data": {
"mutate_system_connection": {
"carrier": {
"id": "car_773f4a5577e4471e8918a9a1d47b208b",
"active": true
}
}
}
}