Reference Fields on Shipping Labels

Julie  Houlton
Julie Houlton
  • Updated

RyderShip’s label buy process now supports passing values for up to 5 reference fields, depending on the carrier’s label requirements. Please be aware of the carrier's expectations and limitations with reference fields. We recommend that you send the specific carrier service method and the supported reference fields on the order.

See the mapping information below and our RyderShip Developer Library for more details.

Mapping reference fields for shipping labels

Important:  Currently, RyderShip can only pass reference field values via API at this time.

Any value in the RyderShip reference fields will be passed through to our label provider. No additional validation is provided

For information about how our label provider, Shipium, expects reference fields to map to individual carriers, see Shipium Reference Fields and Carrier Mappings.

Use the information below to map the RyderShip’s Reference fields to similar reference fields for the label buy provider. 

  • reference_identifier
  • reference_identifier_2
  • reference_identifier_3
  • reference_identifier_4
  • reference_identifier_5

If you send more than the supported reference fields for a specific carrier, the label buy process will not fail. Please ensure you have designated the carrier service and are sending the supported fields.

Other important notes: 

If RyderShip’s reference_identifier field or package_label_reference field is null or blank, the label’s referenceIdentifier will default to the RyderShip order ID.

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.