Skip to content
/Order

Order

APIs to create, retrieve, update, search, and delete orders, and to manage order items and workflow status throughout the order lifecycle.

Operations

Create Order

Request

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.

Security
bearerAuth
Query
isLTLboolean

This is the query parameter used to indicate whether the order being created is a Less-Than-Truckload (LTL) order. If set to true, the order will be processed as an LTL shipment, If not provided or set to false, the order will be processed as a standard parcel shipment.

Headers
X-PB-LocationIdstring

This is the Location ID assigned based on the developer's and partner's parsed locations. If it is not provided, no Location ID is applied.

Bodyapplication/jsonrequired
One of:
orderNumberstringrequired

The unique identifier for the order. The maximum supported length is 50 characters.

Example:"ORD12346"
orderMessageobject

An optional message added to an order, such as a gift note or a short greeting.

metadataArray of objects

Additional metadata that needs to be stored for this order can be added here.

Example:
[
  {
    "name": "costAccountName",
    "value": "costAccountName12"
  },
  {
    "name": "costAccountId",
    "value": "costAccountId12"
  },
  {
    "name": "costAccountCode",
    "value": "Code12"
  }
]
chargesobject(Charges)

Financials and tender type information for the order.

shippingReferenceobject(ShippingReferences)

Contains additional reference fields that can be passed with the request.

customerInfoobject

End customer (buyer) profile for communication.

fromAddressobject(Address)

The address from where the order is generated. While creating an order, fromAddress is conditionally optional.

Example:
{
  "name": "Warehouse A",
  "company": "Company Name",
  "addressLine1": "638 Manitoba Ave",
  "addressLine2": "Apt 4B",
  "cityTown": "Winnipeg",
  "stateProvince": "MB",
  "postalCode": "R2W 2H2",
  "countryCode": "CA",
  "phone": "1234567890",
  "email": "warehouse@email.com",
  "residential": false
}
toAddressobject(Address)required

The address where the order is destined to.

Example:
{
  "name": "Jane Smith",
  "company": "Company ABC",
  "addressLine1": "1822 Franklin Street",
  "addressLine2": "3010 Summer Street",
  "cityTown": "Vancouver",
  "stateProvince": "BC",
  "postalCode": "V5L 1P8",
  "countryCode": "CA",
  "phone": "9876543210",
  "email": "jane.smith@email.com",
  "residential": true
}
itemsArray of objects(Item)

List of items in the order. To create an order, minimum one item is required.
Note: Either use customsProductId or item properties individually.

additionalAddressesArray of objects(additionalAddresses)

A list of additional addresses associated with the order.

Example:
[
  {
    "address": {
      "addressLine1": "638 Manitoba Ave",
      "cityTown": "Winnipeg",
      "countryCode": "CA",
      "name": "billing name",
      "phone": "203-555-1213",
      "postalCode": "R2W 2H2",
      "company": "Pitney Bowes Inc.",
      "stateProvince": "MB"
    },
    "addressType": "BILLING"
  }
]
shippingPreferencesobject(ShippingPreferences)

Shipping-related preferences for an order.

curl -i -X POST \
  'https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement/api/v1/orders?isLTL=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-PB-LocationId: string' \
  -d '{
    "orderNumber": "ORD12346",
    "orderMessage": {
      "type": "GIFT",
      "message": "Happy Birthday! Enjoy your gift."
    },
    "metadata": [
      {
        "name": "costAccountName",
        "value": "costAccountName12"
      },
      {
        "name": "costAccountId",
        "value": "costAccountId12"
      },
      {
        "name": "costAccountCode",
        "value": "Code12"
      }
    ],
    "charges": {
      "currency": "USD",
      "billingStatus": "Paid",
      "gmv": 100,
      "subTotal": 90,
      "totalPaid": 100,
      "paymentType": "Credit Card"
    },
    "shippingReference": {
      "reference1": "reference1",
      "reference2": "reference2",
      "reference3": "reference3",
      "reference4": "reference4",
      "shipperReference": "Shipper123",
      "transportationReference": "TransRef2025",
      "shippingNotes": "Handle with care"
    },
    "customerInfo": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "customerId": "CUST12345"
    },
    "fromAddress": {
      "name": "Warehouse A",
      "company": "Company Name",
      "addressLine1": "638 Manitoba Ave",
      "addressLine2": "Apt 4B",
      "addressLine3": "Near City Park",
      "cityTown": "Winnipeg",
      "stateProvince": "MB",
      "postalCode": "R2W 2H2",
      "countryCode": "CA",
      "phone": "1234567890",
      "email": "warehouse@email.com",
      "residential": false
    },
    "toAddress": {
      "name": "Jane Smith",
      "company": "Company ABC",
      "addressLine1": "1822 Franklin Street",
      "addressLine2": "3010 Summer Street",
      "addressLine3": "Near City Park",
      "cityTown": "Vancouver",
      "stateProvince": "BC",
      "postalCode": "V5L 1P8",
      "countryCode": "CA",
      "phone": "9876543210",
      "email": "jane.smith@email.com",
      "residential": true
    },
    "items": [
      {
        "customsProductId": "string",
        "itemId": "item1234",
        "url": "https://example.com/products/wireless-mouse",
        "description": "Wireless mouse with USB receiver",
        "hSTariffCode": "847160",
        "hSTariffCodeCountry": "US",
        "originCountryCode": "US",
        "originStateProvince": "",
        "quantity": 2,
        "unitPrice": 25,
        "weight": 12.5,
        "weightUnit": "OZ"
      }
    ],
    "additionalAddresses": [
      {
        "address": {
          "addressLine1": "638 Manitoba Ave",
          "cityTown": "Winnipeg",
          "countryCode": "CA",
          "name": "billing name",
          "phone": "203-555-1213",
          "postalCode": "R2W 2H2",
          "company": "Pitney Bowes Inc.",
          "stateProvince": "MB"
        },
        "addressType": "BILLING"
      }
    ],
    "shippingPreferences": {
      "carrier": "UPS",
      "parcelId": "PKG-001",
      "parcelType": "PKG",
      "service": "2DA",
      "parcel": {
        "length": 2,
        "width": 1,
        "height": 1,
        "dimUnit": "IN",
        "weightUnit": "OZ",
        "weight": 2
      },
      "specialServices": [
        {
          "inputParameters": [
            {
              "name": "INPUT_VALUE",
              "value": "100"
            }
          ],
          "specialserviceId": "Ins"
        }
      ],
      "customs": {
        "customsInfo": {
          "certificateNumber": "98788877",
          "comments": "string",
          "currencyCode": "USD",
          "customsDeclaredValue": 0,
          "EELPFC": "NOEEI 30.36",
          "fromCustomsReference": "11111",
          "importerCustomsReference": "987654",
          "insuredAmount": 0,
          "invoiceNumber": "001189223",
          "licenseNumber": "456ABC123",
          "reasonForExport": "GIFT"
        }
      },
      "shipmentProvider": {
        "shipViaCode": "shipViaCode123"
      },
      "carrierPayments": [
        {
          "accountNumber": "602684342",
          "countryCode": "US",
          "postalCode": "30305",
          "party": "BILL_RECEIVER",
          "typeOfCharge": "ALL_CHARGES"
        }
      ],
      "shipmentOptions": {
        "packageDescription": "testpackageDescription"
      },
      "dateOfShipment": "2026-01-30"
    }
  }'

Responses

The Order has been created Successfully.

Bodyapplication/json
orderIdstring

Unique identifier assigned to the created order.

Example:"PBcffM5ruasQ"
orderNumberstring

The order number as provided in the request.

Example:"ORD12346ORD12346"
statusstring

Current status of the order created.

Example:"Success"
transactionCreateDatestring, (date-time)

Timestamp of when the order was created.

Example:"2025-06-30T10:53:24.554Z"
Response
{
  "orderId": "PBcffM5ruasQ",
  "orderNumber": "ORD12346ORD12346",
  "status": "Success",
  "transactionCreateDate": "2025-06-30T10:53:24.554Z"
}