Common Resource Objects

This page describes common JSON objects used by the Pitney Bowes Ecommerce APIs.

For objects not listed here, please see the documentation page for the API operation.

Object

Description

Address

An address associated with the shipment, such as the origin or destination.

Customs

Customs-clearance information.

Customs Info

Customs-clearance information.

Customs Items

Customs-clearance information.

Dimension

Parcel dimensions.

Documents

The shipment documents, including the label.

Manifest

The end-of-day form that lists all parcels or shipments.

Merchant

The shipper. Each merchant is uniquely identified by the value of the postalReportingNumber field.

Parcel

The physical characteristics of a parcel.

Rates

The shipment’s service, special services, parcel type, and dimensions. In a response, this object also includes the shipment’s charges.

Shipment

The high-level object that includes all the information about a shipment.

Special Services

The special services applied to the shipment.

Transaction

Detailed information associated with a transaction.

 

Address Object

The address object contains the origin or destination address for a parcel.

Important

For the required fields in this object, see the Considerations section on the API request’s documentation page.

Name

Data Type

Description

addressLines

Array[String]

Conditional. Street address or P.O. Box. Include apartment number ifapplicable. You can specify up to 3 address lines.

To determine if this field is required, see the Considerations section on the API request’s documentation page.

For USPS® domestic shipments: ensure that the street address is specified as the last of the 3 address lines. This way, the street address is printed right above the city, state, and postal code, per USPS label guidelines.

cityTown

String

Conditional. The city or town. To determine if this field is required, see the API request’s documentation page.

stateProvince

String

Conditional. The state or province. For a US or Canadian address, use the 2-letter state or province code. To determine if this field is required, see the API request’s documentation page.

postalCode

String

Conditional. The postal code or ZIP code. To determine if this field is required, see the API request’s documentation page.

For US addresses, use either the 5-digit or 9-digit ZIP code in one of the following formats:

  • 12345

  • 12345-6789

If you use a different format, such as 12345- or 123451234, you will receive an error.

countryCode

String

Conditional. Two-character country code from the ISO country list. To determine if this field is required, see the API request’s documentation page.

company

String

Conditional. The name of the company. To determine if this field is required, see the API request’s documentation page.

name

String

Conditional. The first and last name. To determine if this field is required, see the API request’s documentation page.

phone

String

Conditional. The phone number. Enter the digits with or without spaces or hyphens. When used for Pickups, the maximum is 10 digits. To determine if this field is required, see the API request’s documentation page.

email

String

Conditional. The email address. To determine if this field is required, see the API request’s documentation page.

residential

Boolean

Conditional. Indicates whether this is a residential address. Pitney Bowes recommends including this parameter to improve address verification.

This field is required for APAC Services.

deliveryPoint

String

The 2-digit USPS domestic delivery point, when available.

carrierRoute

String

The last four characters of the USPS domestic carrier route code. The carrier route is the area served by a particular USPS mail carrier. The full carrier route code is a nine-character string comprising the five-digit postal code appended by these four characters.

taxId

String

Pickup Request Only. Tax identification number. This is optional for pickup requests.

status

String

RESPONSE ONLY. This field applies to the Validate Address and Suggest Addresses APIs. The field indicates whether the submitted address is valid and whether the API made changes to the address.

Possible values are:

  • VALIDATED_CHANGED: The address is valid, but the API made changes to improve the address. For example, if an address has a valid street number and street name (e.g. “100 Elm”) but is missing the street suffix (e.g. “St”), the API would add the suffix.

  • VALIDATED_AND_NOT_CHANGED: The address is valid. The API made no changes.

  • NOT_CHANGED: The address could not be validated. The API made no changes.

 

Customs Object

Name

Data Type

Description

customsInfo

Customs Info Object

Customs clearance information used to fill out a commercial invoice.

customsItems

Array[Customs Items Object]

Customs clearance information about each commodity.

 

Customs Info Object

Name

Data Type

Description

certificateNumber

String

The certificate number associated with the commodity.

comments

String

Free form comments regarding the exported shipment entered by the shipper.

currencyCode

String

Required. The type of currency used for the monetary values in this API request. Use three uppercase letters, per ISO 4217. For example, use USD for US Dollars, CAD for Canadian Dollars, and EUR for Euros. The full list of currency codes can be downloaded in XLS or XML from https://www.iso.org/iso-4217-currency-codes.html.

CBDS Requirement: For the Create CBDS Shipment API, set this field as follows: For U.S. outbound, set this field to USD. For UK outbound, set this field to GBP.

businessType

String

CBDS Quotes API Only. Enter the type of transaction. Valid values are:

  • B2B

  • B2C (Default)

customsDeclaredValue

BigDecimal

Conditional. Enter the value to declare in customs for the shipment. Enter the value in the currency specified in the currencyCode field.

This field is required for FedEx.

Do not use this field for PB Expedited (USPS).

EELPFC

String

Conditional. A number provided by the Automated Export System (AES).

This field is required if the item is valued at more than $2,500 USD per Schedule B export codes.

firstMileInsuredAmount

BigDecimal

CBDS Quotes API Only. For merchants who use the Drop-Off delivery solution, enter the insurance fee associated with bringing the parcel to the Pitney Bowes facility, if applicable. The value is used in the duty-and-tax calculation for countries that include the fee in the calculation.

firstMileShippingAmount

BigDecimal

CBDS Quotes API Only. For merchants who use the Drop-Off delivery solution, enter the shipping cost associated with bringing the parcel to the Pitney Bowes facility. The value is used in the duty-and-tax calculation for countries that include the cost in the calculation.

freightCharge

BigDecimal

FedEx Only. For merchants who ship with FedEx, this field prints a freight charge on the FedEx Commercial Invoice. This field is optional.

Note: If this field appears in the response for a carrier other than FedEx, it will have a value of 0.0 and can be ignored.

fromCustomsReference

String

Free form reference information provided by the requestor of the shipment. Depending on the carrier this information may or may not be rendered on the customs documents.

handlingCosts

BigDecimal

FedEx Only. For merchants who ship with FedEx, this field prints a handling charge on the FedEx Commercial Invoice. This field is optional.

Note: If this field appears in the response for a carrier other than FedEx, it will have a value of 0.0 and can be ignored.

importerCustomsReference

String

Conditional. A reference number used by the importer, such as a VAT number, PO number, or insured number.

Shipments to the EU: Merchants shipping to the European Union (EU) from outside the EU must provide a VAT or IOSS number. Enter the number in this field and specify the reference type in the importerCustomsReferenceType field. This field does not apply to CBDS, which automatically provides the IOSS number. Note that Pitney Bowes does not print the number on the customs form.

Shipments to Brazil: This field is required. Use this field to provide the Importer’s Tax Identification (ID) Number. Brazil requires the Tax ID for all imports. Items missing the Tax ID are subject to return. If using the First-Class Package International Service (FCPIS), set the label size to DOC_8X11. See also: Where is the Importer’s Tax ID displayed?

importerCustomsReferenceType

String

Conditional. If you entered a VAT or IOSS number in the importerCustomsReference field, specify which type of number you entered. Specify one of the following:

  • VAT_NUMBER

  • IOSS_NUMBER

If you entered a VAT or IOSS number in the importerCustomsReference field, this field is required.

insuredAmount

BigDecimal

CBDS & FedEx Only. Conditional. Enter the insurance fee, if applicable. This field is used as follows:

  • CBDS: This field applies only to the CBDS Quotes API. Enter the full end-to-end insurance fee, if applicable. The value is used in the duty-and-tax calculation for countries that include the fee in the calculation. This field is required if an insurance fee applies and the merchant uses the CBDS digital-only solution (i.e., the merchant does not ship via CBDS).

  • FedEx: This field prints the insurance fee on the FedEx Commercial Invoice. Enter the fee for the purchased insurance. Do not enter coverage amount.

Note: If this field appears in the response for a carrier other than the above, it will have a value of 0.0 and can be ignored.

insuredNumber

String

If the sender wishes to insure the contents, they complete an insurance receipt and affix the insured numbered label to the package. The insured number label is what this field represents.

invoiceNumber

String

The commercial invoice number assigned by the exporter.

licenseNumber

String

The export license number associated with the commodity.

otherCharge

BigDecimal

FedEx Only. For merchants who ship with FedEx, this field prints any additional charges on the Commercial Invoice, other than those entered in the freightCharge, handlingCosts, insuredAmount, or packingCosts fields. This field is optional.

Note: If this field appears in the response for a carrier other than FedEx, it will have a value of 0.0 and can be ignored.

packingCosts

BigDecimal

FedEx Only. For merchants who ship with FedEx, this field prints a packing charge on the FedEx Commercial Invoice. This field is optional.

Note: If this field appears in the response for a carrier other than FedEx, it will have a value of 0.0 and can be ignored.

portOfClearance

String

CBDS Quotes API Only. Conditional. If the port of clearance for a shipment is different from the country of destination, enter the two-character ISO country code for the port of clearance. For example, enter NL if a shipment destined for Germany is cleared for customs in the Netherlands.

If the port of clearance and destination country are the same, leave this field blank.

This field is required if the port of clearance is different from the country of destination and if the merchant uses the CBDS digital-only solution (i.e., does not ship via CBDS).

reasonForExport

String

Conditional. The reason the commodity is being exported. Valid values are:

  • GIFT

  • COMMERCIAL_SAMPLE

  • MERCHANDISE

  • DOCUMENTS (If using this value, see also this related FAQ)

  • RETURNED_GOODS

  • OTHER

This field is required by customsInfo for PB Expedited (USPS) and for UPS.

Note: For USPS First-Class Mail International (FCMI), you must set this field to DOCUMENTS. FCMI cannot ship goods. To ship goods through USPS, you can use First-Class Package International Service (FCPIS) or other services.

reasonForExportExplanation

String

Conditional. The reason the commodity is being exported.

This field is required for PB Expedited (USPS) if the reasonForExport field is set to OTHER.

sdrValue

BigDecimal

When an international parcel is insured, the insured value must be expressed in Special Drawing Rights values. E.g. $100 USD = 66.87 SDR.

shippingAmount

BigDecimal

CBDS Quotes API Only. Conditional. Enter the end-to-end shipping cost. Enter the cost in the currency specified in the currencyCode field. The value is used in the duty-and-tax calculation for countries that include the cost in the calculation. This field is required if the merchant uses the CBDS digital-only solution (i.e., does not ship via CBDS).

shippingDocumentType

String

UPS Only.

termsOfSale

String

UPS Only.

 

Customs Items Object

The following table lists the fields alphabetically.

Name

Data Type

Description

brand

String

CBDS Only. The manufacturer’s brand name for the item. The maximum length is 255 characters.

categories

Array[Categories Object]

CBDS Only. Conditional. Associated categories. The merchant’s category tree must have been provided to Pitney Bowes in advance. Do not use this array if the merchant did not provide a category tree.

This field is required by the HS Code API.

condition

String

CBDS Only. Condition of the commodity. If the merchant is using an eBay-specific category tree, enter the eBay item’s conditionId. Otherwise use one of the following values:

  • new

  • used

  • refurbished

  • damaged

  • unknown

description

String

Required. A detailed description of the commodity.

For CBDS, make the description as detailed as possible to facilitate assignment of the correct HS code.

eccn

String

CBDS Only. The Export Control Classification Number (ECCN) for the commodity. The maximum length is 10 characters.

hazmats

Array[String]

CBDS Only. For a HAZMAT-flagged item, enter one or more of the HAZMAT classifications listed here.

hSTariffCode

String

Conditional. The destination country’s tariff-classification number for the commodity. Most countries use the six-digit Harmonized System (HS) as the basis for their tariff classifications and add additional digits for more detail. The maximum length is 14 characters.

If you are issuing the HS Code API, you can use this field to help with the HS code prediction by entering the commodity’s HS code from another country, such as from the origin country. Enter the country that the code comes from in the hSTariffCodeCountry field.

This field is required by the CBDS Quotes API.

hSTariffCodeCountry

String

CBDS Only. Conditional. The two-character ISO Country Code for the country supplying the HS code. This is usually the destination country.

This field is required if the hSTariffCode field is used.

identifiers

Array[Object]

CBDS Only. Additional identifiers for the item. Each object in the array defines a type of identifier and its value.

identifiers.source

String

CBDS Only. The type of identifier, such as MPN, SKU, UPC, ISBN, or ISSN. Enter the identifier as a String of up to 10 characters. This field is required by the identifiers array.

identifiers.number

String

CBDS Only. The value of the identifier. Enter a String of up to 50 characters. This field is required by the identifiers array.

imageURL

Array[String]

CBDS Only. Enter one or more URLs that link to an image of the commodity. Enter the URLs as Strings, separated by commas.

itemDimension

Dimension Object

CBDS Only. The dimensions for a single item. To enter dimensions, see the Dimension Object.

itemId

String

CBDS Only. Required. The merchant’s unique identifier for the commodity, such as the SKU. The maximum length is 50 characters.

manufacturer

String

CBDS Only. The manufacturer of the item. The maximum length is 255 characters.

netCostMethod

String

UPS Only.

originCountryCode

String

Conditional. The two-character ISO country code of the shipment’s origin country. Use ISO 3166-1 alpha-2 standard values.

This field is required by FedEx and UPS.

originStateProvince

String

UPS Only.

preferenceCriterion

String

UPS Only.

pricing

Object

CBDS Only. The pricing information for the commodity. If the information is not in the shopping cart, then this information is used.

pricing.price

BigDecimal

CBDS Only. List price of the item.

producerAddress

Address Object

UPS Only.

producerDetermination

String

UPS Only.

producerId

String

UPS Only.

quantity

Integer

Required, except for the HS Code API. Enter the total number of items of this type of commodity. For PB Expedited (USPS), the number of items cannot exceed 9999. USPS limits the number of items of one commodity to 9999.

Note: This field is optional for the HS Code API.

quantityUOM

String

FedEx, UPS Only. Required. The 1-to-3 character code for the unit of measurement, such as BAG, CTN, or EA.

unitPrice

BigDecimal

Required. The price of one item of this type of commodity.

unitWeight

Object

Required, except for CBDS. The weight and unit of measure of one item of the commodity.

Note: This field is optional for CBDS.

unitWeight.weight

Number

The weight of the item. This field is required by the unitWeight object.

unitWeight.unitOfMeasurement

String

The unit of measurement. This field is required by the unitWeight object. If the carrier is PB Expedited (USPS), set this to OZ. This field can take the following values:

  • OZ: Ounces

  • GM: Grams

  • G: Grams. Available only for CBDS

  • LB: Pounds. Available only for CBDS

  • KG: Kilograms. Available only for CBDS

url

String

CBDS Only. This field is optional but recommended. Enter the commodity’s URL on the merchant site. Ensure the URL works. Providing an accurate URL helps Pitney Bowes assign the correct HS code. The maximum length for this field is 1000 characters.

 

Dimension Object

Name

Data Type

Description

length

BigDecimal

Required. The longest dimension.

Entering Dimensions: In the dimension object, enter length as the longest dimension, height as next longest, and width as shortest. If you enter dimensions differently, the API will reassign them accordingly. For example, if you have a parcel that measures 6 x 4 x 1 inches, and if you assign 1 inch to the height:

"length": "6.0", "width": "4.0", "height": "1.0"

The API will reassign the values to assign 1 inch to the width:

"length": "6.0", "width": "1.0", "height": "4.0"

height

BigDecimal

Required. The second longest dimension. Height helps determine a parcel’s girth.

For the order of dimensions, see Entering Dimensions above.

width

BigDecimal

Required. The smallest dimension. Width helps determine a parcel’s girth.

Note: If you do not set width to the smallest dimension, the APIs will automatically reassign the dimension values to ensure width is set to the smallest dimension. See Entering Dimensions above.

unitOfMeasurement

String

Required. The unit of measure. Valid values:

  • IN: Inches (This is the required value for PB Expedited.)

  • CM: Centimeters

  • FT: Feet (Available for CBDS Only)

  • YD: Yards (Available for CBDS Only)

  • M: Meters (Available for CBDS Only)

irregularParcelGirth

String

For a USPS irregular parcel, set this to the girth of the irregular parcel. Girth is twice the sum of the height and width:

girth = 2 * (height+width)

For a PB Standard shipment, if you set an irregular parcel girth, then you must set the IS_RECTANGULAR shipment option to false in shipmentOptions.

Documents Object

Name

Data Type

Description

type

String

The type of document. Possible values:

  • SHIPPING_LABEL: Returns a shipping label.

  • QR_CODE: Returns a QR code that prints a PB Standard Returns label. Available for PB Standard Returns only.

  • MANIFEST: In the API response, this indicates that the returned document is an end-of-day manifest. This value applies only to the API response.

size

String

Conditional. The recommended size of the label. The actual size of a label depends on the carrier. This field is required if the type field is set to SHIPPING_LABEL.

For the valid values for your API call, see the Labels section of the carrier’s reference page. The field’s possible values are listed below, but see the carrier’s reference page for valid values:

  • DOC_4X4

  • DOC_4X5

  • DOC_4X6

  • DOC_4X8

  • DOC_6X4

  • DOC_8X11

  • DOC_9X4

contentType

String

Conditional. Determines whether the API returns the document as a URL or a Base64-encoded string. This field is required for PB Expedited (USPS), PB Standard, PB Presort, and PMOD. For PMOD, this field is optional if fileFormat is set to PDF.

For the valid values for your API operation, see the Labels section of the carrier’s reference page. The field’s possible values are:

  • URL: The response returns a link to the label or manifest.

  • BASE64: Available for shipping labels only (both delivery and return labels). The response returns the shipping label as one or more Base64-encoded strings. If you use an APAC URL, the field instead returns raw ZPL, as described in Label Settings for APAC Services.

fileFormat

String

Conditional. The file format for the document. This field is required if the type field is set to SHIPPING_LABEL or QR_CODE.

For the valid values for your API operation, see the Labels section of the carrier’s reference page. The field’s possible values are:

  • PDF

  • PNG. Available for shipping labels only (both delivery and return labels).

  • ZPL2. Available for shipping labels only (both delivery and return labels). ZPL2 uses the Unicode character set. If you have an older printer that does not support Unicode, see this troubleshooting topic.

  • GIF. Available for PB Standard Returns only. The documents.type field must be set to QR_CODE.

  • TIF. Available for PB Standard Delivery only. For restrictions, see Standard Delivery Label Options.

resolution

String

PB Expedited (USPS) & PB Standard Only. The label’s dots per inch (DPI). This field is not required. Unless you need to change the resolution, it is recommended you leave out this field and use the default resolution.

This field does not apply to PB Expedited 4X8 labels, PB Expedited COD labels, or PMOD labels. This field can take the following values, depending on the carrier, label settings, and other factors:

printDialogOption

String

Conditional. If fileFormat is set to PDF, you can use this field to embed a script that renders an interactive Print dialog box when the merchant opens the shipping label. This field is required for:

  • PB Expedited Returns

  • PB Standard Returns

  • Create CBDS Shipment, if the merchant uses a delivery solution that prints a label

The valid values are for this field are:

  • EMBED_PRINT_DIALOG: Embeds a script that renders a Print dialog box if fileFormat is set to PDF.

  • NO_PRINT_DIALOG: No print dialog box is rendered.

docTab

Array[Object]

4X8 Labels Only. In a Create Shipment request, this defines additional information to be printed on the 2-inch Doc Tab of a 4X8 label. For more information, see How do I print a Doc Tab label?

docTab.name

String

The field to be printed. This can be an existing field returned by the Create Shipment API or a custom field that you define. Each object in the docTab array must have a name value.

docTab.displayName

String

If docTab.name is set to a field returned by the Create Shipment API, this defines how the field name is displayed on the label.

For example, if you set the following:

{ "name": "parcelTrackingNumber", "displayName": "Tracking Number" }

The label will display:

Tracking Number: <parcelTrackingNumber>

where <parcelTrackingNumber> is the value of the parcelTrackingNumber field.

If you don’t define a displayName, the actual field name is used.

docTab.value

String

To display a field and value that are not returned by the Create Shipment API, enter the new name in the docTab.name field and enter the value here. For example:

{ "name": "DiscountCode", "value": "JUN40" }

contents

String

Response Only. When contentType is URL, this is the URL to access the label or manifest.

Note: The document is available for 24 hours after it is created.

pages

Array[Object]

Response Only, Shipping Labels Only. When contentType is BASE64, this array contains the pages in the shipping label. The array contains multiple objects if the label has multiple pages.

pages.contents

String

Contains the Base64-encoded string for a page in the shipping label.

customerData

Object

PB Standard Returns Only. This object is used to:

  • Print custom barcodes, which all PB Standard Returns merchants can do. See Custom Barcodes.

  • Perform custom functions, such as printing merchant information on labels or applying merchant business rules. Merchants must set up custom functions in advance with their PB implementation teams.

customerData.labelDetails

Array[Object]

The name-value pairs in this array pass the parameters and values used to print custom barcodes or to perform other custom functions.

customerData.labelDetails.name

String

The parameter.

customerData.labelDetails.value

String

The parameter’s value.

 

Manifest Object

Name

Data Type

Description

carrier

String

Required. The carrier to which the manifest applies. For some operations, this field is not present in the response.

Valid values:

  • USPS: PB Expedited or PMOD

  • PBCS: PB Standard

  • PBPresort: PB Presort

submissionDate

String

Required. The date the shipments are to be tendered to the carrier, entered as YYYY-MM-DD.

fromAddress

Address Object

Conditional. The shipment origin address.

Required for:

inductionPostalCode

String

Conditional. Postal code where the shipments are tendered to the carrier.

This field does not apply to PB Standard manifests.

parcelTrackingNumbers

Array[String]

Identifies shipments by their tracking numbers. List one or more tracking numbers, separated by commas. Enter each tracking number as a separate String.

If the carrier field is set to PBCS, use the long version of the tracking number.

parameters

Array[Object]

Conditional. Each object in the array defines a different manifest parameter. This field is used only in the request and is not returned in the response.

Required for PB Standard Manifests (Closeouts).

parameters.name

String

The name of the manifest parameter.

parameters.value

String

The value of the manifest parameter.

manifestId

String

RESPONSE ONLY. The unique manifest ID. This field is not returned for APAC Services.

This field is not returned for APAC Services.

manifestTrackingNumber

String

RESPONSE ONLY. The manifest tracking number. This is returned only if carrier has a value of USPS.

documents

Array[Documents Object]

RESPONSE ONLY. The manifest.

This field is not returned for a PB Standard manifest.

Manifest Parameters

In the Manifest Object, the parameters array can take the following options:

Parameter

Description

SHIPPER_ID

Adds shipments to a manifest by specifying the Shipper ID that was used to create the shipments. For the parameter value, specify the Shipper ID.

A merchant’s Shipper ID is found in the Merchant Object’s postalReportingNumber field.

MANIFEST_TYPE

Specifies the type of manifest.

Required if creating a PMOD manifest (PS Form 3152).

Valid values are:

  • NORMAL: For PB Expedited, PB Presort, and PMOD this creates the correct form for the carrier. This is the default setting for those carriers. The parameter can be left out of the API call.

  • PMOD: Creates a PS Form 3152 for PMOD shipments.

CLIENT_ID

PB Standard Only. The merchant’s unique PB Standard client ID assigned when the merchant onboarded with PB Standard.

Required for PB Standard manifest requests.

If testing an API operation in Sandbox, use the Sandbox value listed on the operation’s documentation page.

CARRIER_FACILITY_ID_<#>
where <#> is an integer from 1 to 5.

PB Standard Only. Each instance of this parameter specifies the ID of a PB Standard facility for which to close out all corresponding shipments. If this parameter is not specified, all shipments for all facilities are closed out.

To specify multiple facilities, create a separate object in the parameters array for each instance of this parameter, up to five objects. Start with CARRIER_FACILITY_ID_1 and increment by 1 up to CARRIER_FACILITY_ID_5. For example:

"parameters": [ {
    "name": "CARRIER_FACILITY_ID_1",
    "value": "1585"
},{
    "name": "CARRIER_FACILITY_ID_2",
    "value": "1234"
},{
    "name": "CARRIER_FACILITY_ID_3",
    "value": "6789"
}, ... ]

Important: To close out shipments associated with more than 5 facilities, issue the API call again.

To test this parameter in the Sandbox environment, include just one instance of this parameter and use the Sandbox value listed on the operation’s documentation page.

If you use just once instance of this parameter, specify the parameter as CARRIER_FACILITY_ID_1.

 

Merchant Object

The merchant object appears only in an API response.

Name

Data Type

Description

address

Internal use only. If this field is returned, it is set to null.

company

String

The merchant’s company.

deactivatedDate

String

For an inactive merchant, the date the merchant’s account was deactivated, returned in the ISO 8601 format.

For an active merchant, this field is null.

developerId

String

Your Pitney Bowes developer ID.

email

String

The merchant’s email address.

enterpriseAccount

String

An enterprise account number associated with the merchant.

fullName

String

The merchant’s full name.

merchantCarrierAccounts

Array[Object]

Merchants with Multiple Carriers Only. This array appears in the response of the merchant object only if the merchant has registered additional commercial carrier accounts, other than PB Standard or PB Presort. Each object in this array contains information on a specific carrier account.

merchantCarrierAccounts
.accountNumber

String

The merchant’s account number with the carrier.

merchantCarrierAccounts
.carrierName

String

The carrier. Possible values:

  • FEDEX

  • UPS

merchantCarrierAccounts
.deactivationDate

Number

If the merchant has removed the carrier account, this field is set to the date that the carrier account was removed.

If the carrier account is still active, this field is set to 0.

merchantCarrierAccounts
.isActive

Boolean

If true, the carrier account is active. If false, the merchant has removed the carrier account.

merchantCarrierAccounts
.isAuthorized

Boolean

If true, the APIs can generate labels with this carrier on behalf of the merchant. If false, the APIs cannot generate labels with the carrier for this merchant.

merchantCarrierAccounts
.merchantCarrierAccountAttributes

Array[Object]

Attributes that correspond to settings in the merchant’s carrier account. Each object in the array defines an attribute and its value.

merchantCarrierAccounts
.merchantCarrierAccountAttributes
.attributeName

String

The carrier account attribute.

merchantCarrierAccounts
.merchantCarrierAccountAttributes
.attributeValue

String

The value of the carrier account attribute.

merchantCarrierAccounts
.registrationDate

Number

The date the merchant’s carrier account was registered with Pitney Bowes, shown as milliseconds since the Unix Epoch.

merchantCarrierAccounts
.shipperCarrierAccountId

String

The unique identifier to use when the merchant performs an operation that uses this carrier account. The identifier is passed in the X-PB-Shipper-Carrier-AccountId request header of the API request.

merchantStatus

String

The merchant’s status. Possible values are:

  • ACTIVE

  • INACTIVE

merchantStatusReason

String

For an inactive merchant, the reason the merchant was deactivated.

For an active merchant, this field is null.

merchantType

String

Indicates the type of merchant:

paymentAccountNumber

String

The identifier for the PB Postage Account.

paymentServicesAccountId

String

A UUID that identifies the payment services account used to fund the merchant’s PB Postage Account. The payment services account has the merchant’s payment methods. A merchant can have one or more payment methods.

paymentServicesAccountIdActive

Boolean

If set to true, the merchant’s payment services account is active and can be used to fund postage.

postalReportingNumber

String

The unique ID used to identify the merchant.

Note: This value is also the merchant’s Shipper ID. You must specify Shipper ID when creating a shipment.

registeredDate

Number

The date the merchant’s account was created, shown as milliseconds since the Unix Epoch. You can convert the date to human-readable form by rounding from milliseconds to seconds and then using the Unix timestamp conversion algorithm, or by using a web site that converts milliseconds since the Epoch, such as https://currentmillis.com.

subscriptionAccount

String

Any subscription account that the merchant might have.

paymentMethod

String

When returned by the Authorize a Merchant API, this indicates the payment method for the merchant’s PB Postage Account. Possible values are:

  • LineOfCredit/Prepaid: PB Line of Credit

  • CreditCard: U.S. credit card

  • ACH: Automated Clearing House

paymentKey

String

Note

This field will be removed in 2022.

If the merchant uses ACH as the payment method, this returns the ACH payment key. Otherwise this field is null.

Parcel Object

Name

Data Type

Description

Weight

Weight Object

Required. The parcel’s weight and unit of measure.

Weight.weight

BigDecimal

Required. The parcel’s weight.

Weight.unitOfMeasurement

String

Required. The unit of measure. Valid values:

For USPS shipments, set this to OZ.

Valid values:

  • OZ: Ounces

  • GM: Grams

  • LB: Pounds. Available only for CBDS.

  • KG: Kilograms. Available only for CBDS.

dimension

Dimension Object

Conditional. Defines the parcel’s dimensions. For the order of dimensions, see the Dimension Object.

This field is recommended for all shipments. Entering accurate dimensions helps avoid additional fees or parcels being undelivered.

This field is required for the following shipments:

  • PB Expedited using the Parcel Select mail class or using a Soft Pack Envelope

  • PB Standard

  • PB Presort

valueOfGoods

BigDecimal

Notates the value of the parcel.

Important: This value is independent of any values entered for customs or special services. To declare a value for customs or a special service, you must declare the value in either the customs.customsInfo object or the rates.specialServices array.

currencyCode

String

ISO Currency Code. Use three uppercase letters, per ISO 4217. For example, for US Dollars use USD, for Canadian Dollars use CAD, and for Euros use EUR. For all currency codes, see https://www.iso.org/iso-4217-currency-codes.html.

 

Rates Object

Name

Data Type

Description

carrier

String

Required. Carrier name. Valid values are:

  • USPS: PB Expedited or PMOD

  • PBCS: PB Standard

  • PBPRESORT: PB Presort

  • PBI: PB Cross-Border Delivery Service (CBDS)

  • FEDEX: FedEx

  • UPS: United Parcel Service

serviceId

String

Conditional. The abbreviated name of the carrier-specific service. For abbreviations, see the Services table on the carrier’s reference page.

Required for creating a shipment. Optional for rating a parcel.

If you use PB Expedited as the carrier:

  • To determine any additional restrictions on a USPS service, use the Carrier Rules API. See also the USPS Domestic Mail Manual.

  • The APIs require that all USPS parcels be trackable. If the parcel uses a service that is not trackable, such as Priority Mail, you must add at least one trackable special service, such as Delivery Confirmation (DelCon). DelCon is a no-charge special service that triggers tracking but does not increase the cost of the shipment. Before adding a special service, check its compatibility with the service.

parcelType

String

Conditional. The parcel type. For supported parcel types, see the carrier’s reference page.

Required for:

  • Creating a shipment

  • Rating a FedEx or UPS parcel

Not applicable to the CBDS Checkout Quotes API.

specialServices

Array[Special Services Object]

Conditional. The special services to be applied. For available special services and requirements, see the Special Services table on the carrier’s reference page.

Important

In a Create Shipment request, including a special service in this array means you intend to apply the special service.

This array is not applicable to the CBDS Checkout Quotes API.

inductionPostalCode

String

The postal code where the shipment is tendered to the carrier. If this field is present, the postal code specified here is used instead of the postal code in the fromAddress when calculating rates and when determining if a shipment can be added to a manifest. If this field is absent, the postal code listed in the fromAddress is used instead.

This field applies to PB Expedited, PB Presort, PMOD, FedEx, and UPS.

currencyCode

String

Type of currency referenced in the piece price. For example: USD, CAD, EUR

This field applies to PB Expedited, CBDS, PMOD, FedEx, and UPS.

dimensionalWeight

Object

RESPONSE ONLY, PB Expedited Only. If dimensional (DIM) weight pricing applies, this object lists the DIM weight. If DIM weight does not apply, this object lists 0.0 as the weight. DIM weight applies to large light packages, as explained in this FAQ.

This field applies only to PB Expedited and only to the Create Shipment API. This field does not apply to the Rate Shipment API.

dimensionalWeight.weight

Double

The calculated DIM weight. To calculate DIM weight, see this FAQ.

dimensionalWeight.unitOfMeasurement

String

The unit of measure for the calculated DIM weight. Possible values:

  • GM: Grams

  • OZ: Ounces

baseCharge

Double

RESPONSE ONLY. The base service charge payable to the carrier, excluding special service charges.

If your request includes a shipper rate plan, see this FAQ on how the shipper rate affects this field.

Note: This field does not apply to PB Standard.

totalCarrierCharge

Double

RESPONSE ONLY. The total amount payable to the carrier, including special service fees, surcharges, and any international taxes and duties, except as noted below.

If your request includes a shipper rate plan, see this FAQ on how the shipper rate affects this field.

CBDS: In certain cases, the totalCarrierCharge might not reflect additional surcharges.

UPS: In Sandbox, the data UPS supplies for totalCarrierCharge might be incorrect. Specifically it might be 1% too low or exclude special service fees, or both. In Production, UPS provides the correct data.

Note: This field does not apply to PB Standard.

surcharges

Array[Object]

RESPONSE ONLY. Additional fees or surcharges for the shipment. Each object in the array defines a surcharge and fee.

This field applies to PB Expedited, FedEx, and UPS.

surcharges.name

String

The type of surcharge. For possible surcharges, see the carrier’s reference page.

surcharges.fee

Double

The amount of the surcharge.

alternateBaseCharge

Double

RESPONSE ONLY. If your request includes a shipper rate plan and if the shipper does not have an NSA, this is the base service charge payable by the shipper, excluding special service charges. The rate is based on the plan specified in the X-PB-Shipper-Rate-Plan parameter. This field can be returned only if carrier has a value of USPS.

If the shipper has an NSA, do not use this field. Use the response’s baseCharge field instead. For more information, see this FAQ.

alternateTotalCharge

Double

RESPONSE ONLY. If your request includes a shipper rate plan and if the shipper does not have an NSA, this is the total charge payable by the shipper, including special service charges. The rate is based on the plan specified in the X-PB-Shipper-Rate-Plan parameter. This field can be returned only if carrier has a value of USPS.

If the shipper has an NSA, do not use this field. Use the response’s totalCarrierCharge field instead. For more information, see this FAQ.

deliveryCommitment

Object

RESPONSE ONLY. Time in transit for the shipment. For PB Expedited, see also Pitney Bowes Delivery Guarantee.

Note: This field does not apply to PB Standard.

deliveryCommitment.minEstimatedNumberOfDays

String

The minimum number of delivery days.

deliveryCommitment.maxEstimatedNumberOfDays

String

The maximum number of delivery days.

deliveryCommitment.estimatedDeliveryDateTime

String

The estimated delivery date and time in the local time of the destination.

deliveryCommitment.guarantee

String

States whether carrier delivery is guaranteed. Possible values:

  • FULL

  • NONE

deliveryCommitment.additionalDetails

String

These are carrier specific details that may be provided.

destinationZone

String

RESPONSE ONLY. The destination zone used to determine the rate. The zone is based on the origin address or CBDS Consolidation Center, and on the destination address.

This field applies to PB Expedited, CBDS, and PMOD.

Note: For CBDS shipments, destinationZone is returned as a Number.

rateTypeId

String

RESPONSE ONLY. The type of rate, such as COMMERCIAL_BASE (USPS) or COMMERCIAL (FedEx, UPS).

linePrice

BigDecimal

RESPONSE ONLY. The unit price multiplied by quantity. This field applies to CBDS.

totalTaxAmount

BigDecimal

RESPONSE ONLY. The total tax amount payable to the carrier. This field applies to CBDS, FedEx, and UPS.

totalDutyAmount

BigDecimal

RESPONSE ONLY. The total duty amount payable to the carrier. This field applies to CBDS.

 

Shipment Object

Name

Data Type

Description

fromAddress

Address Object

Required. Origin address.

If you want a different address to appear on the label from the one listed here, see How do I print a return address that is different from the origin address?

toAddress

Address Object

Required. Destination address.

FedEx, UPS: If you are shipping with FedEx or UPS to Puerto Rico or an international destination, and if the importer is different from the final recipient, this is the address of the importer. Enter the recipient’s address in the soldToAddress object. If importer’s address is the same as the final recipient, the toAddress and soldToAddress must match.

altReturnAddress

Address Object

PB Expedited, CBDS Only. Applies as follows:

  • PB Expedited: If you are sending an international shipment and if you have set the NON_DELIVERY_OPTION shipment option to redirect, then enter the address that a returned parcel should go to.

  • CBDS: For a Create Shipment request, this is the address used to return a parcel from the CBDS Consolidation Center. If omitted, the fromAddress is used. The altReturnAddress is not returned in the response.

parcel

Parcel Object

Required. Contains physical characteristics of the parcel.

rates

Array[Rates Object]

Required. Specifies the carrier, service, parcel, and other information. In a response, this field also contains the service charges.

Important: In a request, the rates array can contain only one rates object.

documents

Array[Documents Object]

Conditional. Defines the label, manifest, or other shipping document created by the API call. In a response, this array provides the URL or Base64 string for a document and in some cases can contain multiple objects.

This field is required, except in the following cases:

  • This field does not apply to Rate Parcel requests.

  • This field does not apply to the Create CBDS Shipment request if the merchant prints the first-label prior to invoking the API.

shipmentOptions

Array[Object]

Required. Each object in this array defines a shipment option. Specify each option as a name-value pair in the array.

The SHIPPER_ID option is required. For additional requirements for a carrier, see the Considerations section on the carrier’s Create Shipment page.

shipmentOptions.name

String

The name of the shipment option.

shipmentOptions.value

String

The value of the shipment option.

customs

Object

Conditional. For shipments that use customs forms, this object contains the customs information. This field is required for the following carriers in the following situations:

  • PB Expedited: Required for shipments to international destinations. Conditional for shipments to APO/FPO/DPO, U.S. Territories, and FAS, as explained in this FAQ.

  • CBDS: Required for all shipments.

  • FedEx: Required for shipments to international destinations and Puerto Rico.

  • UPS: Required for shipments to international destinations and Puerto Rico.

customs.customsInfo

Customs Info Object

Customs clearance information for the commercial invoice. When using the Customs Info Object, make sure to include the fields marked Required.

customs.customsItems

Array[Customs Items Object]

Customs clearance information for each commodity. When using the Customs Items Object, make sure to include the fields marked Required.

The maximum number of objects in this array is 30.

domesticShipmentDetails

Domestic Shipment Details Object

CBDS Only. Required if the merchant prints the first-mile label prior to invoking the Create CBDS Shipment API. This object contains information about the first-mile leg of the shipment.

soldToAddress

Address Object

FedEx, UPS Only. The final recipient of a the shipment. Required for a shipment from the U.S. to Puerto Rico or to an international destination. Otherwise optional.

This address must match the toAddress.countryCode, with the exception of shipments to Canada and to U.S. satellite countries.

If the final recipient’s address is the same as the importer’s address, the entries in the soldToAddress object must match the entries in the toAddress object.

shipmentType

String

Return Labels Only. Set this to RETURN. Required for Rate Expedited Returns, Create Expedited Returns, and Create Standard Returns. Note: You cannot rate Standard Returns.

references

Array[Object]

PB Standard, CBDS Only. Conditional. The merchant’s reference fields. Each object in the array includes a name-value pair that defines a reference field. This array applies only to the following two carriers:

To pass references for carriers other than the above, see Reference Fields.

references.name

String

PB Standard, CBDS Only. The name of the reference field.

references.value

String

PB Standard, CBDS Only. The value for the reference field.

hazmatDetails

Hazmat Details Object

PB Standard Only. If shipping hazardous materials with PB Standard, use this object.

shipmentId

String

RESPONSE ONLY. Unique identifier for the shipment, generated by the system in response to shipment purchase.

parcelTrackingNumber

String

RESPONSE ONLY. Tracking number assigned to the shipment by the system.

 

Special Services Object

Name

Data Type

Description

specialServiceId

String

Required. The abbreviated name of the special service to be applied. For abbreviations, see the Special Services table on the carrier’s reference page.

Important

Do not include a special service unless you intend to apply it.

inputParameters

Array[Object]

Conditional. The parameters to set for the special service, such as an insurance value or a receipt-number format. This is required if the special service requires input parameters. If a special service does not require input parameters, you can either leave out the array or pass an empty array.

To determine the available parameters for a special service, see the instructions for your carrier:

inputParameters.name

String

The name of the input parameter. This field is required in the inputParameters array.

For PB Expedited, this maps to the inputParameterRules.name field in the Carrier Rules API.

inputParameters.value

String

The value of the parameter. This field is required in the inputParameters array.

For PB Expedited, the possible values are listed in the inputParameterRules array in the Carrier Rules API.

fee

Double

RESPONSE ONLY. The amount of fee expressed in the currency of the origin country.

 

Transaction Object

The transaction object appears only in an API response.

Name

Data Type

Description

transactionId

String

The ID used to uniquely identify the shipment associated with the transaction. The ID is a combination of the developer ID and the shipment’s X-PB-TransactionId, separated by an underscore (_):

<Developer-ID>_<X-PB-TransactionId>

transactionDateTime

String

The date and time of the transaction, returned in UTC/GMT using the ISO 8601 standard.

transactionType

String

Type of transaction. Valid values:

  • POSTAGE FUND: The funding of a postage account.

  • POSTAGE PRINT: The printing of a label.

  • POSTAGE REFUND: A refund request or the resolution of a refund request.

  • FEE: An ACH return fee. The status field indicates whether the fee is processed or waived.

  • APV-POSTAGE OVERPAID: An APV adjustment for overpayment.

  • APV-POSTAGE UNDERPAID: An APV adjustment for underpayment.

  • APV-DISPUTE ADJUSTMENT: A dispute of an APV-POSTAGE UNDERPAID transaction.

  • CREDIT ADJUSTMENT: A manual credit.

  • DEBIT ADJUSTMENT: A manual debit.

developerName

String

Name of the developer account used to print the shipment label.

developerId

String

The developer ID used to print the shipment label.

developerPostagePaymentMethod

String

The developer’s PB Postage Account payment method. This is populated only for transactions that use the Bulk Postage Account payment model, as described in Merchant Enrollment Models.

developerRatePlan

String

Rate plan of the developer.

developerRateAmount

String

Amount charged to the developer. The amount is based on the developer’s rate plan. If the merchant (shipper) has an NSA, the amount is instead based on the NSA.

APV Adjustments: If the transaction is an APV adjustment, this field is the difference between the charge that was calculated at the time of print and the charge calculated by USPS®.

developerPostagePaymentAccountBalance

String

This field is not currently used.

merchantName

String

Name of the merchant.

merchantId

String

The value of the postalReportingNumber field in the Merchant object. This value is also the merchant’s Shipper ID.

merchantPostageAccountPaymentMethod

String

The merchant’s PB Postage Account payment method. This is populated only for transactions that use the Individual Postage Account payment model, as described in Merchant Enrollment Models.

merchantRatePlan

String

Rate plan of the merchant (shipper).

merchantRate

String

Amount charged to the merchant. This is based on the merchant’s shipper rate plan.

APV Adjustments: If the transaction is an APV adjustment, this field is the difference between the charge to the merchant calculated at the time of print and the charge calculated based on information from USPS.

shipperPostagePaymentAccountBalance

String

Postage balance in the merchant’s PB Postage Account. This is the ending balance after this transaction was processed.

If the merchant’s postage balance is currently negative, the merchant must refill the postage account. See How do I fill my PB Postage Account with funds?

labelFee

String

Currently not used.

parcelTrackingNumber

String

Tracking number.

weightInOunces

String

Weight in ounces. In the case of an APV adjustment, this is based on the new information received from USPS.

zone

String

Zone. In the case of an APV adjustment this is based on the new information received from USPS.

packageLengthInInches

String

Package length in inches. In the case of an APV adjustment, this is based on the new information received from USPS.

packageWidthInInches

String

Package width in inches. In the case of an APV adjustment, this is based on the new information received from USPS.

packageHeightInInches

String

Package height in inches. In the case of an APV adjustment, this is based on the new information received from USPS.

packageTypeIndicator

String

Indicates whether cubic pricing was used. Valid values:

  • Cubic

  • NonCubic

In the case of an APV adjustment, this is based on the new information received from USPS.

packageType

String

The parcel type. For supported parcel types, see the carrier’s reference page.

In the case of an APV adjustment, this is based on the new information received from USPS.

mailClass

String

Mail class or service.

internationalCountryGroup

String

International country group code.

originationAddress

String

Origination address.

originZip

String

Origin postal code.

destinationAddress

String

Destination address.

destinationZip

String

Destination postal code.

destinationCountry

String

Destination country.

postageDepositAmount

String

Postage deposit amount.

creditCardFee

String

Credit card fee.

refundStatus

String

Refund status. Possible values include:

  • REQUESTED

  • ACCEPTED

  • DENIED

For more information on refunds, see Refunds FAQs.

refundDenialReason

String

The reason for a refund denial.

printStatus

String

For a PB Expedited Returns label, the label’s status. Possible values:

  • Printed: The label has been printed but not used.

  • Charged: The label has been used.

Note: This information also appears in the status field.

shipmentId

String

The unique identifier for the shipment generated when the shipment was created.

refundRequestor

String

Indicates who requested the refund.

  • Shipper Requested: The shipper requested the refund.

  • PB Claims: The request is part of the Delivery Guarantee program.

externalId

String

Applies only to the following:

  • APV adjustments: The USPS Revenue Assurance ID assigned to the APV adjustment in case of a dispute.

  • PB Delivery Guarantee: This is an ID beginning with “PBD” and followed by sequence of numbers. This indicates a Delivery Guarantee credit.

adjustmentReason

String

APV Only. The reason for an APV adjustment, based on information received from USPS. Possible values are:

  • weight. Incorrect weight listed when creating the label.

  • dimension: Incorrect dimensions listed when creating the label.

  • package: Incorrect parcel type listed when creating the label.

  • zone: Incorrect origin or induction postal code listed when creating the label.

  • duplicate: The label had already been inducted. The IMpb tracking barcode was entered into the USPS mailstream more than once within 120 days. The transaction report includes the charges for the additional use of the label.

  • usedRefundedLabel: The label was a refunded label that was then entered into the USPS mailstream. The transaction report includes the charges for using the label after having voided it.

meterNumber

String

Internal identification number for the postage meter that was used.

dimensionalWeightOz

BigDecimal

The dimensional weight, if applicable.

To return this field, set the shipDetails query parameter to 1.

valueOfGoods

BigDecimal

The value provided in the parcel.valueOfGoods field in the Create Shipment request, if applicable.

To return this field, set the shipDetails query parameter to 1.

specialServices

Array[Special Services Object]

This array contains the shipment’s special services, including the fee paid for each service.

To return this field, set the shipDetails query parameter to 1.

status

String

The transaction status for the following types of transactions:

  • ACH transaction. Possible values:

    • Pending: A POSTAGE FUND transaction is pending.

    • Processed: Either a POSTAGE FUND or a FEE transaction has been processed.

    • Returned: A POSTAGE FUND transaction failed.

    • Waived: A FEE has been waived.

  • APV dispute. Possible values:

    • REQUESTED

    • ACCEPTED

    • DENIED

  • PB Expedited Returns label. Possible values:

    • Printed

    • Charged

description

String

Details on the status of an ACH transaction. Possible values:

  • Postage Fund Pending: A POSTAGE FUND transaction is pending.

  • Postage Fund Processed: A POSTAGE FUND transaction has been processed.

  • Postage Fund Returned: A POSTAGE FUND transaction failed.

  • ACH Return Fee Processed: A FEE has been processed.

  • ACH Return Fee waived: A FEE has been waived.

clientFacilityId

String

For a PB Standard transaction, this is the ID that was assigned to the merchant’s facility during onboarding with PB Standard.

carrierFacilityId

String

For a PB Standard transaction, this is the ID of the PB Standard facility that was assigned to the merchant during onboarding with PB Standard.

inductionPostalCode

BigDecimal

The postal code where the shipment was tendered to the carrier.

To return this field, set the shipDetails query parameter to 1.

tracking

Object

For a POSTAGE PRINT transaction, this object returns the most recent tracking event within 30 days of the transaction’s date and time. To return this object, include the trackingStatus query parameter in the request.

Note: This object is not returned by the Get Archived Reports API.

tracking.parcelStatus

String

The most recent tracking event within 30 days of the parcel’s ship date. This is the same information returned in the status field of the Tracking API.

Note: Transaction Reports record tracking status only for the first 30 days after the parcel’s ship date.

tracking.statusDate

String

The local date and time where the tracking event occurred. This is the same information returned in updatedDate and updatedTime in the Tracking API.

customMessage1

String

The message specified in the PRINT_CUSTOM_MESSAGE_1 shipment option in the Create Shipment request.

To return this field, set the shipDetails query parameter to 1.

customMessage2

String

The message specified in the PRINT_CUSTOM_MESSAGE_2 shipment option in the Create Shipment request.

To return this field, set the shipDetails query parameter to 1.