View a Work Order¶

HTTP Request¶

GET /v1/work-orders/{workOrderId}?clientId{clientId}

Summary¶

This operation retrieves the details of the specified work order.

Request URLs¶

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

Path Parameter¶

Name

Description

workOrderId

Required. The work order ID assigned by Pitney Bowes, as returned in the workOrderId field when the work order was created.

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¶

Name	Data Type	Description
clientId	String	The client ID assigned by Pitney Bowes.
clientWorkOrderId	String	The work order ID assigned in the client system, up to 35 characters.
workOrderId	String	The work order ID assigned by Pitney Bowes.
workOrderName	String	The name of the work order in the client system, up to 30 characters.
description	String	The work order description, up to 250 characters.
type	String	The type of work order. Possible value: `KIT` `REFURBISHED` (Reserved for future use.) `OTHER` (Reserved for future use.)
status	String	The order status. Possible values: `CREATED` `INPROGRESS` `CANCELED` `CLOSED` `COMPLETE`
node	String	The ID for the Pitney Bowes Fulfillment Center where work order is to be produced.
createDate	String	The date and time the work order was created in the client system, specified in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
updateDate	String	The date and time the work order was updated in the client system, specified in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
pbCreateDate	String	The date and time the work order was created in the Pitney Bowes system, returned in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
pbUpdateDate	String	The date and time the work order was updated in the Pitney Bowes system, returned in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
sku	String	The SKU for the produced kit. The kit must be part of the master catalog, up to 30 characters.
brand	String	The seller’s brand name for the item, up to 50 characters.
workOrderQuantity	Number	The number of kits ordered.
priority	String	The priority of the work order. Possible values: `PRIORITY` `STANDARD`
requestedStartDate	String	The date and time by which the work order should be started, specified in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
requestedCompletionDate	String	The date and time by which the work order should be completed, specified in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
startDate	String	Date the work order was started.
completionDate	String	Date the work order was completed.
startQuantity	Number	Start quantity of the work order.
completedQuantity	Number	Quantity produced for the work order.
lotNumbers	Array[String]	Completed Lot numbers for the produced product.
serialNumbers	Array[String]	Reserved for future use.
rejectedQuantity	Number	Rejected quantity for the product.
scrappedQuantity	Number	Scrapped quantity for the product.
workOrderLines	Array[Object]	The child items.
workOrderLines.childSKU	String	The SKU of the child item. The item must be part of the master catalog.
workOrderLines.lotNumbers	Array[String]	The completed lot numbers for the produced product.
workOrderLines.serialNumbers	Array[String]	Reserved for future use.
workOrderLines.issuedQuantity	Number	The issued quantity of the child product.
cancelDate	String	If the work order was cancelled, the date the client cancelled the work order.
pbCancelDate	string	The date the work order is cancelled in the Pitney Bowes system.
cancelReason	string	If the work order was cancelled, this gives the reason for cancellation.
references	Array[Object]	Reserved for future use.
references.name	String	Reserved for future use.
references.value	String	Reserved for future use.

Sample Request¶

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

Sample Response¶

{
    "clientId": "1234",
    "clientWorkOrderId": "W-284238",
    "workOrderName": "Welcome Kit",
    "description": "welcome kit",
    "type": "KIT",
    "status": "CREATED",
    "workOrderId": "WO1234A789117803242",
    "node": "160",
    "createDate": "2022-05-30T09:07:49-07:00",
    "updateDate": "2022-05-30T09:07:49-07:00",
    "pbcreateDate": "2022-05-30T09:07:49-07:00",
    "pbupdateDate": "2022-05-30T09:07:49-07:00",
    "sku": "Product-210411",
    "workOrderQuantity": 5000,
    "priority": "PRIORITY",
    "requestedStartDate": "2022-05-30T09:07:49-07:00",
    "requestedCompletionDate": "2022-05-30T09:07:49-07:00",
    "startDate": "2022-05-30T09:07:49-07:00",
    "completionDate": "2022-05-30T09:07:49-07:00",
    "startQuantity": 1,
    "completedQuantity": 1,
    "lotNumbers": [
      "LOT#11-2321-1134553",
      "LOT#11-2321-1134556"
    ],
    "rejectedQuantity": 0,
    "scrappedQuantity": 0,
    "workOrderLines": [ {
        "childSKU": "Product-120445",
        "lotNumbers": [
            "LOT#18-2321-245612",
            "LOT#18-2321-245618"
        ],
        "issuedQuantity": 1
    } ]
}

Error Codes¶

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