Connect Carrier Accounts
In addition to the ShipEngine carriers that are included with your account, you can connect your own carriers and see your negotiated rates inside ShipEngine. This can be done programmatically through the ShipEngine API or in your ShipEngine Dashboard.
Available Carrier Integrations
ShipEngine supports several global carriers that offer a variety of domestic and international services to meet your brand's unique shipping needs.
Open the sections below to view connection details and example connection requests for your carriers.
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
Disconnect a Access Worldwide account
DELETE /v1/connections/carriers/access_worldwide/:id
APC Account Information Model
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
Connect an APC Account
POST /v1/connections/carriers/apc
Disconnect an APC Account
DELETE v1/connections/carriers/apc/:id
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
Disconnect an Asendia Account
DELETE /v1/connections/carriers/asendia/:id
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
Disconnect an Australia Post Account
DELETE /v1/connections/carriers/australia_post/:id
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
Disconnect a Canpar Account
DELETE /v1/connections/carriers/canpar/:id
CouriersPlease Account Information Model
Property | Description |
---|---|
nickname | string, required |
account_number | string, required |
api_secret | string, required |
Connect a CouriersPlease Account
POST /v1/connections/carriers/couriers_please
Disconnect a CouriersPlease Account
DELETE /v1/connections/carriers/couriers_please/:id
CourierPost Account Information Model
Property | Description |
---|---|
nickname | string, required |
username | string, required |
accountnumber | integer, required |
siteCode | integer, required |
Connect a CourierPost Account
POST /v1/connections/carriers/courierpost
Disconnect a CourierPost Account
DELETE /v1/connections/carriers/courierpost/:id
Delivengo Account Information Model
Property | Description |
---|---|
nickname | string, required |
string, required | |
api_key | string, required |
Connect a Delivengo Account
POST /v1/connections/carriers/delivengo
Disconnect a Delivengo Account
DELETE /v1/connections/carriers/delivengo/:id
DHL E-Commerce Account Information Model
Property | Description |
---|---|
nickname | string, required |
client_id | string, required |
api_secret | string, required |
pickup_number | string, required |
distribution_center | string, required |
sold_to | string, required |
Connect a DHL E-Commerce account
POST /v1/connections/carriers/dhl_ecommerce
Disconnect a DHL E-Commerce account
DELETE /v1/connections/carriers/dhl_ecommerce/:id
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
Disconnect DHL Express AU
DELETE v1/connections/carriers/dhl_express_au/:id
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
Disconnect a DHL Express CA account
DELETE /v1/connections/carriers/dhl_express_ca/:id
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
Disconnect a DHL Express UK Account
DELETE /v1/connections/carriers/dhl_express_uk/:id
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 |
site_id | string, required if password provided |
password | string, required if site_id provided |
country_code | string, optional |
Connect a DHL Express account
POST /v1/connections/carriers/dhl_express
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
GET /v1/connections/carriers/dhl_express/:dhl_id/settings
Disconnect a DHL Express account
DELETE /v1/connections/carriers/dhl_express/:id
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
Disconnect a DPD Local account
DELETE /v1/connections/carriers/dpd-local/:id
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
Disconnect a DPD Local account
DELETE /v1/connections/carriers/dpd_local/:id
Endicia Account Information Model
Property | Description |
---|---|
nickname | string, required |
account | string, required |
passphrase | string, required |
Connect an Endicia Account
POST /v1/connections/carriers/endicia
Disconnect an Endicia Account
DELETE /v1/connections/carriers/endicia/:id
Fastway AU Account Information Model
Property | Description |
---|---|
nickname | string, required |
client_id | string, required |
client_secret | string, required |
string, required |
Connect a Fastway AU Account
POST /v1/connections/carriers/fastway_au
Disconnect a Fastway AU Account
DELETE /v1/connections/carriers/fastway_au/:id
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 |
string, required | |
phone | string, required |
agree_to_eula | bool, required |
Connect a Fedex account
POST /v1/connections/carriers/fedex_uk
Disconnect a Fedex account
DELETE /v1/connections/carriers/fedex_uk/:id
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 |
string, required | |
phone | string, required |
agree_to_eula | bool, required |
Connect a Fedex US and CA account
POST /v1/connections/carriers/fedex
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 packagesnone - Not specifiedregular_pickup - You already have a daily pickup scheduled with FedExrequest_courier - You will call FedEx to request a courierdrop_box - You will drop-off packages in a FedEx drop boxbusiness_service_center - You will drop-off packages at an authorized FedEx business service centerstation - 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 |
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
On a successful response, you will receive an HTTP status 204.
GET /v1/connections/carriers/fedex/:carrier_id/settings
Disconnect a Fedex US and CA account
DELETE /v1/connections/carriers/fedex/:ID
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
Disconnect a First Mile account
DELETE /v1/connections/carriers/firstmile/:id
GLS Canada Account Information Model
Important: Please use your API login credentials to link your GLS account. These credentials are different from the credentials for the GLS website. To obtain your API credentials, submit a request with the GLS sales team.
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
key | string, required |
Connect a GLS Canada Account
POST /v1/connections/carriers/gls_ca
Disconnect a GLS Canada Account
DELETE /v1/connections/carriers/gls_ca/:id
GLS Deutschland Account Information Model
Important: Please use your API login credentials to link your GLS account. These credentials are different from the credentials for the GLS website. To obtain your API credentials, submit a request with the GLS sales team.
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
key | string, required |
Connect a GLS Deutschland Account
POST /v1/connections/carriers/gls_de
Disconnect a GLS Deutschland Account
DELETE /v1/connections/carriers/gls_de/:id
GLS Netherlands Account Information Model
Important: Please use your API login credentials to link your GLS account. These credentials are different from the credentials for the GLS website. To obtain your API credentials, submit a request with the GLS sales team.
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
key | string, required |
Connect a GLS Netherlands Account
POST /v1/connections/carriers/gls_nl
Disconnect a GLS Netherlands Account
DELETE /v1/connections/carriers/gls_nl/:id
GLS US Account Information Model
Important: Please use your API login credentials to link your GLS account. These credentials are different from the credentials for the GLS website. To obtain your API credentials, submit a request with the GLS sales team.
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
account_number | integer, required |
Connect a GLS US Account
POST /v1/connections/carriers/gls_us
Disconnect a GLS US Account
DELETE /v1/connections/carriers/gls_us/:id
GrupoAMPM Account Information Model
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
account_number | number, required |
Connect a GrupoAMPM Account
POST /v1/connections/carriers/grupo_ampm
Disconnect a GrupoAMPM Account
DELETE /v1/connections/carriers/grupo_ampm/:id
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
Disconnect an Hermes Account
DELETE /v1/connections/carriers/hermescorp/:id
IntelliQuick Delivery Account Information Model
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
account_number | integer, required |
Connect an IntelliQuick Delivery Account
POST /v1/connections/carriers/intelliquick_delivery
Disconnect an IntelliQuick Delivery Account
DELETE /v1/connections/carriers/intelliquick_delivery/:id
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
Disconnect a Landmark Global Account
DELETE /v1/connections/carriers/landmark_global/:id
Loomis Express Account Information Model
Property | Description |
---|---|
nickname | string, required |
user_id | string, required |
password | string, required |
shipper_num | string, required |
Connect a Loomis Express Account
POST /v1/connections/carriers/loomis_express
Disconnect a Loomis Express Account
DELETE /v1/connections/carriers/loomis_express/:id
Mondial Relay Account Information Model
Property | Description |
---|---|
nickname | string, required |
api_key | string, required |
enseigne | string, required |
Connect a Mondial Relay Account
POST /v1/connections/carriers/mondial_relay
Disconnect a Mondial Relay Account
DELETE /v1/connections/carriers/mondial_relay/:id
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
Disconnect a Newgistics Account
DELETE /v1/connections/carriers/newgistics/:id
99Minutos Account Information Model
Property | Description |
---|---|
nickname | string, required |
api_key | string, required |
Connect a 99Minutos account
POST /v1/connections/carriers/n9minutos
Disconnect a 99Minutos account
DELETE /v1/connections/carriers/n9minutos/:id
OnTrac Information Model
Property | Description |
---|---|
nickname | string, required |
account_number | int, required |
password | string, required |
Connect an OnTrac Account
POST /v1/connections/carriers/ontrac
Disconnect an OnTrac Account
DELETE /v1/connections/carriers/ontrac/:id
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
Disconnect a Parcelforce Account
DELETE /v1/connections/carriers/parcelforce/:id
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
Disconnect a Purolator Canada Account
DELETE /v1/connections/carriers/purolator_canada/:id
Redpack Account Information Model
Property | Description |
---|---|
nickname | string, required |
username | string, required |
password | string, required |
client_id | string, required |
client_secret | string required |
Connect a Redpack Account
POST /v1/connections/carriers/redpack
Disconnect a Redpack Account
DELETE /v1/connections/carriers/redpack/:id
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 |
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
Disconnect a Royal Mail Account
DELETE /v1/connections/carriers/royal_mail/:id
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
Disconnect a RR Donnelley Account
DELETE /v1/connections/carriers/rr_donnelley/:id
Seko Account Information Model
Property | Description |
---|---|
nickname | string, required |
access_key | string, required |
Connect a Seko Account
POST /v1/connections/carriers/seko
Disconnect a Seko Account
DELETE /v1/connections/carriers/seko/:id
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
Disconnect a Sendle account
DELETE /v1/connections/carriers/sendle/:id
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
Disconnect a Stamps.com account
DELETE /v1/connections/carriers/stamps_com/:id
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
Disconnect a Star Track account
DELETE /v1/connections/carriers/star_track/:id
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 |
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
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 This setting enables UPS SurePost® and/or UPS Mail Innovations services to be accessed through ShipEngine if they are enabled on your UPS account. |
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
GET /v1/connections/carriers/ups/:ups_id/settings
Disconnect a UPS Account
DELETE /v1/connections/carriers/ups/:id
When UPS has been successfully disconnected, you will receive a HTTP 204, No Content status.
Yodel Account Information Model
Property | Description |
---|---|
nickname | string, required |
user_id | string, required |
account_id | string, required |
password | string, required |
Connect a Yodel account
POST /v1/connections/carriers/yodel
Disconnect a Yodel account
DELETE /v1/connections/carriers/yodel/:id