PB Presort

Overview

The Ecommerce APIs integrate with the PB Presort service through the API operations listed on this page. PB Presort provides presort services for domestic shipment of flats and letters. Presort labels are post-paid labels. No postage is charged at the time of print.

This page lists Onboarding Instructions, API Operations, Services & Parcels, Special Services, and Labels.


Onboard a Merchant to Print PB Presort Labels

A merchant must be enrolled with a PB Presort facility to use the service. To enroll a merchant, contact your Pitney Bowes account representative. Pitney Bowes will provide the following information for the merchant:

Mailer ID

The Mailer ID (MID) identifies the merchant as validated for PB Presort. When creating a label, specify the MID value in the X-PB-Integrator-CarrierId header.

Job number

This identifies the agreement between the merchant and PB Presort for a committed volume of parcels and specific class of service at an agreed-upon rate. A merchant can be assigned multiple job numbers. When creating a label, specify the job number in the X-PB-ShipmentGroupId header.

Date and time of pickup

The regularly scheduled time for parcel pickup.

Rate charts

The rates for PB Presort shipments. To determine a rate for a PB Presort shipment, use the rate charts. Do not use the Rates API.


API Operations for Shipping with PB Presort

Important

To rate a PB Presort shipment, use the rate charts. Do not use the Rates API.

Operation


Method

Endpoint


Create PB Presort Label

POST

/v1/shipments

Reprint Label

GET

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

Retry Label

GET

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

Create a PB Presort Pickup Slip

POST

/v1/manifests

Get Tracking Information

GET

/v1/tracking/{trackingNumber}?packageIdentifierType=TrackingNumber

Accounts APIs

——

See the Accounts APIs table on the Merchant Accounts page.


PB Presort Services and Parcels

PB Presort supports the following combinations of service and parcel type:

Service ID


Service


Supported Parcel Type


Parcel Dimensions


Weight Rules


BPM

Bound Printed Matter

PKG (Package)







LGENV (Large Envelope)

Max Length: 27.0 in
Max Width: 17.0 in
Max Height: 17.0 in

Min Length: 6.0 in
Min Width: 0.25 in
Min Height: 4.0 in


Max Length: 15.0 in
Max Width: 0.75 in
Max Height: 12.0 in

Min Length: 6.0 in
Min Width: 0.009 in
Min Height: 4.0 in

Max Weight: 240.0 oz



Min Weight: 0.01 oz



Max Weight: 240.0 oz



Min Weight: 0.01 oz

STANDARD

Standard Mail

LGENV (Large Envelope)

Max Length: 15.0 in
Max Width: 0.75 in
Max Height: 12.0 in

Min Length: 6.0 in
Min Width: 0.009 in
Min Height: 4.0 in

Max Weight: 16.0 oz



Min Weight: 0.01 oz


PB Presort Special Service

The following special service is supported for PB Presort.

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

ID

Special Service

Services Supporting the Special Service

Input Parameter

DelCon

Delivery Confirmation

STANDARD

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

{ "specialServiceId": "DelCon" }


PB Presort Labels

Please read the following considerations before printing labels:

  • The label size, as 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 is available for 24 hours after the shipment is created.

  • 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. Please see What is the correct placement for a shipping label?

The following table describes the options for each parcel type and label size.

Label Size


Supported Parcel Type


Label Barcode


Label Format


Content Type


DOC_4X6

PKG

IMb

PDF


ZPL2

URL


BASE64

DOC_6X4

LGENV

IMb

PDF


ZPL2

URL


BASE64