Add a carrier connection

POST 
/v1/connections

Add a new carrier connection.

Request

application/json

Body

required

carrier_name stringrequired

Possible values: [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 stringrequired

A carrier connection friendly name.

credentials

object

required

oneOf

zoom2u

api_key stringrequired

usps_wt_international

username stringrequired

password stringrequired

mailer_id string

customer_registration_id string

logistics_manager_mailer_id string

usps_wt

username stringrequired

password stringrequired

mailer_id string

customer_registration_id string

logistics_manager_mailer_id string

usps_international

client_id stringrequired

client_secret stringrequired

account_type string

account_number string

usps

client_id stringrequired

client_secret stringrequired

account_type string

account_number string

ups

client_id stringrequired

client_secret stringrequired

account_number string

account_country_code string

tnt

username stringrequired

password stringrequired

account_number string

account_country_code string

tge

username stringrequired

password stringrequired

api_key stringrequired

toll_username stringrequired

toll_password stringrequired

my_toll_token stringrequired

my_toll_identity stringrequired

account_code string

sscc_count integer

shipment_count integer

sendle

sendle_id stringrequired

api_key stringrequired

account_country_code string

seko

access_key stringrequired

sapient

client_id stringrequired

client_secret stringrequired

shipping_account_id stringrequired

sapient_carrier_code string

Possible values: [DX, EVRI, RM, UPS, YODEL]

Indicates a sapient_carrier_code string

royalmail

client_id stringrequired

client_secret stringrequired

roadie

api_key stringrequired

purolator

username stringrequired

password stringrequired

account_number stringrequired

user_token string

language string

Possible values: [en, fr]

Indicates a language string

nationex

api_key stringrequired

customer_id stringrequired

billing_account string

language string

Possible values: [en, fr]

Indicates a language string

locate2u

client_id string

client_secret string

laposte

api_key stringrequired

lang string

Possible values: [fr_FR, en_US]

Indicates a lang string

hay_post

username stringrequired

password stringrequired

customer_id stringrequired

customer_type stringrequired

geodis

api_key stringrequired

identifier stringrequired

code_client string

language string

Possible values: [fr, en]

Indicates a language string

generic

display_name stringrequired

custom_carrier_name stringrequired

account_country_code string

account_number string

freightcom

username stringrequired

password stringrequired

fedex_ws

password stringrequired

meter_number stringrequired

account_number stringrequired

user_key string

language_code string

Default value: en

account_country_code string

fedex

api_key string

secret_key string

account_number string

track_api_key string

track_secret_key string

account_country_code string

eshipper

principal stringrequired

credential stringrequired

easyship

access_token stringrequired

easypost

api_key stringrequired

dpdhl

username stringrequired

password stringrequired

app_id string

app_token string

zt_id string

zt_password string

account_number string

dpd

delis_id stringrequired

password stringrequired

depot string

message_language string

Default value: en_EN

account_country_code string

Default value: BE

dicom

username stringrequired

password stringrequired

billing_account string

dhl_universal

consumer_key stringrequired

consumer_secret stringrequired

language string

Possible values: [en, de]

Indicates a language string

dhl_poland

username stringrequired

password stringrequired

account_number string

dhl_parcel_de

username stringrequired

password stringrequired

dhl_api_key stringrequired

customer_number string

tracking_consumer_key string

tracking_consumer_secret string

dhl_express

site_id stringrequired

password stringrequired

account_number string

account_country_code string

colissimo

password stringrequired

contract_number stringrequired

laposte_api_key string

chronopost

account_number stringrequired

password stringrequired

id_emit string

Default value: CHRFR

language string

Possible values: [en_GB, fr_FR]

Indicates a language string

canpar

username stringrequired

password stringrequired

language string

Possible values: [en, fr]

Indicates a language string

canadapost

username stringrequired

password stringrequired

customer_number string

contract_id string

language string

Possible values: [en, fr]

Indicates a language string

bpost

account_id stringrequired

passphrase stringrequired

boxknight

username stringrequired

password stringrequired

australiapost

api_key stringrequired

password stringrequired

account_number stringrequired

asendia_us

username stringrequired

password stringrequired

api_key stringrequired

account_number string

aramex

username stringrequired

password stringrequired

account_pin stringrequired

account_entity stringrequired

account_number stringrequired

account_country_code stringrequired

amazon_shipping

seller_id stringrequired

developer_id stringrequired

mws_auth_token stringrequired

aws_region string

Default value: us-east-1

account_country_code string

allied_express_local

username stringrequired

password stringrequired

account string

service_type string

Possible values: [R, P, PT, PT2]

Indicates a service_type string

allied_express

username stringrequired

password stringrequired

account string

service_type string

Possible values: [R, P, PT, PT2]

Indicates a service_type string

capabilities string[]nullable

The carrier enabled capabilities.

config

object

Carrier connection custom config.

property name* any

Default value: [object Object]

Carrier connection custom config.

metadata

object

User metadata for the carrier.

property name* any

Default value: [object Object]

User metadata for the carrier.

active boolean

Default value: true

The active flag indicates whether the carrier account is active or not.

Responses

201

application/json

Schema

Schema

id stringrequired

A unique carrier connection identifier

object_type string

Default value: carrier-connection

Specifies the object type

carrier_name stringrequired

Possible values: [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.

display_name string

The carrier connection type verbose name.

carrier_id stringrequired

A carrier connection friendly name.

credentials

object

oneOf

zoom2u

api_key stringrequired

usps_wt_international

username stringrequired

password stringrequired

mailer_id string

customer_registration_id string

logistics_manager_mailer_id string

usps_wt

username stringrequired

password stringrequired

mailer_id string

customer_registration_id string

logistics_manager_mailer_id string

usps_international

client_id stringrequired

client_secret stringrequired

account_type string

account_number string

usps

client_id stringrequired

client_secret stringrequired

account_type string

account_number string

ups

client_id stringrequired

client_secret stringrequired

account_number string

account_country_code string

tnt

username stringrequired

password stringrequired

account_number string

account_country_code string

tge

username stringrequired

password stringrequired

api_key stringrequired

toll_username stringrequired

toll_password stringrequired

my_toll_token stringrequired

my_toll_identity stringrequired

account_code string

sscc_count integer

shipment_count integer

sendle

sendle_id stringrequired

api_key stringrequired

account_country_code string

seko

access_key stringrequired

sapient

client_id stringrequired

client_secret stringrequired

shipping_account_id stringrequired

sapient_carrier_code string

Possible values: [DX, EVRI, RM, UPS, YODEL]

Indicates a sapient_carrier_code string

royalmail

client_id stringrequired

client_secret stringrequired

roadie

api_key stringrequired

purolator

username stringrequired

password stringrequired

account_number stringrequired

user_token string

language string

Possible values: [en, fr]

Indicates a language string

nationex

api_key stringrequired

customer_id stringrequired

billing_account string

language string

Possible values: [en, fr]

Indicates a language string

locate2u

client_id string

client_secret string

laposte

api_key stringrequired

lang string

Possible values: [fr_FR, en_US]

Indicates a lang string

hay_post

username stringrequired

password stringrequired

customer_id stringrequired

customer_type stringrequired

geodis

api_key stringrequired

identifier stringrequired

code_client string

language string

Possible values: [fr, en]

Indicates a language string

generic

display_name stringrequired

custom_carrier_name stringrequired

account_country_code string

account_number string

freightcom

username stringrequired

password stringrequired

fedex_ws

password stringrequired

meter_number stringrequired

account_number stringrequired

user_key string

language_code string

Default value: en

account_country_code string

fedex

api_key string

secret_key string

account_number string

track_api_key string

track_secret_key string

account_country_code string

eshipper

principal stringrequired

credential stringrequired

easyship

access_token stringrequired

easypost

api_key stringrequired

dpdhl

username stringrequired

password stringrequired

app_id string

app_token string

zt_id string

zt_password string

account_number string

dpd

delis_id stringrequired

password stringrequired

depot string

message_language string

Default value: en_EN

account_country_code string

Default value: BE

dicom

username stringrequired

password stringrequired

billing_account string

dhl_universal

consumer_key stringrequired

consumer_secret stringrequired

language string

Possible values: [en, de]

Indicates a language string

dhl_poland

username stringrequired

password stringrequired

account_number string

dhl_parcel_de

username stringrequired

password stringrequired

dhl_api_key stringrequired

customer_number string

tracking_consumer_key string

tracking_consumer_secret string

dhl_express

site_id stringrequired

password stringrequired

account_number string

account_country_code string

colissimo

password stringrequired

contract_number stringrequired

laposte_api_key string

chronopost

account_number stringrequired

password stringrequired

id_emit string

Default value: CHRFR

language string

Possible values: [en_GB, fr_FR]

Indicates a language string

canpar

username stringrequired

password stringrequired

language string

Possible values: [en, fr]

Indicates a language string

canadapost

username stringrequired

password stringrequired

customer_number string

contract_id string

language string

Possible values: [en, fr]

Indicates a language string

bpost

account_id stringrequired

passphrase stringrequired

boxknight

username stringrequired

password stringrequired

australiapost

api_key stringrequired

password stringrequired

account_number stringrequired

asendia_us

username stringrequired

password stringrequired

api_key stringrequired

account_number string

aramex

username stringrequired

password stringrequired

account_pin stringrequired

account_entity stringrequired

account_number stringrequired

account_country_code stringrequired

amazon_shipping

seller_id stringrequired

developer_id stringrequired

mws_auth_token stringrequired

aws_region string

Default value: us-east-1

account_country_code string

allied_express_local

username stringrequired

password stringrequired

account string

service_type string

Possible values: [R, P, PT, PT2]

Indicates a service_type string

allied_express

username stringrequired

password stringrequired

account string

service_type string

Possible values: [R, P, PT, PT2]

Indicates a service_type string

capabilities string[]nullable

The carrier enabled capabilities.

config

object

Carrier connection custom config.

property name* any

Default value: [object Object]

Carrier connection custom config.

metadata

object

User metadata for the carrier.

property name* any

Default value: [object Object]

User metadata for the carrier.

is_system booleanrequired

The carrier connection is provided by the system admin.

active booleanrequired

The active flag indicates whether the carrier account is active or not.

test_mode booleanrequired

The test flag indicates whether to use a carrier configured for test.

Example (from schema)

{
  "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
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

424

application/json

Schema

Schema

messages

object[]

The list of error messages

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

carrier_name string

The targeted carrier

carrier_id string

The targeted carrier name (unique identifier)

]

Example (from schema)

{
  "messages": [
    {
      "message": "string",
      "code": "string",
      "details": {},
      "carrier_name": "string",
      "carrier_id": "string"
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...