Note

The Fulfillment APIs are coming soon.

Fulfillment APIs

Overview

The Pitney Bowes REST-based Fulfillment APIs let you integrate with Pitney Bowes Fulfillment Services to manage inventory, fulfill orders, assemble kits, and handle returns. The APIs, released in 2022, replace the legacy SOAP-based APIs. The Fulfillment APIs follow the principles of the REST architectural style and use HTTPS as the underlying protocol. Resource objects in the APIs use JSON formatting.

The APIs are part of the broader Pitney Bowes Ecommerce APIs and require a Pitney Bowes developer account. As with all the Ecommerce APIs, the Fulfillment APIs require authentication via an OAuth token obtained through the Generate an OAuth Token API.

Before Using these APIs

Before using these APIs, please read the API Overview, which gives information about environments, authentication, and the principles of the Ecommerce APIs.

Onboard with the Fulfillment APIs

Whether you are a new customer or an existing customer, you must follow these onboarding steps in order to access the Fulfillment APIs. If you are migrating from the legacy SOAP-based APIs, refer also to the Legacy API Map for Fulfillment.

  1. If you have not read the API Overview, do so to understand the principles of the REST APIs.

  2. If you do not already have a Pitney Bowes developer account, create one by following steps 1-6 in Getting Started with the APIs. (Note: Skip step 4, as indicated in that step.)

  3. Test the Fulfillment API operations on the Sandbox environment. A good place to start testing is with the Create a Product API. Contact Pitney Bowes while you are testing so we can help validate your tests.

    Note

    Make sure to contact Pitney Bowes during testing and well before you request an upgrade to Production, to give us time to validate your tests.

  4. When you are ready to upgrade to Production, contact Pitney Bowes at ShippingAPIBusinessDevelopment@pb.com.

API Operations for Fulfillment

The documentation for each API operation is found in the Fulfillment APIs section in the Table of Contents (TOC). The TOC groups the operations as follows:

APIs

Description

Product, ASN, Inventory

  • Products APIs manage the client’s items.

  • ASN APIs notify Pitney Bowes when to receive new inventory.

  • Inventory APIs retrieve the client’s current inventory.

Orders

  • Orders APIs notify Pitney Bowes when to fulfill a customer purchase and retrieve information about fulfilled orders.

BOM, Work Orders

  • Bill of Materials (BOM) APIs define the products that go into a kit.

  • Work Orders APIs notify Pitney Bowes when to fulfill the kit.

Return Orders

  • Returns APIs notify Pitney Bowes when a return was initiated. Clients can use this API with orders fulfilled by Pitney Bowes or orders fulfilled by other services.

For a list of all the API operations on a single page, see Fulfillment API Resources.

Error Codes

The error codes returned by the Fulfillment APIs are described in the 80-Prefix Error Codes (Fulfillment APIs) section of the Error Codes page.

Fulfillment Centers

The following are the Pitney Bowes Fulfillment Centers:

Name


ID


Address

CVG

157

RNO

159

Greenwood

160

Bloomington

162