Carrier Account Input Parameters

Overview

The inputParameters array in the Add Carrier Account API takes the parameters described here. The parameters depend on the carrier:

Input Parameters for FedEx

Name

Description


CLIENT_SOFTWARE_PRODUCT

The name of the software platform used for generating labels.

Input Parameters for UPS

Name

Description


ACCOUNT_COUNTRY_CODE

The two-character ISO country code for the merchant’s country.

Supported countries:

  • US

  • CA

ACCOUNT_POSTAL_CODE

The merchant’s postal code.

CONTACT_TITLE

Required. The title of the primary contact that the merchant provided to the carrier.

DEVICE_IDENTITY

The black-box identity of the merchant’s machine. UPS recommends including this. For help in retrieving the black-box identity, consult your Pitney Bowes implementation engineer.

END_USER_IP

Required. The IP address of the merchant’s machine.

INVOICE_AMOUNT

The amount charged on a recent invoice. This is required if the merchant has shipped in the last 90 days. Use the same invoice for all the INVOICE_* parameters in this table. Merchants can retrieve invoices by logging into their accounts at https://www.ups.com. If the merchant has not shipped in the last 90 days, no invoice information is required.

Enter the amount from the invoice’s Charges This Period field. The invoice must be from within the last 90 days. The value for this parameter can have a maximum of 16 digits before the decimal and 2 digits after the decimal.

Example: 1235.84

Required if the merchant has shipped in the last 90 days.

INVOICE_CONTROL_ID

The Control ID displayed on the invoice.

Required if the merchant has shipped in the last 90 days.

INVOICE_CURRENCY_CODE

The currency code used on the invoice. Supported currencies:

  • USD

  • CAD

Required if the merchant has shipped in the last 90 days.

INVOICE_DATE

The date of the invoice if the merchant has shipped in the last 90 days. The invoice date must be within the last 90 days. Use the following format:

yyyyMMdd

Required if the merchant has shipped in the last 90 days.

INVOICE_NUMBER

The invoice number.

Required if the merchant has shipped in the last 90 days.

LICENSE_TEXT

Required. The text of the merchant’s license agreement with the carrier, as retrieved through the Get Carrier License Agreement API.