Overview

The embedded request document is an example Shipments request intended to help integrators better understand the shipments data relationships and more easily test different data mapping scenarios. The request includes a nearly complete set of the optional data fields with most of the example data commented out so it is ignored by the parser (note: recall that officially JSON does not support comments but this example is using // marks on field names to cause the parser to ignore them). This sample is also available in the Shipments sample page, where it can be selected and edited to try different data scenarios.

Using the Full Shipments Request on the Samples Page

Open the 28 Full Shipments Request with Comments sample, select the entire contents, visit the page API | Samples, click on Shipments, click on PUT, and paste the contents into the request box. As shown below, the request can now be sent to Pacejet multiple times while changing different content fields to test out various data mapping scenarios. Note that you may need to edit the TransactionID field if you receive a duplicate error since other users in the shared sandbox may be testing with this sample example.

After pasting the request into the samples page and submitting the Shipments request, open a new tab on the shipping workbench, click the Z key, and enter the transaction ID to bring up the shipment. View the contents of the shipment as illustrated below, taking note of the shipment details section, the package information, the items packed into containers, the international section, and other details in this sample shipment.

Change the Freight Terms and Remove the Carrier Preset

To test an adjusted sample transaction, edit the request directly in the request page on the samples page for shipments. First, insert the // characters in front of the ShipXRef field to “comment out” this preset cross reference which is currently set to UPS Ground.

Scroll down and edit the freight terms by inserting // in front of the Prepaid and Charge and deleting the // characters in front of the Prepaid setting. Scroll down and delete the // in front of the SaturdayDelivery shipping service as shown below.

After editing the request, click Run to execute the PUT for Shipments to update the resource in Pacejet. Switch to the previously opened tab for the shipping workbench, click the Z key, reenter the transaction ID, and load the shipment. Notice the edited shipment has freight terms of Prepaid, the carrier is no longer preset to UPS Ground, and the Saturday Delivery special service is visible.