Connect Carrier Accounts

ShipEngine API allows you to connect your existing carrier accounts to your ShipEngine API account programmatically without having to log in to the ShipEngine API dashboard. This is a useful functionality if you have wrapped a custom UI around the ShipEngine API toolset, and want to be able to add or disconnect existing carrier accounts without exposing your end users to the API dashboard.

These APIs can be used in parallel with the ShipEngine Partner APIs to programmatically create new ShipEngine users, and then connect existing carrier accounts all via the API without logging into a dashboard. Together these APIs empower you to completely white-label the ShipEngine experience for your end users.

To learn more about the ShipEngine Partner APIs, please reach out to your ShipEngine Account Manager

Access Worldwide Account Information Model

Property	Description
`nickname`	string, required
`username`	string, required
`password`	string, required

Connect an Access Worldwide account

POST /v1/connections/carriers/access_worldwide

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/access_worldwide HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "Test Access Worldwide Account",
  "username": "your_username_here",
  "password": "your_password_here"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Access Worldwide account

DELETE /v1/connections/carriers/access_worldwide/:id

1
2
3
DELETE /v1/connections/carriers/access_worldwide/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

APC Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required

Connect an APC Account

POST /v1/connections/carriers/apc

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/apc HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my apc account",
  "username": "usernameapc",
  "password": "pa55word"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect an APC Account

DELETE v1/connections/carriers/apc/:id

1
2
3
DELETE /v1/connections/carriers/ HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Asendia Account Information Model

Property	Description
nickname	string, required
ftp_username	string, required
ftp_password	string, required
account_number	int, required

Connect an Asendia Account

POST /v1/connections/carriers/asendia

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/asendia HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my asendia account",
  "ftp_username": "userasendia",
  "ftp_password": "pa55word",
  "account_number": 1234
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect an Asendia Account

DELETE /v1/connections/carriers/asendia/:id

1
2
3
DELETE /v1/connections/carriers/asendia/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Australia Post Account Information Model

Property	Description
nickname	string, required
account_number	string, required
api_key	string, required
api_secret	string, required

Connect an Australia Post Account

POST /v1/connections/carriers/australia_post

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/australia_post HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my australia post account",
  "account_number": "123456789",
  "api_key": "your_api_key_here",
  "api_secret": "your_api_secret_here"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect an Australia Post Account

DELETE /v1/connections/carriers/australia_post/:id

1
2
3
DELETE /v1/connections/carriers/australia_post/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Canpar Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required
account_number	string, required

Connect a Canpar Account

POST /v1/connections/carriers/canpar

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/canpar HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Canpar Account",
  "username": "username",
  "password": "pa55word",
  "account_number": "12345"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Canpar Account

DELETE /v1/connections/carriers/canpar/:id

1
2
3
DELETE /v1/connections/carriers/canpar/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Couriers Please Account Information Model

Property	Description
nickname	string, required
account_number	string, required
auth_token	string, required

Connect a Couriers Please Account

POST /v1/connections/carriers/couriers_please

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/couriers_please HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Couriers Please Account",
  "account_number": "123456789",
  "auth_token": "your_auth_token_here"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Couriers Please Account

DELETE /v1/connections/carriers/couriers_please/:id

1
2
3
DELETE /v1/connections/carriers/couriers_please/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DHL E-Commerce Account Information Model

Property	Description
`nickname`	string, required
`client_id`	string, required
`api_secret`	string, required
`pickup_id`	string, required
`distribution_center`	string, required
`sold_to`	string, required

Connect a DHL E-Commerce account

POST /v1/connections/carriers/dhl_ecommerce

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
POST /v1/connections/carriers/dhl_ecommerce HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "Test DHL E-Commerce Account",
  "client_id": "123456",
  "username": "your_username_here",
  "password": "your_password_here",
  "pickup_number" : "123456789",
  "distribution_center" : "USDFW1",
  "api_key" : "your_api_key_here",
  "api_secret" : "your_api_secret_here"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a DHL E-Commerce account

DELETE /v1/connections/carriers/dhl_ecommerce/:id

1
2
3
DELETE /v1/connections/carriers/dhl_ecommerce/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DHL and DHL E-Commerce service marks are owned by Deutsche Post DHL Group and used with permission.

DHL Express AU Account Information Model

Property	Description
nickname	string, required
account_number	string, required

Connect DHL Express AU

POST /v1/connections/carriers/dhl_express_au

1
2
3
4
5
6
7
8
9
POST /v1/connections/carriers/dhl_express_au HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my dhl account",
  "account_number": "123456789"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect DHL Express AU

DELETE v1/connections/carriers/dhl_express_au/:id

1
2
3
DELETE /v1/connections/carriers/dhl_express_au/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DHL and DHL Express AU service marks are owned by Deutsche Post DHL Group and used with permission.

DHL Express CA Account Information Model

Property	Description
nickname	string, required
account_number	string, required

Connect a DHL Express CA account

POST /v1/connections/carriers/dhl_express_ca

1
2
3
4
5
6
7
8
9
POST /v1/connections/carriers/dhl_express_ca HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my dhl account",
  "account_number": "123456789"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a DHL Express CA account

DELETE /v1/connections/carriers/dhl_express_ca/:id

1
2
3
DELETE /v1/connections/carriers/dhl_express_ca/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DHL and DHL Express CA service marks are owned by Deutsche Post DHL Group and used with permission.

DHL Express UK Account Information Model

Property	Description
nickname	string, required
account_number	string, required
site_id	string, required
password	string, required

Connect a DHL Express UK Account

POST /v1/connections/carriers/dhl_express_uk

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/dhl_express_uk HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my dhl account",
  "account_number": "123456789",
  "site_id": "ExampleId",
  "password": "password123"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a DHL Express UK Account

DELETE /v1/connections/carriers/dhl_express_uk/:id

1
2
3
DELETE /v1/connections/carriers/dhl_express_uk/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DHL and DHL Express UK service marks are owned by Deutsche Post DHL Group and used with permission.

DHL Express Account Information Model

Property	Description
nickname	string, required
account_number	string, required

Connect a DHL Express account

POST /v1/connections/carriers/dhl_express

1
2
3
4
5
6
7
8
9
POST /v1/connections/carriers/dhl_express HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my dhl account",
  "account_number": "123456789"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Modify DHL Express Settings

Hide Account Number in Archive Document

Parameter	Description
should_hide_account_number_on_archive_doc	boolean

PUT /v1/connections/carriers/dhl_express/:dhl_id/settings

1
2
3
4
5
6
7
8
PUT /v1/connections/carriers/ups/se-123/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "should_hide_account_number_on_archive_doc": true
}

GET /v1/connections/carriers/dhl_express/:dhl_id/settings

1
2
3
GET /v1/connections/carriers/dhl_express/se-123/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

1
2
3
4
5
{
  "nickname": "my dhl_express account",
  "should_hide_account_number_on_archive_doc": false,
  "is_primary_account": true
}

Disconnect a DHL Express account

DELETE /v1/connections/carriers/dhl_express/:id

1
2
3
DELETE /v1/connections/carriers/dhl_express/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DHL and DHL Express service marks are owned by Deutsche Post DHL Group and used with permission.

DPD Account Information Model

Property	Description
nickname	string, required
account_number	string, required
password	string, required

Connect a DPD account

POST /v1/connections/carriers/dpd

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/dpd HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my DPD account",
  "account_number": "123456789",
  "password": "password123"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a DPD Local account

DELETE /v1/connections/carriers/dpd-local/:id

1
2
3
DELETE /v1/connections/carriers/dpd-local/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

DPD Local Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required

Connect a DPD Local account

POST /v1/connections/carriers/dpd-local

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/dpd_local HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my DPD Local account",
  "username": "123456789",
  "password": "password123"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a DPD Local account

DELETE /v1/connections/carriers/dpd_local/:id

1
2
3
DELETE /v1/connections/carriers/dpd_local/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Endicia Account Information Model

Property	Description
nickname	string, required
account	string, required
passphrase	string, required

Connect an Endicia Account

POST /v1/connections/carriers/endicia

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/endicia HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Endicia account",
  "account": "__YOUR_USERNAME_HERE__",
  "passphrase": "__YOUR_PASSWORD_HERE__"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect an Endicia Account

DELETE /v1/connections/carriers/endicia/:id

1
2
3
DELETE /v1/connections/carriers/endicia/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Fastway AU Account Information Model

Property	Description
nickname	string, required
client_id	string, required
client_secret	string, required
email	string, required

Connect a Fastway AU Account

POST /v1/connections/carriers/fastway_au

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/fastway_au HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
    "nickname": "My Fastway AU Account",
    "client_id": "myclient-id",
    "client_secret": "mysecret",
    "email": "[email protected]"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Fastway AU Account

DELETE /v1/connections/carriers/fastway_au/:id

1
2
3
DELETE /v1/connections/carriers/fastway_au/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

FedEx UK Account Information Model

Property	Description
nickname	string, required A nickname for your account in ShipEngine. Very useful if you have multiple accounts for the same carrier.
account_number	string, required
first_name	string, required
last_name	string, required
company	string
address1	string, required
address2	string
city	string, required
postal_code	string, required
country_code	string, required
email	string, required
phone	string, required
agree_to_eula	bool, required

Connect a Fedex account

POST /v1/connections/carriers/fedex_uk

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
POST /v1/connections/carriers/fedex_uk HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My FedEx UK account",
  "account_number": "123456789",
  "company": "Example Corp.",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "20 5555 5555",
  "address1": "77 Netherpark Crescent",
  "address2": "Suite 100",
  "city": "London",
  "postal_code": "ABC 123",
  "country_code": "GB",
  "email": "[email protected]",
  "agree_to_eula": "true"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Fedex account

DELETE /v1/connections/carriers/fedex_uk/:id

1
2
3
DELETE /v1/connections/carriers/fedex_uk/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

FedEx service marks are owned by Federal Express Corporation and used with permission.

FedEx Account Information Model

Property	Description
nickname	string, required A nickname for your account in ShipEngine. Very useful if you have multiple accounts for the same carrier.
account_number	string, required
first_name	string, required
last_name	string, required
company	string
address1	string, required
address2	string
city	string, required
state_province	string, required
postal_code	string, required
country_code	string, required
email	string, required
phone	string, required
agree_to_eula	bool, required

Connect a Fedex US and CA account

POST /v1/connections/carriers/fedex

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
POST /v1/connections/carriers/fedex HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My FedEx account",
  "account_number": "123456789",
  "company": "Example Corp.",
  "first_name": "John",
  "last_name": "Doe",
  "phone": "111-111-1111",
  "address1": "4009 Marathon Blvd.",
  "address2": "Suite 300",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78756",
  "country_code": "US",
  "email": "[email protected]",
  "agree_to_eula": "true"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Modify FedEx Settings

ShipEngine takes advantage of some of FedEx's advanced functionality but does not enable it by default.

Pickup Type

Parameter	Type	Description
pickup_type	enumerated string	Determines how FedEx will pickup your packages `none` - Not specified `regular_pickup` - You already have a daily pickup scheduled with FedEx `request_courier` - You will call FedEx to request a courier `drop_box` - You will drop-off packages in a FedEx drop box `business_service_center` - You will drop-off packages at an authorized FedEx business service center `station` - You will drop-off the package at a FedEx Station

FedEx SmartPost™

FedEx makes documentation available for SmartPost™ here.

Parameter Description

smart_post_hub enumerated string
none, allentown_pa, atlanta_ga, charlotte_nc, chino_ca, dallas_tx, denver_co, detroit_mi, edison_nj, grove_city_oh, groveport_oh, houston_tx, indianapolis_in, kansas_city_ks, los_angeles_ca, martinsburg_wv, memphis_tn, minneapolis_mn, new_berlin_wi, northborough_ma, orlando_fl, phoneix_az, pittsburgh_pa, reno_nv, sacramento_ca, salt_lake_city_ut, seattle_wa, st_louis_mo

smart_post_endorsement enumerated string
none, return_service_requested, forwarding_service_requested, address_service_requested, change_service_requested, leave_if_no_response

Parameter	Description
smart_post_hub	enumerated string `none`, `allentown_pa`, `atlanta_ga`, `charlotte_nc`, `chino_ca`, `dallas_tx`, `denver_co`, `detroit_mi`, `edison_nj`, `grove_city_oh`, `groveport_oh`, `houston_tx`, `indianapolis_in`, `kansas_city_ks`, `los_angeles_ca`, `martinsburg_wv`, `memphis_tn`, `minneapolis_mn`, `new_berlin_wi`, `northborough_ma`, `orlando_fl`, `phoneix_az`, `pittsburgh_pa`, `reno_nv`, `sacramento_ca`, `salt_lake_city_ut`, `seattle_wa`, `st_louis_mo`
smart_post_endorsement	enumerated string `none`, `return_service_requested`, `forwarding_service_requested`, `address_service_requested`, `change_service_requested`, `leave_if_no_response`

Common Settings

Parameter	Description
nickname	string Nickname for the account that will appear on carrier calls and in the UI.
is_primary_account	bool Whether or not the account is set to primary, this currently has no function inside of ShipEngine.
signature_image	string A Base 64 encoded image of the signature to be used for this account.
letterhead_image	string A Base 64 encoded image of the letterhead to be used for this account.

PUT /v1/connections/carriers/fedex/:carrier_id/settings

1
2
3
4
5
6
7
8
9
10
11
12
13
14
PUT /v1/connections/carriers/fedex/se-108252/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
    "nickname": "my fedex account",
    "pickup_type": "regular_pickup",
    "smart_post_hub": "dallas_tx",
    "smart_post_endorsement": "address_service_requested",
    "is_primary_account": "false",
    "signature_image" : "base64string",
    "letterhead_image" : "base64string"
}

On a successful response, you will receive an HTTP status 204.

GET /v1/connections/carriers/fedex/:carrier_id/settings

1
2
3
GET /v1/connections/carriers/fedex/se-108252/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

1
2
3
4
5
6
7
8
9
{
  "nickname": "my fedex account",
  "pickup_type": "none",
  "smart_post_hub": "none",
  "smart_post_endorsement": "none",
  "is_primary_account": true,
  "signature_image" : "base64string",
  "letterhead_image" : "base64string"
}

Disconnect a Fedex US and CA account

DELETE /v1/connections/carriers/fedex/:ID

1
2
3
DELETE /v1/connections/carriers/fedex/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

When FedEx has been successfully disconnected, you will receive a HTTP 204, No Content status.

FedEx service marks are owned by Federal Express Corporation and used with permission.

First Mile Account Information Model

Property	Description
nickname	string, required
mailer_id	string, required
password	string, required

Connect a First Mile account

POST /v1/connections/carriers/firstmile

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/firstmile HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my firstmile account",
  "mailer_id": "1234",
  "password": "pa55word"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a First Mile account

DELETE /v1/connections/carriers/firstmile/:id

1
2
3
DELETE /v1/connections/carriers/firstmile/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Globegistics Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required

Connect a Globegistics Account

POST /v1/connections/carriers/globegistics

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/globegistics HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my globegistics account",
  "username": "userglobe",
  "password": "pa55word"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Globegistics Account

DELETE /v1/connections/carriers/globegistics/:id

1
2
3
DELETE /v1/connections/carriers/globegistics/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Hermes Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required
client_id	string, required
client_name	string, required
endpoint ("Production" or "Testing")	string, required

Connect an Hermes Account

POST /v1/connections/carriers/hermescorp

1
2
3
4
5
6
7
8
9
10
11
12
13
POST /v1/connections/carriers/hermescorp HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Hermes Account",
  "username": "hermes_user",
  "password": "pa55word",
  "client_id": "12345",
  "client_name": "Hermes User",
  "endpoint": "Production"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect an Hermes Account

DELETE /v1/connections/carriers/hermescorp/:id

1
2
3
DELETE /v1/connections/carriers/hermescorp/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Newgistics Account Information Model

Property	Description
nickname	string, required
merchant_id	numeric, required
mailer_id	string, required
induction_site	string, required

Connect a Newgistics Account

POST /v1/connections/carriers/newgistics

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/newgistics HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my newgistics account",
  "merchant_id": "123",
  "mailer_id" : "345",
  "induction_site" : "site"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Newgistics Account

DELETE /v1/connections/carriers/newgistics/:id

1
2
3
DELETE /v1/connections/carriers/newgistics/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Landmark Global Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required
client_id	string, required

Connect a Landmark Global Account

POST /v1/connections/carriers/landmark_global

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/landmark_global HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my landmark_global account",
  "username": "username",
  "password": "password",
  "client_id" : "client_id"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Landmark Global Account

DELETE /v1/connections/carriers/landmark_global/:id

1
2
3
DELETE /v1/connections/carriers/landmark_global/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

OnTrac Information Model

Property	Description
nickname	string, required
account_number	int, required
password	string, required

Connect an OnTrac Account

POST /v1/connections/carriers/ontrac

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/ontrac HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my ontrac account",
  "account_number": 1234,
  "password": "pa55word"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect an OnTrac Account

DELETE /v1/connections/carriers/ontrac/:id

1
2
3
DELETE /v1/connections/carriers/ontrac/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Parcelforce Information Model

Property	Description
nickname	string, required
account_number	string, required
password	string, required
sftp_username	string, required
sftp_password	string, required
contract_number	string, required
department_id	string, required
test_account	boolean, required

Connect a Parcelforce Account

POST /v1/connections/carriers/parcelforce

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
POST /v1/connections/carriers/parcelforce HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Parcelforce Account",
  "account_number": "1234",
  "password": "pa55word",
  "sftp_username": "sftp_user",
  "sftp_password": "pa55word",
  "contract_number": "12345",
  "department_id": "12",
  "test_account": false
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Parcelforce Account

DELETE /v1/connections/carriers/parcelforce/:id

1
2
3
DELETE /v1/connections/carriers/parcelforce/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Purolator Canada Account Information Model

Property	Description
nickname	string, required
account_number	string, required
activation_key	string, required

Connect a Purolator Canada Account

POST /v1/connections/carriers/purolator_canada

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/purolator_canada HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "Test Purolator Canada Account",
  "account_number": "1234567890",
  "activation_key" : "abcdefgh-1234-ijkl-5678-mnopqrstuvwx"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Purolator Canada Account

DELETE /v1/connections/carriers/purolator_canada/:id

1
2
3
DELETE /v1/connections/carriers/purolator_canada/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Once ShipEngine has received your OBA Credentials from Royal Mail, your account will be configured. If you have services that use personalized tracking numbers, a request will be put in to Royal Mail to obtain tracking number ranges for your account. If you do not have personalized tracking ranges, you will be notified and your account will be activated. If a tracking range had to be requested, your account will be activated when Royal Mail sends back the valid ranges.

The credential verification process and the tracking range request process may take up to 5 business days each

When your Royal Mail carrier connection is fully activated and verified you will receive an email notification, a notification in the ShipEngine dashboard, and if you are subscribed, the API_CARRIER_CONNECTED webhook.

Royal Mail Account Information Model

Property	Description
nickname	string, required
account_number	string, required
oba_email	string, required
contact_name	string, required
email	string, required
street_line1	string, required
street_line2	string
city	string, required
postal_code	string, required
phone	string, required

Connect a Royal Mail Account

POST /v1/connections/carriers/royal_mail

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
POST /v1/connections/carriers/royal_mail HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Royal Mail account",
  "account_number":  "123456789",
  "oba_email" : "[email protected]",
  "company_name": "Example Corp",
  "contact_name": "John Doe",
  "email": "[email protected]",
  "street_line1": "77 Netherpark Crescent",
  "street_line2": "",
  "city": "STIRKOKE HOUSE",
  "postal_code": "KW1 6LZ",
  "phone": "215-555-5555"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Royal Mail Account

DELETE /v1/connections/carriers/royal_mail/:id

1
2
3
DELETE /v1/connections/carriers/royal_mail/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

RR Donnelley Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required

Connect a RR Donnelley Account

POST /v1/connections/carriers/rr_donnelley

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/rr_donnelley HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my rr donnelley account",
  "username": "donnelleyaccount",
  "password": "pa55word"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a RR Donnelley Account

DELETE /v1/connections/carriers/rr_donnelley/:id

1
2
3
DELETE /v1/connections/carriers/rr_donnelley/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Seko Account Information Model

Property	Description
nickname	string, required
access_key	string, required

Connect a Seko Account

POST /v1/connections/carriers/seko

1
2
3
4
5
6
7
8
9
POST /v1/connections/carriers/seko HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my seko account",
  "access_key": "you_access_key_here"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Seko Account

DELETE /v1/connections/carriers/seko/:id

1
2
3
DELETE /v1/connections/carriers/seko/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Sendle Account Information Model

Property	Description
`nickname`	string, required
`sendle_id`	string, required
`api_key`	string, required

Connect a Sendle account

POST /v1/connections/carriers/sendle

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/sendle HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "Test Sendle Account",
  "sendle_id": "your_username_here",
  "api_key": "your_password_here"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Sendle account

DELETE /v1/connections/carriers/sendle/:id

1
2
3
DELETE /v1/connections/carriers/sendle/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Stamps.com Account Information Model

Property	Description
nickname	string, required
username	string, required
password	string, required

Connect a Stamps.com account

POST /v1/connections/carriers/stamps_com

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/stamps_com HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My stamps.com account",
  "username": "__YOUR_USERNAME_HERE__",
  "password": "__YOUR_PASSWORD_HERE"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Stamps.com account

DELETE /v1/connections/carriers/stamps_com/:id

1
2
3
DELETE /v1/connections/carriers/stamps_com/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

StarTrack Account Information Model

Property	Description
nickname	string, required
account_number	string, required
user_id	string, required
password	string, required

Connect a StarTrack account

POST /v1/connections/carriers/star_track

1
2
3
4
5
6
7
8
9
10
11
POST /v1/connections/carriers/star_track HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Star Track account",
  "account_number": "12345",
  "user_id": "__YOUR_USERNAME_HERE__",
  "password": "__YOUR_PASSWORD_HERE"
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Disconnect a Star Track account

DELETE /v1/connections/carriers/star_track/:id

1
2
3
DELETE /v1/connections/carriers/star_track/se-1234567 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

UPS Account Information Model

Property	Description
nickname	string, required A nickname for your account in ShipEngine. Very useful if you have multiple accounts for the same carrier.
account_number	string, required
account_country_code	string, required
account_postal_code	string, required
title	string, required
first_name	string, required
last_name	string, required
company	string
address1	string, required
address2	string
city	string, required
state	string, required
postal_code	string, required
country_code	string, required
email	string, required
phone	string, required
invoice	UPS Invoice Model, only required if this account has received an invoice in the last 90 days
agree_to_technology_agreement	bool, required

UPS Invoice Model

Property	Description
control_id	string, required
invoice_number	string, required
invoice_amount	decimal`, required
invoice_date	datetime, required

Connect a UPS Account

POST /v1/connections/carriers/ups

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
POST /v1/connections/carriers/ups HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My UPS account",
  "account_number": "123456789",
  "account_country_code": "US",
  "account_postal_code": "78756",
  "company": "Example Corp.",
  "first_name": "John",
  "last_name": "Doe",
  "address1": "4009 Marathon Blvd.",
  "address2": "Suite 300",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78756",
  "country_code": "US",
  "phone": "111-111-1111",
  "email": "[email protected]",
  "agree_to_technology_agreement": "true",
  "invoice": {
    "control_id": "10Z3",
    "invoice_number": "0000A123B4567",
    "invoice_amount": "100.98",
    "invoice_date": "2017-04-01"
  }
}

1
2
3
{
  "carrier-id": "se-1234567"
}

Modify UPS Settings

ShipEngine takes advantage of some of UPS's advanced functionality but does not enable it by default.

Pickup Type

Parameter	Description
pickup_type	enumerated string, `daily_pickup`, `occasional_pickup`, `customer_counter`

Carbon Neutral Shipping Program

Parameter	Description
use_carbon_neutral_shipping_program	bool

Ground Freight Pricing

Parameter	Description
use_ground_freight_pricing (deprecated)	bool

Negotiated Rates

Parameter	Description
use_negotiated_rates	bool If your account has been approved for Negotiated Rates, you can use this option to enable this account to use those rates. Once enabled, you cannot disable Negotiated Rates.
account_postal_code	string, only required for enabling negotiated rates
invoice	UPS Invoice Model, only required for enabling negotiated rates See Connect UPS for the UPS Invoice Model.

Consolidation Service

Parameter	Description
use_consolidation_services	bool
use_order_number_on_mail_innovations_labels	bool
mail_innovations_endorsement	enumerated string `none`, `return_service_requested`, `forwarding_service_requested`, `address_service_requested`, `change_service_requested`, `leave_if_no_response`
mail_innovations_cost_center	string

Common Settings

Parameter	Description
nickname	bool Nickname for the account that will appear on carrier calls and in the UI.
is_primary_account	bool Whether or not the account is set to primary, this currently has no function inside of ShipEngine.

PUT /v1/connections/carriers/ups/:ups_id/settings

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
PUT /v1/connections/carriers/ups/se-123/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "my ups account",
  "is_primary_account": "true",
  "pickup_type": "daily_pickup",
  "use_carbon_neutral_shipping_program": "true",
  "use_ground_freight_pricing": "true",
  "use_negotiated_rates": "true",
  "account_postal_code": "78756",
  "invoice": {
    "control_id": "1234",
    "invoice_number": "12345",
    "invoice_amount": "1.99",
    "invoice_date": "2019-7-26"
  },
  "use_consolidation_services": "true",
  "use_order_number_on_mail_innovations_labels": "true",
  "mail_innovations_endorsement": "change_service_requested",
  "mail_innovations_cost_center": "TEST"
}

GET /v1/connections/carriers/ups/:ups_id/settings

1
2
3
GET /v1/connections/carriers/ups/se-123/settings HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "nickname": "UPS-28A1R9",
  "is_primary_account": true,
  "pickup_type": "daily_pickup",
  "use_carbon_neutral_shipping_program": false,
  "use_ground_freight_pricing": false,
  "use_consolidation_services": false,
  "use_order_number_on_mail_innovations_labels": false,
  "mail_innovations_endorsement": "none",
  "mail_innovations_cost_center": null,
  "use_negotiated_rates": false,
  "account_postal_code": null,
  "invoice": null
}

Disconnect a UPS Account

DELETE /v1/connections/carriers/ups/:id

1
2
3
DELETE /v1/connections/carriers/UPS/se-1234 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

When UPS has been successfully disconnected, you will receive a HTTP 204, No Content status.

Connect Carrier Accounts

Access Worldwide

Access Worldwide Account Information Model

Connect an Access Worldwide account

Disconnect a Access Worldwide account

APC

APC Account Information Model

Connect an APC Account

Disconnect an APC Account

Asendia

Asendia Account Information Model

Connect an Asendia Account

Disconnect an Asendia Account

Australia Post

Australia Post Account Information Model

Connect an Australia Post Account

Disconnect an Australia Post Account

Canpar

Canpar Account Information Model

Connect a Canpar Account

Disconnect a Canpar Account

Couriers Please

Couriers Please Account Information Model

Connect a Couriers Please Account

Disconnect a Couriers Please Account

DHL E-Commerce

DHL E-Commerce Account Information Model

Connect a DHL E-Commerce account

Disconnect a DHL E-Commerce account

DHL Express AU

DHL Express AU Account Information Model

Connect DHL Express AU

Disconnect DHL Express AU

DHL Express CA

DHL Express CA Account Information Model

Connect a DHL Express CA account

Disconnect a DHL Express CA account

DHL Express UK

DHL Express UK Account Information Model

Connect a DHL Express UK Account

Disconnect a DHL Express UK Account

DHL Express

DHL Express Account Information Model

Connect a DHL Express account

Modify DHL Express Settings

Hide Account Number in Archive Document

Disconnect a DHL Express account

DPD

DPD Account Information Model

Connect a DPD account

Disconnect a DPD Local account

DPD Local

DPD Local Account Information Model

Connect a DPD Local account

Disconnect a DPD Local account

Endicia

Endicia Account Information Model

Connect an Endicia Account

Disconnect an Endicia Account

Fastway AU

Fastway AU Account Information Model

Connect a Fastway AU Account

Disconnect a Fastway AU Account

FedEx UK

FedEx UK Account Information Model

Connect a Fedex account

Disconnect a Fedex account

FedEx US and CA

FedEx Account Information Model

Connect a Fedex US and CA account

Modify FedEx Settings

Pickup Type

FedEx SmartPost™

Common Settings

Disconnect a Fedex US and CA account

First Mile

First Mile Account Information Model

Connect a First Mile account

Disconnect a First Mile account

Globegistics