Newgistics

Overview

The PB Shipping APIs provide integration to Newgistics domestic shipping services.

Supported Services and Formats

Newgistics labels are post-paid labels. Postage is not charged at the time of print. Newgistics labels print with USPS-compliant barcodes and support the following:

Services: Parcel Select
Parcel Select Lightweight
Bound Printed Matter
Priority Mail
First-Class Mail
Special Services: Delivery Confirmation
Signature Confirmation
Package Type: PKG
Label Size: 4X5
4X6
Label File Formats: ZPL2
PDF
PNG

Onboarding a Merchant with Newgistics

  1. Contact Newgistics to set up the merchant at one or more Newgistics hubs. Newgistics will provide the merchant with the following Newgistics IDs, which are required when creating Newgistics shipments and manifests:
    • Client Facility ID
    • Newgistics Facility ID
    • Newgistics Merchant ID
  2. If you have not already done so, enroll the merchant within your PB developer account using one of the Merchant Enrollment Models. Pitney Bowes assigns the merchant a PB Shipper ID.
  3. Contact PB Support to enable the merchant to use Newgistics. Send an email to ShippingAPISupport@pb.com and provide the merchant’s Newgistics IDs and PB Shipper ID.

Newgistics IDs

The Newgistics representative provides the merchant with the following IDs. To test the APIs on the sandbox environment, use the ID values listed in the Sandbox Value column.

ID Description API Field Sandbox Value
Client Facility ID This identifies a merchant location/facility. A merchant can have multiple client facility IDs. CLIENT_FACILITY_ID When testing in the sandbox environment, set this to 0093.
Newgistics Facility ID The Newgistics facility assigned to the merchant. A merchant can be assigned multiple Newgistics facilities. CARRIER_FACILITY_ID When testing in the sandbox environment, set this to 1585.
Newgistics Merchant ID
The unique ID assigned by Newgistics to a merchant. CLIENT_ID When testing in the sandbox environment, set this to NGST.

Shipping Operations

The following shipping operations can be used with Newgistics.

Operation Method Endpoint

Validate Address

POST

/v1/addresses/verify
 

Suggest Addresses

POST

/v1/addresses/verify-suggest
 

Create Newgistics Label

POST

/v1/shipments
 

Reprint Label

GET

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

Retry Label

GET

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

Void Label

DELETE

/v1/shipments/{shipmentId}
 

Create a Newgistics Manifest (Closeout)

POST

/v1/manifests
 

Get Tracking Information

GET

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

Testing on Sandbox

To test the Newgistics API calls on the sandbox environment, use the ID values listed in the Sandbox Value column of the Newgistics IDs table.

Sample Newgistics Label

Sample Newgistics Label