Partial Order Update by OrderId

Request

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.

Security

bearerAuth

Path

orderIdstringrequired

Unique identifier for the order

Bodyapplication/jsonrequired

orderNumberstring

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.

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.

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)

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.

shippingPreferencesobject(ShippingPreferences)

Shipping-related preferences for an order.

dateOfShipmentstring, (date)

Planned shipment date for the order.

Example:"2026-01-30"

curl -i -X PATCH \
  'https://api-sandbox.sendpro360.pitneybowes.com/ordermanagement/api/v1/orders/{orderId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "orderNumber": "ORD12346",
    "orderMessage": {
      "type": "GIFT",
      "message": "Happy Birthday! Enjoy your gift."
    },
    "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"
      }
    ],
    "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

Order updated successfully (partial)

Bodyapplication/json

orderIdstring

System-generated unique identifier of the updated order.

Example:"PBNj9OB9zXvx"

orderNumberstring

Updated reference number for the order.

Example:"ORD123456"

statusstring

Current status of the order after update.

Example:"Updated"

transactionCreateDatestring, (date-time)

Timestamp indicating when the update transaction was processed.

Example:"2025-07-02T18:27:48.172Z"

Response

{
  "orderId": "PBNj9OB9zXvx",
  "orderNumber": "ORD123456",
  "status": "Updated",
  "transactionCreateDate": "2025-07-02T18:27:48.172Z"
}