Reference Fields

← Back to All FAQs

Overview

Reference fields (also called reference numbers and reference IDs) are custom identifiers you can add to a shipment, such as order numbers or customer IDs. How you add reference fields depends on the carrier. You can add reference fields for the following carriers:

PB Expedited

You can print reference fields on the shipping label. To do so, include one or both of the following in the shipmentOptions array:

PB Presort

You can print reference fields on the shipping label. To do so, include one or both of the following in the shipmentOptions array. 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 store reference fields in the shipment data and print reference fields on the shipping label:

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

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

Cross-Border Delivery Service (CBDS)

You can associate the order ID with a shipment. CBDS will include the ID in the tracking file and invoice. To associate the 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

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