Reference Fields

Parent Topic: All FAQs

Can merchants associate reference fields with shipments?

Yes, for the carriers listed on this page, merchants can associate reference fields with shipments. Reference fields (also called reference numbers or reference IDs) are identifiers that merchants define, such as order numbers or customer IDs.

Merchants can add reference fields to either shipment labels, shipment data, or both, depending on the carrier. See the carrier for details:

USPS

Merchants can print reference fields on shipping labels. To do so, merchants set one or both of the following options in the shipmentOptions array when creating a shipment:

PB Presort

Merchants can print reference fields on shipping labels for certain types of parcels. To do so, merchants set one or both of the following options in the shipmentOptions array when creating a shipment:

For the supported parcel types, see each option’s description in Shipment Options.

PB Standard

Merchants can include reference fields both in the shipment data and on the shipping label:

  • To include reference fields in the shipment data, the merchant enters the fields in the references array when creating a shipment. See the References Array section of the PB Standard Delivery page.
     
  • To include reference fields on the shipping label, the merchant uses the PRINT_CUSTOM_MESSAGE_2 shipment option in the shipmentOptions array when creating a shipment.

CBDS

For the PB Cross-Border Delivery Service, merchants can associate order IDs with shipments. CBDS includes the order IDs in tracking files and invoices.

To associate an order ID, the merchant enters the ID in the references array when creating the shipment. Depending on the merchant’s CBDS delivery solution, this information is either required or recommended. For details, see the References Array section of the Create a CBDS Shipment page.

FedEx Reference IDs

Merchants can print reference fields on shipping labels. To do so, merchants set the PRINT_CUSTOM_MESSAGE_1 shipment option in the shipmentOptions array.