Carrier Parameters

Some of the supported carriers in our system accept custom parameters such as account credentials, API tokens, and shipment configuration. Parameters may be added, removed, or changed in the future to accommodate upstream changes by the carriers and our own integrations.

Carrier Name ID Parameters
Deutsche Post DeutschePost
ekp String - EKP number that is assigned to you by DeutschePost. Not required for testing.
contract_participation String - Contract participation value that is assigned to you by DeutschePost. Not required for testing.
cig_username String - CIG username value that is assigned to you by DeutschePost when you create an application. Not required for testing.
cig_password String - CIG password value that is assigned to you by DeutschePost when you create an application. Not required for testing.
tnt_username String - TNT username value that is assigned to you by DeutschePost for Paket services. Not required for testing.
tnt_password String - TNT password value that is assigned to you by DeutschePost for Paket services. Not required for testing.
retoure_username String - Retoure username value that is assigned to you by DeutschePost. Required for return shipments. Not required for testing.
retoure_password String - Retoure password value that is assigned to you by DeutschePost. Required for return shipments. Not required for testing.
receiver_id String - Receiver ID is found in Post & DHL Business Customer Portal under the menu item "Returns" > "Settings" under the entry "Receiver ID". Required for return shipments. Not required for testing.
label_format String - Printed label will be in the provided format. Accepted values:
  • A4
  • 910-300-300 (default)
  • 910-300-300-oz
  • 910-300-400
  • 910-300-600
  • 910-300-700
  • 910-300-700-oz
  • 910-300-710
PostNL PostNL
customer_code String - 4 character customer code assigned by PostNL.
customer_number String - 8 digit customer number assigned by PostNL.
Toll Toll
ipec_account String - IPEC account number assigned by Toll.
priority_account String - Priority Australia account number assigned by Toll.
DHL eCommerce DHLeC
client_id String - Client ID that is assigned to you by DHL. Not required for testing.
client_secret String - Client Secret value that is assigned to you by DHL. Not required for testing.
pickup_id String - DHL eCommerce pickup account number. You will receive this after on-boarding with DHL eCommerce Solutions sales and customer implementation team. This is not the same as the Sold To Account number. Not required for testing.
distribution_center String - Primary DHL eCommerce Distribution center assigned to your products/services. This is the distribution center where your packages are going to be lodged after pickup. Not required for testing.