Release Notes

Released on 2021-11-14

Released on 2021-11-01

  • The merchant object has two new fields: paymentServicesAccountId, which indicates the payment services account used to fund postage, and paymentServicesAccountIdActive, which indicates whether the payment services account is active. The merchant object is returned when retrieving merchant information and when registering or authorizing a merchant.

    As a result of this change, the paymentKey will be removed in 2022.

Released on 2021-10-23

  • PB Standard Delivery 4X5 labels can now use the TIF format. See Standard Delivery Label Options.

  • The Tracking API now uses the value PBCS to indicate PB Standard as the carrier service. For backward compatibility, the API still accepts the deprecated value NEWGISTICS.

Released on 2021-10-03

Released on 2021-09-15

  • The APIs now use the value PBCS to indicate PB Standard as the carrier service. For backward compatibility, the APIs still accept the deprecated value NEWGISTICS.

Released on 2021-09-03

Released on 2021-08-27

  • UPDATED 2021-12-06: The carrier query parameter is now optional in the Track a Package API, except for PB Standard Returns labels. PB Standard Returns labels require the carrier query parameter.

Released on 2021-08-20

Released on 2021-08-01

Developer Hub uses the following new URLs:

Released on 2021-07-15

  • FedEx 4X6 labels can now use the ZPL2 and PNG formats. For all options, FedEx Labels.

  • UPS 4X6 labels can now use the ZPL2 and GIF formats. For all options, UPS Labels.

Released on 2021-07-01

Released on 2021-06-19

Released on 2021-06-19

Pitney Bowes has added the customs.customsInfo.importerCustomsReferenceType field to support the European Union (EU) rules that went into effect July 2021 requiring that shipments to the EU include a VAT (Value Added Tax) number or IOSS number. Use this field in combination with the customs.customsInfo.importerCustomsReference field to specify the VAT or IOSS number. Enter the following:

  • importerCustomsReference: Enter the VAT or IOSS number.

  • importerCustomsReferenceType: Enter one of the following values to specify which type of number you entered:

    • VAT_NUMBER

    • IOSS_NUMBER

Released on 2021-06-15: New Base URLs

The subdomain portion of all base URLs has changed and is now prepended with “shipping-”. Update your code and check with your IT team to ensure site-specific SSL certificate stores are updated. For questions about the change, contact us at ClientSupportTechServices@pb.com.

Base URLS for Core APIs & Account APIs:

Production

https://shipping-api.pitneybowes.com/shippingservices/<resource-path>

Sandbox

https://shipping-api-sandbox.pitneybowes.com/shippingservices/<resource-path>


Base URLS for the OAuth Token API:

Production

https://shipping-api.pitneybowes.com/oauth/token

Sandbox

https://shipping-api-sandbox.pitneybowes.com/oauth/token

Note

Each operation’s resource path remains the same. For example, for Address Validation, the resource path of /v1/addresses/verify remains the same.

Released on 2021-06-08

Released on 2021-06-01

Released on 2021-05-22

  • The Tracking API provides additional status information, including event descriptions targeted specifically to buyers or sellers.

  • The Transaction Reports API now queries on transaction status through the new printStatus query parameter.

Released on 2021-05-01

Released on 2021-04-15

  • The Intelligent Mail Indicia (IMI) on the upper right corner of USPS labels uses IMI-Standard (IMI-STD) instead of IMI-Minimum (IMI-MIN). The following comparison shows an example IMI-STD and an example IMI-MIN:

    IMI Comparison

Released on 2021-03-31

Released on 2021-03-02

Released on 2021-02-26

  • The Pickup API now includes the pickupSummary.returnShipment field to indicate the pickup includes a return shipment.

Released on 2021-02-20

Released on 2021-02-04

Released on 2021-02-01

  • The merchant signup URL can now pre-populate the Merchant Portal signup form with the merchant’s name, address, and other information. To pre-populate the form, use these parameters.

Released on 2021-01-29

  • The documentation now combines carrier information for PB Expedited and PB Standard onto one Pitney Bowes carrier page.

Released on 2021-01-27

  • The Create a Container Label provides the submissionDate field for including all shipments that have been manifested up to the specified shipment date.

Released on 2021-01-24

  • USPS price changes.

Released on 2021-01-09

  • The Create SCAN Form API now ignores empty Strings in the parcelTrackingNumbers array and prints the SCAN form without throwing an error.

  • The new USPS rounding rules went into effect January 9, 2021. USPS rounds dimensions to 2 decimal places (e.g. 0.12) instead of 3 decimal places (e.g. 0.123) when determining price and rates.

Released on 2021-01-04

  • The Create a Container Label provides the PACKAGE_COUNT parameter for entering the number of parcels in the container.

Released in 2020

  • Released on 2020-10-18

    • The new HS Code API predicts the HS code for a parcel being shipped internationally and gives the level of confidence in the prediction.

    • The new Archived Transactions API obtains transaction data older than six months.

  • Released on 2020-10-14

    • The Rates API returns rates for PB Standard Delivery parcels.

    • PB Standard Returns labels now print custom logos and print additional sizes and formats.

  • Released on 2020-09-20

    • The trackingStatus query parameter in the Transaction Reports API can now take a value of ALL to return all tracking statuses.

  • Released on 2020-09-10

  • Released on 2020-08-30

    • Get Transaction Reports now query on tracking status through the trackingStatus query parameter and now return the most recent tracking event within 30 days of the parcel’s ship date. Transaction Reports also now return the induction postal code.

  • Released on 2020-08-26

    • USPS has retired the Scan-Based Return (SBR) program. In its place, merchants can use PB Expedited Returns. Cubic rates and flat-rate packaging are now available for PB Expedited Returns.

  • Released on 2020-08-24

    • The CBDS California and Kentucky Consolidation Centers now ship Standard DDP (PBXPS) to additional countries.

  • Released on 2020-08-08

    • Void a Shipment no longer requires a request body. The API provides query parameters for passing all values. You can still pass values through a request body, but using query parameters is recommended.

  • Released on 2020-07-18

    • The USPS Automated Package Verification system, which supports adjustments for weight, dimensions, zone, and packaging, has expanded the coverage to include “Duplicate” and “Used Refunded” labels. As a result, the Get Transaction Reports API will return two new values in the adjustmentReason field: duplicate and usedRefundedLabel

    • USPS no longer supports E-DELCON to the countries listed here. For more information on E-DELCON, see this FAQ.

  • Released on 2020-07-01

    • The Add Tracking Events API allows merchants, carriers, and other parcel handlers to record tracking events for shipments. The API supports adding multiple events to multiple shipments in a single request.

    • USPS has deprecated the “Return Receipt for Merchandise” (RRM) special service.

  • Released on 2020-06-30

  • Released on 2020-06-18

    • The Transaction Reports API does not provide information for transactions that were created more than six months ago. To retrieve older transactions, use the Archived Transactions API.

  • Released on 2020-06-10

  • Released on 2020-05-19

  • Released on 2020-05-16

  • Released on 2020-04-15

    • When you print an IMb label for an FCM letter or flat, Pitney Bowes now creates a “Label created” tracking event.

  • Released on 2020-04-11

    Released on 2020-04-06

  • Released on 2020-03-31

    • Canadian destinations only: CBDS supports shipment to Canada of ID8000 commodities. For details, see this FAQ.

  • Released on 2020-03-07

  • Released on 2020-02-23

  • Released on 2020-02-15

  • Released on 2020-02-12

    • The X-PB-Shipper-Carrier-AccountId request header is now conditional. The header is required only if the merchant has multiple accounts with a carrier. If the merchant has only one account with the carrier, the header is not required. For more information on carrier accounts, see Add Carrier Accounts.

  • Released on 2020-01-18

    • USPS price changes are in effect for shipments with a ship date of January 26, 2020 or later.

  • Released on 2020-01-14

    • The Tracking API tracks PB Standard parcels using the carrier query parameter. The API reports both PB Standard and USPS tracking events.

    • If you onboard merchants through Merchant Portal and retrieve account details through the Merchant Authorization API, you can now use the optional paymentMethod query parameter to specify which payment methods to make available.

  • Released on 2020-01-04

    • Merchants can now print PB Presort Labels for U.S. Territories, U.S. Possessions, and Freely Associated States. This is in addition to previous support for APO/FPO/DPO. Customs forms are not required.

Released in 2019

  • Released on 2019-12-05

  • Released on 2019-11-14

  • Released on 2019-10-30

  • Released on 2019-10-24

    • PB Standard shipments can use 4X4 labels. See PB Standard Labels.

    • USPS 4X6 domestic labels can use 300 DPI. See the resolution field in the Documents Object.

    • A merchant’s PB Postage Account can have a negative account balance in certain circumstances (such as after an APV transaction). In such cases, the merchant will not be able to print a label until the postage account is refilled.

  • Released on 2019-10-04

  • Released on 2019-10-03

    • The Transaction Reports API returns CREDIT ADJUSTMENT and DEBIT ADJUSTMENT transactions to indicate manual adjustments to postage accounts.

  • Released on 2019-10-01

  • Released on 2019-09-30

    • If a merchant has multiple carriers, the Get Merchant Accounts API now returns information on the merchant’s carrier accounts.

  • Released on 2019-09-07

    • PB Presort labels for Standard Mail flats can now include human-readable tracking information. See the PRINT_IMBREADABLE_BARCODE shipment option.

    • PB Presort labels for flats can now print an Electronic Service Requested endorsement. See the NON_DELIVERY_OPTION shipment option.

    • PB Presort labels for flats can now print a custom message. See the PRINT_CUSTOM_MESSAGE_1 shipment option.

  • Released on 2019-07-27

    • You can now set the DPI of a PB Standard Delivery label using the documents.resolution field. See Documents Object.

  • Released on 2019-07-25

    • ACH is now available on request as a payment method for a merchant’s PB Postage Account.

  • Released on 2019-07-17

  • Released on 2019-07-11

    • If you use the Authorize a Merchant API to enroll merchants, you can now use a referral code to identify who referred a merchant to your software.

  • Released on 2019-07-09

  • Released on 2019-06-15

    • USPS rule changes are in effect for shipments with a ship date of June 23, 2019 or later.

    • The Create PMOD Shipments API includes two new PMOD options for specifying NASS code and destination entry facility.

  • Released on 2019-06-07

    • The Parcel Protection APIs (deprecated) let you void coverage and request reports. Note: Parcel Protection is deprecated.

  • Released on 2019-06-06

  • Released on 2019-06-01

    • UPS (United Parcel Service) integration. You can now integrate a merchant’s existing UPS® account with the APIs. Merchants use existing API operations to print and track UPS labels. The APIs provide the following new operations for integrating a merchant’s UPS account: Add a Carrier Account, Get Carrier License Agreement.

    • Shipping to APO/FPO/DPO destinations using the Bound Printed Matter (BPM) service is now supported. Parcels ship using the PKG parcel type and the PB Presort carrier service.

  • Released on 2019-05-21

    • The Parcel Protection APIs (deprecated) let you request quotes and obtain coverage. Note: Parcel Protection is deprecated.

  • Released on 2019-05-13

    • The v4.0 Transaction Reports API now returns information within the hour for POSTAGE FUND transactions.

    • In the v4.0 Transaction Reports API, the new shipDetails query parameter lets you choose whether to return the following fields for each transaction:

      • dimensionalWeightOz

      • valueOfGoods

      • specialServices

      • customMessage1

      • customMessage2

  • Released on 2019-04-20

    • The new version (v4.0) of the Transaction Reports API returns information within the hour for the following:

      • POSTAGE PRINT transactions

      • POSTAGE REFUND requests

        Note that the resolution of a refund request is returned the same day that USPS approves or denies the refund.

      The API now also returns additional information about transactions. For more information, please see Transaction Reports.

  • Released on 2019-04-05

    • An issue with refund requests made between April 3 to 5, 2019, has been corrected. The issue had caused all refunds for those dates to be rejected. The issue is corrected, and all refunds requested on those dates have been resubmitted.

  • Released on 2019-03-16

  • Released on 2019-02-19

    • Pitney Bowes automatically credits and debits prepaid postage accounts with APV adjustments made by USPS. Pitney Bowes applies adjustments made by USPS February 1st and later.

      To view APV adjustments, use the Transaction Reports API.

  • Released on 2019-02-09

    • Improved error messages for address validation: In case of an incomplete or undeliverable address, the additionalInfo field in the error object now provides a reason for the address validation failure. This applies to the Address Validation and Create Shipment APIs. As an example, if an address contains an unrecognized street name, the APIs now return the following error:

      {
    "errorCode": "1019003",
    "errorDescription": "Either Invalid or missing street or stateProvince or postalcode ",
    "additionalInfo": "E411 - The street cannot be found in this locality.",
}

  • Released on 2019-02-01

    • Merchants can now use the Refill API to add funds to their PB Postage Accounts. Previously, merchants could perform refills only through the Merchant Portal.

  • Released on 2019-01-29

    • To bolster security of the APIs, Pitney Bowes made a change to deserialize incoming requests. This may introduce some request failures as the APIs now enforce a stricter validation when unexpected fields or values are present in the request body. In order to avoid failed requests, please follow the specifications for each request in this documentation.

  • Released on 2019-01-27

    • USPS price changes.

    • The APIs now provide the option to use a standard error format for all errors encountered. To use the standard format, you must set the X-PB-UnifiedErrorStructure header to true with each API call. Without the header, the APIs use multiple formats. For more information, see Error Object.

Released in 2018

  • Released on 2018-11-22

    • CN 22 and CP 72 customs forms now accommodate more characters in the To and From address blocks by allowing lower-case characters. Previously, Pitney Bowes had converted all characters in the blocks to CAPS. Now Pitney Bowes prints the characters as typed by the merchant, whether lower or upper case. Note that Pitney Bowes still converts state and country to caps, per USPS rules.

  • Released on 2018-10-27

    • You can specify the DPI for PNG shipping labels using the documents.resolution field. See Documents Object.

    • For PB Standard shipments, you can now print 4X5 labels, in addition to 4X6 labels.

  • Released on 2018-09-29

  • Released on 2018-09-06

    • As part of enhanced payment security, the Merchant Signup API (deprecated) requires an access token.

  • Released on 2018-08-23

    • The minimum supported security protocol for connection to the APIs is TLS v1.2.

  • Released on 2018-08-17

    • You can now map client-generated identifiers to fields in the PB Standard package record. Use the new references field when creating PB Standard Delivery shipments. This applies only to PB Standard shipments.

    • The APIs offer Parcel Protection. Note: Parcel Protection is deprecated.

  • Released on 2018-07-29

  • Released on 2018-06-15

    • Merchants can now use the APIs to print USPS-compliant PB Standard labels.

    • Merchants can now print PB Presort Labels for the following services: Bound Printed Matter (BPM), Standard Mail (STANDARD).

  • Released on 2018-05-26

    • The Rates and Shipment APIs now determine the best rate for a soft pack by looking at weight-based pricing, 2-dimensional cubic pricing, and 3-dimensional cubic pricing. Note: 3-dimensional cubic pricing is deprecated.

  • Released on 2018-05-11

    • The Get Transaction Reports API supports the following new query values:

      • The transactionType query parameter can now use APV-POSTAGE ALL to return all APV adjustments, both overpaid and underpaid.

      • The printStatus query parameter can return all SBR labels (deprecated). Note: USPS has retired the SBR program.

  • Released on 2018-04-19

    • Additional validations are now made on the merchant contact information sent through the Merchant Signup API (deprecated) and Register a Merchant API. A merchant’s address cannot contain a P.O. Box, and a merchant’s phone number must be valid. The validation changes meet USPS compliance requirements.

  • Released on 2018-03-09

    • The new Get Account Balances API retrieves the current balances for a PB Postage Account and PB Line of Credit.

  • Released on 2018-02-20

  • Released on 2018-01-21

    • USPS price changes.

    • Registered Mail (Reg) and Registered Mail with Insurance (RegIns) are no longer available with Priority Mail Padded Flat Rate Envelopes (PFRENV).

    • First-Class Mail International (FCMI) shipments may contain only documents, not goods. When using FCMI, you must set the customs object’s reasonForExport field to DOCUMENTS. Goods that were formerly shipped via FCMI are eligible to be shipped via First-Class Package International Service (FCPIS) and other services.

  • Released on 2018-01-07

Released in 2017

  • Released on 2017-09-16

  • Released on 2017-08-26

    • The Merchant Signup API (deprecated) allows merchants to sign up for their own PB Postage Accounts directly within your application.

    • The Create Shipment API now generates a single-ply customs declaration form for shipments to APO/FPO/DPO destinations and to participating countries. As of this writing, the following countries participate: Australia, Canada, and Costa Rica. For more information on customs forms, see this FAQ.

    • This feature is no longer supported. Pitney Bowes offers an Auto Refund service that submits unused, prepaid labels for electronic refund on your behalf.

  • Released on 2017-07-22

    • The new Pickups API allows merchants to schedule carrier pickups and, when necessary, to cancel previously scheduled pickups.

    • The Rate Parcel and Create Shipment APIs now support printing a First-Class Letter with an Intelligent Mail barcode (IMb). For details, see this FAQ on IMb.

    • The Rate Parcel and Create Shipment APIs now support the Soft Pack (SOFTPACK) parcel type. Soft packs are flexible packages that adhere and conform to the contents being packaged, in order to take up minimum cubic space.

  • Released on 2017-07-09

    • USPS Scan-Based Return (SBR) labels (deprecated). Note: USPS has retired the SBR program.

    • The new Suggest Addresses API provides address suggestions, when they’re available. The response can contain up to 20 suggestions. Results are not sorted by priority.

      Note: The Validate an Address API has not changed.

    • The new Get Carrier Rules API retrieves USPS rules for domestic and international shipments. The rules provide information on weight/dimension constraints and on service compatibility.

    • When using the Rate Parcel API, you can now leave out the parcelType, serviceId, or both, allowing merchants to find rates for multiple parcel types and services with one call. You can also specify special services in the rate request and obtain the special service fee in the response.

    • The Rate Parcel and Create Shipment APIs support two new parcel types with Priority Mail International (PMI):

      • DVD Flat Rate Box (DVDBOX)

      • Large Video Flat Rate Box (VIDEOBOX)

  • Released on 2017-06-10

    • The Parcel Object, which is used in the Create Shipment and Rate Parcel APIs, now includes two new fields for specifying the value of the parcel: valueOfGoods and currencyCode.

      Note: valueOfGoods is independent of the insured, COD, and customs values. If you add insurance or COD as a special service, you still must define the associated INPUT_VALUE in the rates.specialServices array. If you create an international shipment, you still must declare the customs value in the customsDeclaredValue field in the customs.customsInfo object.

    • The Create Shipment API now automatically reassigns values in the parcel.dimension object to ensure length is the longest dimension, followed by height, followed by width.

    • The Create Shipment API now generates customs forms for U.S. territories, possessions, and Freely Associated States. Hence, Create Shipment now requires customs data for shipments to U.S. territories (except VI & PR), U.S. possessions, and Freely Associated States, in accordance with USPS rules.

    • The Create Shipment API now returns an error if the declared value for customs exceeds $400 for either of the following two services: First-Class Mail International, First-Class Package International Service. This follows USPS rules.

  • Released on 2017-05-31

    • Adult Signature Required and Adult Signature Restricted Delivery are now supported with the Rate Parcel and Create Shipment APIs.

    • The Create Manifest API now allows you to both list shipments and specify a Shipper ID. If a listed shipment does not belong to the specified Shipper ID, the API returns an error. See Create a Manifest.

    • Support has been removed for deprecated USPS® STCs (Service Type Codes).

  • Released on 2017-05-12