Overview

Many carriers provide the ability to pass additional information to them via data fields to be associated with a shipment. While these fields are not generally used as part of the shipping process, they can associate additional data with a given package for use in reporting or billing.

Shipium supports passing of these fields as reference identifier fields and then maps them across carriers so they're applied in as consistent a manner as possible across carriers during the carrier selection and label generation process.

Some carriers require that specific information requirements be met when retrieving a label for a shipment. Shipium also supports inclusion of this information and then maps it to the carrier's required fields.

This document includes mappings from Shipium's reference identifier fields to the named reference fields for available carriers. It also provides information about specific carrier-required data.

Related fields

Many of the available carriers support specific related reference fields.

purchaseOrderIdentifier - This Shipium field can be populated as part of the shipment entity and maps to purchase order ID.
costCenter - This Shipium field can be populated as part of the carrier account to categorize expenses and maps to the carrier's corresponding cost center field. If this field is not populated, then one of the reference identifier fields may be used, as outlined below.

Specific reference field mapping by carrier

The reference identifier fields that follow are part of the shipment entity, whether you're creating shipments directly or using the Carrier and Method Selection with Label Single Call.

UPS

Shipium Reference Field	Carrier Reference Field
`referenceIdentifier`	`Reference 1`
`referenceIdentifier2`	`Reference 2`
`referenceIdentifier3`	`Reference 3`
`referenceIdentifier4`	`Reference 4`
`referenceIdentifier5`	`Reference 5`

UPS Mail Innovations (UPS MI)

Shipium Reference Field	Carrier Reference Field
`referenceIdentifier`	`PackageID`
`referenceIdentifier2`	`CostCenter`

FedEx

Shipium Reference Field	Carrier Reference Field
`referenceIdentifier`	`CUSTOMER_REFERENCE`
`referenceIdentifier2`	`P_O_NUMBER`
`referenceIdentifier3`	`INVOICE_NUMBER`
`referenceIdentifier4`	`DEPARTMENT_NUMBER`
`referenceIdentifier5`	`SHIPMENT_INTEGRITY`

USPS

Shipium Reference Field	Carrier Reference Field
`referenceIdentifier`	`ReferenceID`
`referenceIdentifier2`	`ReferenceID2`
`referenceIdentifier3`	`ReferenceID3`
`referenceIdentifier4`	`ReferenceID4`
`referenceIdentifier5`	(No mapping for USPS)

DHL

Shipium Reference Field	Carrier Reference Field
`referenceIdentifier`	`packageDescription`
`referenceIdentifier2`	`billingReference1`
`referenceIdentifier3`	`billingReference2`
`referenceIdentifier4`	(No mapping for DHL)
`referenceIdentifier5`	(No mapping for DHL)

Information requirements by carrier

Some carriers require specific information that Shipium must collect in calls to our APIs. Those required fields are provided here.

Global-e

Prior to shipping with Global-e, you must configure credentials in the Shipium Console. You'll provide a globally unique identifier (GUID) for Global-e Merchant ID and a hub ID for Global-e Hub Code.

For single-parcel shipments, the following additional required fields should be nested in the shipmentParameters property. For multi-parcel shipments, they should be included in multiParcelShipmentParameters.

Reference Field	Required/Optional	Field Properties	Description
`carrierProcessingId`	Required	String	You'll provide the order ID that was generated when the order was placed.
`referenceIdentifier`	Required	String Example: 123454321	String passed to carriers as a reference; a unique identifier you'll pass to identify the shipment; limited to 20 characters

A snippet of the JSON request for the API call with the required fields is included. This example is for a single-parcel shipment. A multi-parcel shipment would be included in multiParcelShipmentParameters.

{
"shipmentParameters": {

   "carrierProcessingId": "string",
   "referenceIdentifier": "123454321",
 ...
     }
}