QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Cancel Labels
Get the cancelled labels
get
Cancel a label
post
Get a cancelled label
get
Pickups
Get pickups
get
Create a pickup
post
Get a pickup
get
Cancel Pickups
Get the cancelled pickups
get
Cancel a pickup
post
Get a cancelled pickup
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Update a shipper account's settings
patch
Specific Shipper Accounts
Create a FedEx shipper account
post
Update a FedEx shipper account
post
Address Validations (Beta)
Create an address validation
post
Locations
Get locations
get
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Volume
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
Location
v3
Pickup
v3
CancelPickup
v3
Carrier Guide
Supported Carriers
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

Shipper Accounts Credentials

Shipper account credentials are necessary fields supported by couriers. Find the full list here.


The shipper account is a customer's account with a specific carrier or shipping service provider. It allows customers to access and manage shipping-related tasks like label generation and rate calculation. The account holds important information such as the customer's details, preferences, and billing information.

The complete list of shipper account credential information and their corresponding slug relations is as follows:

( * means this field is required )

SlugShipper Account Credentials
airspeedapi_key *
api_token *
cancel_token *
amazon-shippingShipper account can be only created by AfterShip Shipping portal.
an-postusername *
password *
company_slug *
apc-overnightpassword *
user_email *
aramexaccount_number *
username *
password *
account_pin *
account_entity *
arvatoclient_id *
api_token *
api_key *
asendiacustomer_id *
username *
password *
australia-postaccount_number *
password *
api_key *
shipment_movement_type *
b2ceuropeauthentication_key *
customer_code *
bjshomedeliveryaccount_number *
api_key *
bleckmanncustomer_id *
api_key *
bluedartlicence_key *
login_id *
prepaid_customer_code
cod_customer_code
bondscouriersaccount *
authorization_code *
bpostaccount_number *
passphrase *
return_instructions *
bpost-internationalusername *
password *
bringusername *
api_key *
api_customer_number *
canada-postapi_key *
customer_number *
contract_id
method_of_payment
box_free
canparuser_identifier *
shipper_num *
password *
china-postec_company_id *
secret *
wh_code *
cj-glscustomer_id *
business_number *
chronopost-franceaccount_number *
password *
sub_account_number
cn-logisticsaccount_number *
colissimocontract_number *
password *
need_cn23 *
continentalaccount *
password *
courexusername *
password *
couriers-pleaseusername *
password *
delhiverytoken *
pickup_name *
seller_gst_tin *
deutsch-postclient_id *
client_secret *
account_number *
dhlaccount_number *
api_key *
api_secret *
show_account_on_waybill
fetch_odd_link
paperless_invoice
dhl-ecommerce-solutions-euclient_id *
password *
customer_identification *
account_number *
dhl-germanyaccount_number *
username *
password *
receiver_id
dhl-global-mailclient_id *
client_secret *
pickup_account_number *
distribution_center *
usps_endorsement
dhl-global-mail-asiapickup_account_id *
billing_account_id *
client_id *
password *
shipment_id_prefix *
handover_method
leitcode
ccn_number
dhlparcel-nluser_id *
key *
account_number *
dhlparcel-ukclient_id *
client_secret *
pickup_account_id *
account_number *
handover_method *
dotzotagent_code *
client_id *
username *
password *
dpdslid *
sftp_user_name *
dpd-bedelis_id *
password *
sending_depot *
dpd-czapi_key *
customer_number *
customer_address_id *
dpd-dedelis_id *
password *
sending_depot *
dpd-nldelis_id *
password *
sending_depot *
dpd-ukusername *
password *
dpexaccount_code
entity_id
entity_pin
username
password
api_key
dtdcentity_id *
entity_pin *
developer_id *
developer_pin *
elite-cousername *
password *
emirotoken *
endiciaaccount_id *
passphrase *
evriclient_id *
client_name *
username *
password *
sms_notification *
api_client_id
api_client_secret
api_key
evri-baShipper account can be only created by AfterShip Shipping portal.
fastway-auclient_id *
client_secret *
fedexaccount_number *
fedex-smartpostaccount_number *
hub_id *
general-overnightusername *
password *
responsible_station *
customer_id *
cost_center
global-expressstore_code *
store_name *
app_key *
iv *
customer_code
glsapp_id *
api_key *
api_secret *
gls-irelandusername *
password *
gls-usaccount_number *
username *
password *
print_pon_version
shipment_notification
shipment_notification_content
recipient_notification
recipient_notification_content
delivery_notification
delivery_notification_content
exception_notification
exception_notification_content
eta_notification
eta_notification_content
gojekclient_id *
pass_key *
gpsapp_id *
app_key *
app_secret *
ups_entry_point
gps_entry_point
grabclient_id *
client_secret *
hermesusername *
password *
client_id *
client_name *
hong-kong-postec_ship_username
hongkong_post_id
hunter-expresstransvirtual_number *
token *
customer_code *
ilyanglogisaccess_key *
edi_code *
account_number *
japan-postconsignor_id *
kerry-express-thapp_id *
app_key *
prefix *
kerry-express-twclient_id *
password *
lalamoveapi_key *
api_secret *
market *
lalamove-plusapi_key *
api_secret *
market *
landmark-globalusername *
password *
region *
client_id
lbcexpressusername *
account_number *
lbc_common_api_key *
lbc_airwaybill_key *
lbc_pickup_request_key *
token *
malaysia-post-
mondialrelaylogin *
password *
customer_id *
mrw-spainagency_code *
subscriber_code *
department_code
username *
password *
collection_confirmation
delivery_confirmation
shipment_tracking
shipment_tracking_content
delivery_at_agency_notification
delivery_at_agency_notification_content
delivery_notice
delivery_notice_content
internation_notification
nacexusername *
password *
agency_code *
customer_code *
department_code
new-zealand-postclient_id *
client_secret *
site_code *
account_number
permit_number
newgisticsshipper_id *
client_id *
client_facility_id *
carrier_facility_id *
api_secret *
api_key *
nightlineusername *
password *
customerCode *
APIKey *
ninjavanclient_id *
client_secret *
omniparcelaccess_key *
currency *
ontraccustomer_branch *
wsid *
wskey *
ontrac_pickup *
pandagoclient_id *
key_id *
scope *
market *
parcllkey *
customer_code *
tracking_number_type *
parcel-forceusername *
password *
department_id *
contract_number *
account_number *
pickuppapi_token *
region *
service_offering_id *
pitney-bowesshipper_id *
minimal_address_validation
porter-expressemail *
password *
pickup *
pickup_start_time
pickup_end_time
poste-italianeclient_id *
secret_id *
cost_center_code *
postnlapi_key *
customer_number *
customer_code *
collection_location
precision-deliveriesclient_id *
client_secret *
edi_client_id *
tariff_group_id *
procarrier-returnsapi_key *
purolatoraccount_number *
key *
key_password *
quantiumaccount_number *
ticket *
shipby_address_code *
rhenus-ukcustomer_name *
api_key *
sendlesendle_id *
api_key *
sf-expressaccount_number *
client_code *
check_word *
label_template_language
sf-express-ibsaccount_number *
check_word *
client_code *
language
aes_key
app_key
app_secret
sf-express-ispaccount_number *
partner_id *
partner_token *
aes_key *
hmac_sha512_key *
origin_code
singapore-postaccount_number *
username *
password *
key *
ship_by_address_code
is_fixed_schedule *
contract_number
skynetworldwideusername *
password *
entity_id *
entity_pin *
account_code *
spain-correos-eslabeller_code *
client_number
contract_number
delivery_attempts
spanish-seurusername *
password *
ci *
ccc *
nif *
client_id *
client_secret *
star-trackaccount_number *
password *
api_key *
swiss-postclient_id *
client_secret *
franking_license *
taqbin-hkbilling_register_number *
branch_code *
t-catcustomer_id *
customer_token *
taqbin-jpapi_user_id *
api_key *
invoice_code *
invoice_code_ext
taqbin-sgapi_key *
taqbin-taiwanaccount_number *
sftp_username *
sftp_password *
taiwan-postftp_server *
ftp_username *
ftp_password *
contractor_id
key_tracking_code
team-global-expresssource_system_code *
consignor_id *
thecourierguyapi_key *
need_notification
tiktok-shipping-
tipsapassword *
agency_code *
customer_code *
department_code
tntcompany_id *
password *
account_number *
preferred_currency
booking_confirmation_email
tnt-auusername *
password *
account_number *
sender_code *
prefix *
overnight_pre_alert_by_sms
overnight_pre_alert_by_email
receiver_milestone_alerts_by_sms
receiver_milestone_alerts_by_email
shipment_movement_type *
tnt-itcustomer_id *
sender_account_id *
user_id *
password *
toll-prioritysource_system_code *
consignor_id *
uberclient_id *
client_secret *
customer_id *
ubi-logisticsapi_token *
api_key *
facility *
upsaccount_number *
paperless_invoice
ups-miaccount_number *
access_key *
password *
user_identifier *
cost_center *
usps_endorsement *
ups-qrretailer_id *
shipping_method_id *
dropoff_method *
uspscustomer_registration_id *
mailer_id *
account_number *
returns_mid
manifest_mailer_id
account_type
permit_number
permit_zip_code
bypass_address_validation
vesylapi_key *
whistlclient_code *
site_code *
customer_number *
yodelidentity *
password *
account_number *
api_key
search_location_type *
yunexpressapp_key *
app_token *