# Order Management APIs Order Management APIs provide capabilities to create, retrieve, update, search, and delete orders throughout the order lifecycle. These APIs support order processing by allowing you to manage customer, item, pricing, shipping, workflow status, and tagging information in a consistent way. The APIs support the following services: - Create a new order with customer, item, pricing, and shipping details - Retrieve complete order details by order ID - Partially update an existing order - Update workflow status for multiple orders - Delete an order or remove specific order items - Search orders using filter-based criteria - Add, update, or remove tags for single or multiple orders Version: 1.0.0 License: PB Software License Agreement ## Servers ``` https://api-dev.sendpro360.pitneycloud.com/ordermanagement ``` ``` https://api-qa.sendpro360.pitneycloud.com/ordermanagement ``` Sandbox Server ``` https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement ``` Production Server (uses live data) ``` https://api.sendpro360.pitneybowes.com/ordermanagement ``` Sandbox Server for Canada ``` https://api-ppd.shipping360.pitneybowes.com/ca/shipping ``` Production Server for Canada ``` https://api.shipping360.pitneybowes.com/ca/shipping ``` ## Security ### bearerAuth Type: http Scheme: bearer ## Download OpenAPI description [Order Management APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/ordermanagement.yaml) ## Order APIs to create, retrieve, update, search, and delete orders, and to manage order items and workflow status throughout the order lifecycle. ### Create Order - [POST /api/v1/orders](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/createorder.md): This operation creates a new order in the Order Management System. This API accepts customer details, item information, pricing, and shipping-related data and generates a unique order identifier. The created order is initialized in an unfulfilled state and can be updated or progressed through subsequent OMS operations. ### Get Order by ID - [GET /api/v1/orders/{orderId}](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/getorderbyid.md): This operation retrives the complete details of a specific order using its unique orderId. - Retrieve all order-related information for tracking or reporting. - Verify order contents and financials before fulfillment. ### Delete Order by ID - [DELETE /api/v1/orders/{orderId}](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/deleteorderbyid.md): This operation performs a soft delete of an order identified by orderId. The order is marked as deleted and is no longer available for processing or fulfillment ### Partial Order Update by OrderId - [PATCH /api/v1/orders/{orderId}](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/partialupdateorderbyid.md): This operation updates one or more fields of an existing order.This API is used to modify order data after creation, such as adding items or updating order-level information, without replacing the entire order record. ### Update Bulk Orders Status - [PATCH /api/v1/orders/bulk/status](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/updateorderbyid.md): This API is used to Updates the status of multiple orders in a single request such as UNFULFILLED, ONHOLD, FULFILLED, or CANCELED, based on business or fulfillment actions. Use this API to apply the same status change to more than one order at once. ### Delete Order Item - [DELETE /api/v1/orders/{orderId}/items](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/deleteorderitem.md): Deletes a specific item from an order using its SKU. This operation is used when an item is removed before fulfillment due to order changes or corrections. ### Search Orders by OrderID - [POST /api/v1/orders/search](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/order/searchorders.md): This operation returns a list of orders that match the provided search criteria. ## Tags APIs to create, update, and remove tags for single or multiple orders. ### Update Tags for an Order - [PUT /api/v1/orders/{orderId}/tags](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/tags/updatetags.md): This operation is used to create, update or remove tags associated with a specific order. - To create or update tags, provide one or more values in tagIds array. - To remove previously assigned tags, provide an empty array for tagIds ([]). ### Update Tags for Bulk Orders - [PUT /api/v1/orders/bulkTags](https://docs.sendpro360.pitneycloud.com/openapi/ordermanagement/tags/bulkupdatetags.md): This operation creates, updates, or removes tags for multiple orders in a single request. - To create or update tags for bulk orders, provide one or more values in tagIds array. - To remove previously assigned tags for an specified order, provide an empty array for tagIds ([]).