Pacejet

Creating and Using Custom Data

Overview

The Custom Data Configuration page under Tools>Custom Data>Custom Data Configuration provides tools to add, delete, or search through custom field definitions. Custom field definitions can include common types such as Text, Checkbox, Date, Large Text, and Numeric.

Before your integration can start sending Custom Data fields to Pacejet, the fields must first be defined in the Custom Data Configuration page.


How To Define Custom Data

Defining Custom Data fields is as easy as clicking the plus icon on the Custom Data Configuration page, selecting a Source, choosing a type, and entering both a field Name and an optional Alternate Name. The field Name is the primary reference name for this field as it will be passed by integrations and the Alternate Name can be used to provide a more user-friendly name for the user interface or on paperwork.

  1. Click Tools>Custom Data>Custom Data Configuration.
    mceclip0.png

  2. Click the Plus icon to Add Custom Data.

  3. Select the desired Source.
    mceclip1.png

  4. Enter the desired Name and Alternate Name.

  5. Select the desired data Type from the dropdown menu.
    mceclip2.png


PaceJet API Endpoints and Custom Data

Once a Custom Data field is defined in Pacejet, integrations can pass the field in via the standard name/value pair definitions shown below. Pacejet API endpoints support passing in Custom Data fields at the shipment, package, or product/item level using the same naming convention. The Pacejet API ShipmentConfirms and ShipmentConfirmsContainers endpoints include support to retrieve Custom Data fields as well.

mceclip3.png


Finding Custom Data On the Rate & Ship Page


Custom Data In the Shipment Details Section

Once Custom Data fields are defined, users can also click the View Custom Data icon View_more_data.png on the Rate and Ship page if Custom Data fields are available at the shipment level. Clicking the link will provide quick pop-up summary of custom data fields.

For more detail or to edit custom data fields at the shipment level, users can click on the edit link to bring up a drill-down screen with editing support.

mceclip5.png


Custom Data In the Package Information Section

In addition to shipment-level display and editing of Custom Data fields, Pacejet also supports access to package-level fields.