Switch Between Pitney Bowes Services

← Back to All FAQs

How do I edit my Standard Delivery request to print an Expedited Delivery label?

To edit your PB Standard Delivery request so that it prints a PB Expedited label, make the following changes to the request:

Field


Changes

carrier

Set this to USPS

serviceId,
parcelType,
specialServices

Set these fields to the PB Expedited options you’d like to use. For available options, see the Pitney Bowes reference page.

shipmentOptions

Add any PB Expedited shipment options you’d like to use.

You can leave the existing PB Standard shipment options as is. The API will ignore them.

references

If you will not use this array to pass references for PB Expedited, you can leave the PB Standard references as is. They will be returned in the response, but you can ignore them.

If you will use this array to pass references for PB Expedited, enter the desired values.

In both cases, the reference values are returned in the response. You can choose to use them or ignore them.

Example:

In the following example, the left column shows the request body for a PB Standard shipment. The right column shows the same request modified to create a PB Expedited shipment. The PB Expedited request does the following:

  • Sets the carrier field to USPS (line 17).

  • Sets the serviceId field to PM (line 18).

  • Adds the Ins special service (lines 24-27).

  • Makes no changes to the CLIENT_FACILITY_ID and CARRIER_FACILITY_ID options (lines 44-48). They will be ignored by PB Expedited.

  • Changes the name and value of the first object in the references array in order to pass a reference specific to the PB Expedited shipment (lines 55-56).

    Note that the Expedited request does not change the other objects in the references array (lines 58-62). These will continue to pass references for PB Standard, but you can ignore them when parsing the response.

Standard Delivery Shipment:
 1 {
 2     "fromAddress": { ... },
 3     "toAddress": { ... },
 4     "parcel": {
 5         "weight": {
 6             "unitOfMeasurement": "OZ",
 7             "weight": 8
 8         },
 9         "dimension": {
10             "unitOfMeasurement": "IN",
11             "length": 6,
12             "width": 1,
13             "height": 4
14         }
15     },
16     "rates": [ {
17         "carrier": "PBCS",
18         "serviceId": "PRCLSEL",
19         "parcelType": "PKG",
20         "specialServices": [ {
21             "specialServiceId": "DelCon",
22             "inputParameters": [ ]
23
24
25
26
27
28
29         } ]
30     } ],
31     "documents": [ {
32         "size": "DOC_4X6",
33         "fileFormat": "PDF",
34         "contentType": "URL",
35         "type": "SHIPPING_LABEL"
36     } ],
37     "shipmentOptions": [ {
38         "name": "SHIPPER_ID",
39         "value": "9024324564"
40       },{
41         "name": "ADD_TO_MANIFEST",
42         "value": "true"
43       },{
44         "name": "CLIENT_FACILITY_ID",
45         "value": "0093"
46       },{
47         "name": "CARRIER_FACILITY_ID",
48         "value": "1585"
49       },{
50         "name": "PRINT_CUSTOM_MESSAGE_2",
51         "value": "Thank you for shopping with us!"
52       }
53     ],
54     "references": [ {
55         "name": "ReferenceNumber",
56         "value": "00029147"
57       },{
58         "name": "AddlRef1",
59         "value": "124C78d576-5432"
60       },{
61         "name": "AddlRef2",
62         "value": "CC4321"
63     } ]
64 }
Expedited Delivery Shipment:
{
    "fromAddress": { ... },
    "toAddress": { ... },
    "parcel": {
        "weight": {
            "unitOfMeasurement": "OZ",
            "weight": 8
        },
        "dimension": {
            "unitOfMeasurement": "IN",
            "length": 6,
            "width": 1,
            "height": 4
        }
    },
    "rates": [ {
        "carrier": "USPS",
        "serviceId": "PM",
        "parcelType": "PKG",
        "specialServices": [ {
            "specialServiceId": "DelCon",
            "inputParameters": [ ]
        },{
            "specialServiceId": "Ins",
            "inputParameters": [ {
                "name": "INPUT_VALUE",
                "value": "50"
            } ]
        } ]
    } ],
    "documents": [ {
        "size": "DOC_4X6",
        "fileFormat": "PDF",
        "contentType": "URL",
        "type": "SHIPPING_LABEL"
    } ],
    "shipmentOptions": [ {
        "name": "SHIPPER_ID",
        "value": "9024324564"
      },{
        "name": "ADD_TO_MANIFEST",
        "value": "true"
      },{
        "name": "CLIENT_FACILITY_ID",
        "value": "0093"
      },{
        "name": "CARRIER_FACILITY_ID",
        "value": "1585"
      },{
        "name": "PRINT_CUSTOM_MESSAGE_2",
        "value": "Thank you for shopping with us!"
      }
    ],
    "references": [ {
        "name": "Order_Number",
        "value": "E-536-858-dfe-08"
      },{
        "name": "AddlRef1",
        "value": "124C78d576-5432"
      },{
        "name": "AddlRef2",
        "value": "CC4321"
    } ]
}