Shipment Options¶
Overview¶
The following are the shipment options that can be set in the shipmentOptions
array when creating and rating shipments.
Shipment Options¶
Name | Applies to
|
Description
|
---|---|---|
ADD_TO_MANIFEST |
USPS,
USPS PMOD (always true), PB Presort, PB Standard Delivery (always true) |
Set this value to For PB Standard Delivery and USPS PMOD labels, the system always sets this to
The following USPS shipments cannot be added to a SCAN form:
|
CARRIER_FACILITY_ID |
PB Standard Delivery,
PB Cross-Border |
The ID of the Pitney Bowes facility that will receive the parcel. This is either a PB Standard facility or a CBDS Consolidation Center. |
CLIENT_FACILITY_ID |
PB Standard Delivery,
PB Cross-Border |
An identifier for the merchant’s facility. Depending on the API call, this is either an ID that Pitney Bowes has assigned or an ID that the merchant has assigned. |
CLIENT_ID |
PB Standard Delivery,
PB Standard Returns, PB Cross-Border |
The merchant’s ID for access to a specific service. Note: The For test IDs for the Sandbox environment, see the following:
|
CLIENT_SERVICE_FLAG |
PB Standard Returns | For a PB Standard Returns
label, set this to Standard . |
DISPOSITION_RULESET_ID |
PB Standard Returns | For a PB Standard Returns label, the ruleset assigned to the merchant during onboarding for PB Standard Returns. The ruleset determines the routing and the disposition of the returned parcel. |
FUTURE_SHIPMENT_DATE |
USPS,
PB Standard Delivery, FedEx |
|
HIDE_TOTAL_CARRIER_CHARGE | USPS,
PB Presort |
Set the value to Note: When shipping to Brazil, set this option to |
IS_RECTANGULAR |
PB Standard Delivery
PB Standard Returns |
For a PB Standard shipment, indicates the parcel uses rectangular dimensions.
This is true by default. If you set this to false , you must set a
value for the irregularParcelGirth field in the Parcel Object. |
LABEL_ID | PB Standard Returns | RESPONSE ONLY. If a PB Standard Returns shipment creates a QR code, this
is the alpha-numeric identifier for the QR code. The actual QR code is
returned in the documents object. |
MINIMAL_ADDRESS_VALIDATION |
USPS,
PB Presort, PB Standard Delivery, PB Cross-Border, FedEx, UPS |
Domestic Addresses Only. When this is set to For details, see What is minimal address validation? By default, this option is |
NON_DELIVERY_OPTION |
USPS,
PB Presort, PB Standard Delivery |
Provides instructions if a parcel cannot be delivered. Applies to the following:
|
PERMIT_NUMBER |
PB Presort | The merchant’s permit number for flats for a PB Presort shipment. When shipping letters and flats through PB Presort, you must include the merchant’s permit number in the Create Shipment request. |
PRINT_CUSTOM_MESSAGE_1 |
USPS,
PB Presort PKG, PB Presort LGENV, FedEx |
Domestic Labels Only. Prints a merchant-defined message on the label. You can use this, for example, to print a merchant-defined reference field. The message position and font depend on the carrier:
|
PRINT_CUSTOM_MESSAGE_2 |
USPS,
PB Presort ( PKG parcel type only),
PB Standard Delivery, PB Cross-Border |
Prints a merchant-defined message on the label. You can use this, for example, to print a merchant-defined reference field. The message position and font depend on the carrier:
|
PRINT_IMBREADABLE_BARCODE |
Presort | If set to True , prints human-readable tracking information on a PB
Presort label that uses STANDARD mail with LGENV . By default, this
option is set to False . |
PRINTER_MODEL |
USPS,
USPS PMOD, PB Presort, PB Standard Delivery, PB Cross-Border |
Uses ASCII instead of Unicode to generate labels. This option is intended for older ZPL printers that do not support Unicode. By default, the PB Shipping APIs generate labels using UTF-8, which supports international characters. Important: If you request ASCII, international characters might not print properly. Consider contacting your Zebra printer provider to update your printer’s firmware to a version that supports Unicode. To request ASCII, set this option to {
"name": "PRINTER_MODEL",
"value": "ZP500"
}
|
RETURN_ID |
PB Standard Returns | For a PB Standard Returns label, this is a unique merchant-generated identifier for the label. The format used for Return IDs is set up in advance with merchant’s Pitney Bowes implementation team. |
SHIPPER_ID |
USPS,
PB Presort, PB Standard Delivery, PB Standard Returns, PB Cross-Border, FedEx, UPS |
The Shipper ID of the merchant on whose
behalf the label is being printed. The merchant’s Shipper ID is found
in the postalReportingNumber field in the Merchant Object. |
SHIPPING_LABEL_RECEIPT |
USPS,
PB Standard Returns |
DOC_8X11 Labels Only. Prints a receipt for the shipping label. Valid values are:
|
SHIPPING_LABEL_SENDER_SIGNATURE |
USPS | Adds the sender’s signature and the date on CN 22 and CP 72 shipping labels. Enter the signature as a String. The sender’s signature date is automatically populated. |
SMART_LABEL_BARCODE | PB Standard Returns | RESPONSE ONLY. The PB Standard SmartLabel® barcode number. This is different
from the shipment tracking number returned in the parcelTrackingNumber field. |