Reference Fields

← Back to All FAQs

Overview

Reference fields (also called reference numbers and reference IDs) are identifiers you can add to a shipment. For example you might add an order number or customer ID. You can add reference fields for the following carriers. Click the carrier for details:

PB Expedited (USPS)

You can print reference fields on the shipping label, and you can store reference fields in the response data. Do one or both of the following:

  • To print reference fields on the shipping label, include one or both of the following options in the shipmentOptions array when creating the shipment:

  • To store reference fields in the response data, enter the fields in the references array when creating the shipment. The information is returned in the API response.

PB Presort

You can print reference fields on shipping labels. To do so, include one or both of the following shipment options in the shipmentOptions array when creating shipments. Note that you can print reference fields for certain parcel types only. For details, see the definition of each shipment option:

PB Standard

You can print reference fields on the shipping label and store reference fields in the shipment data:

  • To print reference fields on the shipping label, include the PRINT_CUSTOM_MESSAGE_2 shipment option in the shipmentOptions array when creating the shipment.
     

  • To include reference fields in the shipment data, enter the fields in the references array when creating the shipment. For details, see PB Standard References.

CBDS

For the PB Cross-Border Delivery Service, you can associate the order ID with a shipment. CBDS includes the order ID in the tracking file and invoice.

To associate an order ID, enter the ID in the references array when creating the shipment. Depending on the your CBDS delivery solution, this information is either required or recommended. For details, see References Array in a CBDS Shipment.

FedEx Reference IDs

You can print reference fields on the shipping label by including the PRINT_CUSTOM_MESSAGE_1 shipment option in the shipmentOptions array when creating the shipment.