PB Standard (Newgistics)

Overview

The PB Shipping APIs integrate with the PB Standard shipping service (formerly Newgistics) through the API operations listed on this page. PB Standard labels are post-paid labels and do not incur charges at the time of print.

This page describes how to onboard a merchant to use PB Standard; lists the API operations to use when shipping with PB Standard; and lists the supported services, special services, parcel types, and label options.

Onboard a Merchant to Print PB Standard Labels

  1. If you have not yet done so, enroll the merchant with your PB developer account using one of the enrollment models described on the Merchant Accounts page. Pitney Bowes will assign the merchant a PB Shipper ID for use when shipping with your developer account.

  2. Contact your Pitney Bowes representative to register the merchant at one or more PB Standard hubs. Pitney Bowes will provide the merchant with the following set of PB Standard IDs for use when shipping with PB Standard:

    • CARRIER_FACILITY_ID
    • CLIENT_FACILITY_ID
    • CLIENT_ID

    Note: To test PB Standard in the Sandbox environment, you can use the set of Sandbox IDs listed in the last column of the table below.

  3. Email a request to ClientServicesTechSupport@pb.com asking Pitney Bowes to enable the merchant to use PB Standard. In the request, include the merchant’s PB Shipper ID and the merchant’s set of PB Standard IDs.

PB Standard IDs

When a merchant is set up at a PB Standard hub, the Pitney Bowes representative provides the merchant with three types of IDs, as listed in the table below. Use the IDs when creating a PB Standard shipment or manifest. To test PB Standard in the sandbox environment, use the ID values listed in the Sandbox Value column.

ID
Description
Sandbox Value
CARRIER_FACILITY_ID The PB Standard facility assigned to the merchant. A merchant can be assigned multiple PB Standard facilities. 1585
CLIENT_FACILITY_ID The merchant’s facility. A merchant can have multiple client facility IDs. 0093
CLIENT_ID The unique ID assigned to the merchant for creating PB Standard shipments. NGST


API Operations for Shipping with PB Standard

The following shipping operations are used with PB Standard. For requests that originate in the Asia-Pacific Region, Pitney Bowes provides APAC Services to localize operations. See APAC Services.

Operation
Method Endpoint

Validate an Address

POST

/v1/addresses/verify
 

Suggest Addresses

POST

/v1/addresses/verify-suggest
 

Create a PB Standard Label

POST

/v1/shipments
 

Create a PB Standard Return Label

POST

/v1/shipments
 

Reprint a Label

GET

/v1/shipments/{shipmentId}?carrier={carrier}
 

Retry a Label

GET

/v1/shipments?originalTransactionId={transaction_id}&carrier={carrier}
 

Void a Label

DELETE

/v1/shipments/{shipmentId}
 

Create a PB Standard Manifest (Closeout)

POST

/v1/manifests
 

Get Tracking Information

GET

/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber&carrier=FDR
 

Accounts APIs

——

See the Accounts APIs table on the Merchant Accounts page.
 


API Operations for APAC Services

For requests that originate in the Asia-Pacific Region, Pitney Bowes provides APAC Services to localize operations. See APAC Services.


PB Standard Services

The following services are supported for PB Standard shipments created through the Shipping APIs.

ID
Service
BPM Bound Printed Matter
PRCLSEL Parcel Select, Parcel Select Return
PSLW Parcel Select Lightweight
FCM First-Class Mail
PM Priority Mail


PB Standard Special Services

The following special services are supported for PB Standard shipments created through the Shipping APIs. Do not include a special service unless you intend to apply it.

ID Special Service
Input Parameters (inputParameters)
DelCon Delivery Confirmation

Input parameters are not required for DelCon. To use DelCon, add the following to the rates.specialServices array:

{ "specialServiceId": "DelCon" }
Sig Signature Confirmation

Input parameters are not required for Sig. To use Sig, add the following to the rates.specialServices array:

{ "specialServiceId": "Sig" }
NOTIFICATIONS

Subscribe to provisioned transit triggers.

To use this special service, the merchant must be configured for PB Standard transit triggers.

To set input parameters, see the Transit Triggers section on the Create a PB Standard Shipment page.

PB Standard Parcels

The following parcel type is supported for PB Standard shipments created through the Shipping APIs.

ID Parcel Type Services Supporting the Parcel Type
PKG Package BPM, PRCLSEL, PSLW, FCM, PM


PB Standard Labels

Note

If you use APAC Services, this section does not apply. Please see Label Settings for APAC Services.

Before printing a PB Standard label, see the following considerations:

  • The label size specified in the documents.size field uses an upper-case X. Using a lower-case x will result in an error.
  • If you choose to retrieve the label through a URL, the URL will be available for 24 hours.
  • By default, the APIs print ZPL2 labels using the Unicode character set. If you have an older printer that does not support Unicode, see this Troubleshooting topic.
  • Advise shippers on correct label placement. See What is the correct placement for a shipping label?

The following table describes the options for each label size.

Label Size
File Format
Content Type
Resolution
DOC_4X4 PDF
PNG
ZPL2 [1]
URL
BASE64
BASE64
DPI_203
DPI_203
DPI_203 (default),
DPI_300
DOC_4X5 PDF
PNG
ZPL2 [1]
URL
BASE64
BASE64
DPI_203
DPI_203
DPI_203 (default),
DPI_300
DOC_4X6 PDF
PNG
ZPL2 [1]
URL
BASE64
BASE64
DPI_203
DPI_203
DPI_203 (default),
DPI_300
No setting GIF (used for QR codes only) BASE64 No setting
[1](1, 2, 3) If you have an older printer that does not support Unicode, see this topic.


Shipment Options for PB Standard

See the Shipment Options page for options that apply to PB Standard.


Sample PB Standard Label

Sample PB Standard Label