Fulfillment APIs Overview¶
On this page
Introduction¶
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 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 Ecommerce APIs 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 onboard to access the Fulfillment APIs. Contact ClientSupportTechServices@pb.com for more information.
API Operations for Fulfillment¶
The following are the Fulfillment API operations, grouped by resource. For base URLs, see API Environments. For authentication, see Generate an OAuth Token. For a comparison of the APIs with legacy APIs, see Legacy API Map.
Products¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/products |
|
PUT |
/v1/products/{sku} |
|
POST |
/v1/products/bulk |
|
GET |
/v1/products/{sku} |
|
POST |
/v1/products/search |
ASN (Advanced Shipment Notification)¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/receiving-asn |
|
PUT |
/v1/receiving-asn/{receivingASNId} |
|
GET |
/v1/receiving-asn/{receivingASNId} |
|
POST |
/v1/receiving-asn/search
|
|
PUT |
/v1/receiving-asn/{receivingASNId}/cancel |
Inventory¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/inventory/snapshot |
Orders¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/orders |
|
PUT |
/v1/orders/{orderId} |
|
POST |
/v1/orders/bulk |
|
PUT |
/v1/orders/{orderId}/order-items |
|
GET |
/v1/orders/{orderId} |
|
GET |
/v1/orders/{orderId}/status |
|
POST |
/v1/orders/search
|
|
PUT |
/v1/orders/{orderId}/cancel |
|
PUT |
/v1/orders/bulk/cancel |
|
POST |
/v1/shipments/search |
Kits: Bill of Materials (BOM)¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/bill-of-materials |
|
PUT |
/v1/bill-of-materials/{bill-of-material-id} |
|
GET |
/v1/bill-of-materials/{bill-of-material-id} |
Kits: Work Orders¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/work-orders |
|
PUT |
/v1/work-orders/{work-order-id} |
|
GET |
/v1/work-orders/{work-order-id} |
|
POST |
/v1/work-orders/search
|
|
PUT |
/v1/work-orders/{work-order-id}/cancel |
Fulfillment Return Orders¶
API Operation |
Method |
Resource Path |
|---|---|---|
POST |
/v1/returns |
|
PUT |
/v1/returns/{return-order-id} |
|
POST |
/v1/returns/bulk |
|
GET |
/v1/returns/{return-order-id} |
|
POST |
/v1/returns/search |
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 |
|---|---|---|
Bloomington |
162 |
11260 Cedar Ave.
|
CVG |
157 |
1200 Worldwide Blvd.
|
Greenwood |
160 |
1415 Collins Rd.
|
RNO |
159 |
38 Isidor Ct. Suite 130
|