Get Order Status

HTTP Request

GET /v1/orders/{orderId}/status?clientId={clientId}

Summary

This operation retrieves an order’s status.

Request URLs

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/fulfillment/v1/orders/{orderId}/status?clientId={clientId}
Production: https://shipping-api.pitneybowes.com/shippingservices/fulfillment/v1/orders/{orderId}/status?clientId={clientId}

Path Parameter

Name

Description

orderId


Required. The order ID assigned by Pitney Bowes.

Query Parameters

Name

Description

clientId

Required. The client ID assigned by Pitney Bowes.

brand

The manufacturer’s brand name for the item.

Request Headers

Name


Description

Authorization

Required. OAuth token generated using the Generate an OAuth Token API.

X-PB-TransactionId

Required. A unique identifier for the request, up to 25 characters. The following characters are allowed: letters, numbers, hyphens (-), and underscores (_).

Important: Ensure this is a unique ID.

Response Elements

The response returns a subset of the Orders object. The table below describes the full Orders object. This operation returns a subset of these fields, as shown in the Sample Request and Response.

Name

Data Type

Description

clientId

String

The client ID assigned by Pitney Bowes.

clientOrderId

String

The order ID assigned by the client.

Maximum length: 50 characters

orderId

String

The order ID assigned by Pitney Bowes.

customerOrderId

String

The customer-specific order number. Typically this is the order number from the website or ERP system.

Maximum length: 50 characters

status

String

Status of the order. Possible values are:

  • BACKORDER

  • CANCELED

  • HOLD

  • INPROGRESS

  • ONHOLD

  • RECEIVED

  • RETURNED

  • SHIPPED

isOnHold

Boolean

If true, the order is on hold.

holdReason

Array[String]

Reason codes for the hold.

createDate

String

The date and time the order was created in the client system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbCreateDate

String

The date and time the order was created in the Pitney Bowes system, returned in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

updateDate

String

The date and time the order was updated in the client system, specified in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

pbUpdateDate

String

The date and time the order was updated in the Pitney Bowes system, returned in the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ

Sample Request

curl -X GET ".../v1/orders/{orderId}/status?clientId=1234" \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: <unique_identifier>"

Sample Response

{
    "clientId": "1234",
    "clientOrderId": "ORCLIENT8976r4w",
    "orderId": "ORDAA1267912211CO",
    "customerOrderId": "111-2212-1290877",
    "status": "ON_HOLD",
    "isOnHold": true,
    "holdReason": [
        "INVENTORY_HOLD"
    ],
    "createDate": "2022-05-07T05:36:48-05:00",
    "pbCreateDate": "2022-05-07T05:36:48-05:00",
    "updateDate": "2022-05-07T06:12:48-05:00",
    "pbUpdateDate": "2022-05-07T06:36:48-05:00"
}

Error Codes

For lists of error codes returned by the Fulfillment APIs, please see 80-Prefix Error Codes (Fulfillment APIs).