Update a Work Order¶

HTTP Request¶

PUT /v1/work-orders/{ID}

Summary¶

This operation updates a work order. You must pass the whole work order object again to make the update. You cannot pass a partial object.

Request URLs¶

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

Path Parameter¶

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

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.

Request Elements¶

Important

You must pass the whole work order object again to make the update. You cannot pass a partial object.

Name	Data Type	Description
clientId	String	Required. The client ID assigned by Pitney Bowes.
clientWorkOrderId	String	Required. The work order ID assigned in the client system. Maximum length: 35 characters
workOrderId	String	The work order ID assigned by Pitney Bowes.
workOrderName	String	Required. The name of the work order in the client system. Maximum length: 30 characters
description	String	The work order description. Maximum length: 250 characters
type	String	Required. The type of work order. Possible value: `KIT` `REFURBISHED` (Reserved for future use.) `OTHER` (Reserved for future use.)
node	String	Required. 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`
sku	String	Required. The SKU for the produced kit. The kit must be part of the master catalog. Maximum length: 30 characters
brand	String	The seller’s brand name for the item. Maximum length: 50 characters
workOrderQuantity	Number	Required. 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. Specify this in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`
requestedCompletionDate	String	The date and time by which the work order should be completed. Specify this in the ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`

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`

Sample Request¶

curl -X PUT ".../v1/work-orders/{ID}" \
-H "Authorization: Bearer <oauth_token>" \
-H "X-PB-TransactionId: <unique_identifier>" \
-d '
{
    "clientId": "1234",
    "clientWorkOrderId": "W-284238",
    "workOrderName": "2021 Welcome Kit",
    "description": "welcome kit",
    "type": "KIT",
    "node": "160",
    "createDate": "2021-08-30T16:07:49Z",
    "updateDate": "2021-08-30T16:07:49Z",
    "sku": "Product-210411",
    "workOrderQuantity": 2000,
    "priority": "PRIORITY",
    "requestedStartDate": "2021-08-30T16:07:49Z",
    "requestedCompletionDate": "2021-08-30T16:07:49Z"
}'

Sample Response¶

{
    "clientId": "1234",
    "clientWorkOrderId": "W-284238",
    "workOrderId": "WO1234A789117803242",
    "workOrderName": "2021 Welcome Kit",
    "description": "welcome kit",
    "type": "KIT",
    "status": "UPDATED",
    "node": "160",
    "createDate": "2021-08-30T09:07:49Z",
    "updateDate": "2021-08-30T09:07:49Z",
    "pbCreateDate": "2021-08-30T09:07:49Z",
    "pbUpdateDate": "2021-08-30T09:07:49Z",
    "sku": "Product-210411",
    "workOrderQuantity": 2000,
    "priority": "PRIORITY",
    "requestedStartDate": "2021-08-30T09:07:49Z",
    "requestedCompletionDate": "2021-08-30T09:07:49Z"
}

Error Codes¶

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