Overview
The Pacejet platform supports receiving custom fields from the ERP in various formats with visibility of what was imported through the Rate and Ship screen icon as selected in the Custom Data screen.
Custom data fields can be included at the shipment, package, and item levels. The number of Custom data imports is not limited.
Step 1: Implementation
Follow these steps for implementation before proceeding to the steps for configuration.
-
Configure your ERP system to import the specific custom fields into Pacejet by:
Determining if the Pacejet API can access the specific custom field.
Validating that the specific ERP custom field is being imported in the JSON or xml import.
Define the field name in the Pacejet integration script /API plug-in.
Verify that the spelling is correct and the case is the same.
Step 2: Configuration
You will need to configure the custom data before you can begin using it.
Configuring the Custom Data
Configure the Custom data to the shipment, package, or item level.
Follow the steps below to configure the custom data:
From the Tools drop-down menu, click Custom Data, and then click Custom Data Configuration.
-
Do one of the following:
Click the row of the custom data you would like to edit.
Click the plus
icon to add new custom data.
In the Source drop-down list, click to select shipment, package, or item, etc.
In the Name field, enter the exact name of the Custom field being imported from the ERP.
Example: Custcol_wmsts_pj_linelevelpickcartonsIn the Alternative Name field, enter a name that you will recognize.
Example: Pick Carton ID.In the Type drop-down list, select a type. Refer to the table below.
Click Done.
Type |
Explanation |
Text |
Anything; from 1 to 500 characters allowed |
Checkbox |
This is either true or false. |
Date |
Date |
Large text |
Anything; from 1 to 4,000 characters allowed |
Numeric |
Numbers only, no special characters |
Validating the Imported Data
Data viewing is typically a verification step performed during implementation. Once the process is verified, the user generally ignores the data.
Follow the steps below to validate the imported data:
Reimport the test order performed in the implementation step above.
-
Validate that the custom data has been imported into Pacejet by doing one of the following:
From the Rate & Ship screen, click the Custom Data icon.
From the menu, click Tools, and then click Custom Data.
Examples for Defining User Fields with the API Request
Examples are provided for the Shipment Level and Product Level
Custom Fields at the Shipment Level
Custom fields at the shipment level are specified by including a list of name/value pairs to identify a field name and a field value. The transaction-level auto packing feature is an example plug-in feature implemented using Custom fields (example below). Other data fields can be included, manipulated using Pacejet plugins, custom rate rules, other features, or included on paperwork.
Custom Fields at the Product Level
Custom fields at the product level are specified in the ProductDetailsList section of data and follow the same convention of name/value pairs used for shipment level fields. Product level fields are generally used to assign new attribute data for paperwork, custom rate rules, or plug-in behaviors.