Fulfillment APIs Overview¶

On this page

Introduction
Onboard with the Fulfillment APIs
Fulfillment API Operations
Error Codes
Fulfillment Centers

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.

Important

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 GEC-TechSupport@pb.com for more information.

Fulfillment API Operations¶

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¶

Products APIs	Method	Resource Path
Create a Product	POST	/v1/products
Update a Product	PUT	/v1/products/{sku}
Create or Update Multiple Products	POST	/v1/products/bulk
View a Product	GET	/v1/products/{sku}
Find Products	POST	/v1/products/search

ASN (Advanced Shipment Notification)¶

ASN APIs	Method	Resource Path
Create an ASN	POST	/v1/receiving-asn
Update an ASN	PUT	/v1/receiving-asn/{receivingASNId}
View an ASN	GET	/v1/receiving-asn/{receivingASNId}
Find ASNs	POST	/v1/receiving-asn/search /v1/receiving-asn/status/search
Cancel an ASN	PUT	/v1/receiving-asn/{receivingASNId}/cancel

Inventory¶

Inventory API

Method

Resource Path

View an Inventory Snapshot

POST

/v1/inventory/snapshot

Orders¶

Orders API	Method	Resource Path
Create an Order	POST	/v1/orders
Update an Order	PUT	/v1/orders/{orderId}
Create or Update Multiple Orders	POST	/v1/orders/bulk
Change Existing Order Items	PUT	/v1/orders/{orderId}/order-items
View an Order	GET	/v1/orders/{orderId}
Get Order Status	GET	/v1/orders/{orderId}/status
Find Orders	POST	/v1/orders/search /v1/orders/status/search
Cancel an Order	PUT	/v1/orders/{orderId}/cancel
Cancel a Bulk Order	PUT	/v1/orders/bulk/cancel

Shipments¶

Shipments API

Method

Resource Path

Find Shipment Details for Fulfilled Orders

POST

/v1/shipments/search

Bill of Materials (BOM)¶

BOM APIs	Method	Resource Path
Create a Bill of Materials	POST	/v1/bill-of-materials
Update a Bill of Materials	PUT	/v1/bill-of-materials/{bill-of-material-id}
View Bill of Materials	GET	/v1/bill-of-materials/{bill-of-material-id}
Find a BOM	POST	/v1/bill-of-materials/search/

Work Orders¶

Work Order APIs	Method	Resource Path
Create a Work Order	POST	/v1/work-orders
Update a Work Order	PUT	/v1/work-orders/{work-order-id}
View a Work Order	GET	/v1/work-orders/{work-order-id}
Find Work Orders	POST	/v1/work-orders/search /v1/work-orders/status/search
Cancel a Work Order	PUT	/v1/work-orders/{work-order-id}/cancel

Fulfillment Return Orders¶

Return Order APIs	Method	Resource Path
Create a Fulfillment Return Order	POST	/v1/returns
Update a Fulfillment Return Order	PUT	/v1/returns/{return-order-id}
Create Bulk Return Orders for Fulfillment	POST	/v1/returns/bulk
View a Fulfillment Return Order	GET	/v1/returns/{return-order-id}
Find Fulfillment Return Orders	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

CVG

157

1200 Worldwide Blvd.
Hebron, KY, 41048

Legacy API Map