Pacejet

Building a New 3PL or Carrier Integration with Descartes Pacejet™


Requirements, Design Decisions, and Lifecycle Management

When a new 3PL or carrier integration is requested, our goal is not to build a one-off connection for a single customer. We build productized connectors designed for reuse, scalability, and long-term maintainability.

This article outlines the required resources, technical decisions, development process, and lifecycle management approach used when integrating a new 3PL or carrier into Descartes Pacejet™.

The intended audience includes:

  • 3PL technical teams

  • Carrier API teams

  • Pacejet developers

  • Customers requesting new integrations


Required Technical Resources From the 3PL or Carrier

Before development begins, the following resources are required.

  • Complete API Documentation - We require:

    • Rating endpoints

    • Shipment creation endpoints

    • Cancellation endpoints

    • Tracking endpoints

    • Pickup scheduling, if supported

    • Accessorial handling documentation

    • Authentication specifications

    • Error response formats
      Documentation must reflect current production behavior and include example payloads and responses.
      If multiple APIs exist for rating and shipping, their interaction must be clearly documented.

  • Dedicated Sandbox Environment - A fully functional sandbox is required for development and testing. The sandbox must support:

    • Rating

    • Shipment creation

    • Label and BOL generation

    • Accessorial application

    • Tracking simulation

    • Error handling
      Sandbox environments that only support rating but not shipment execution are insufficient.
      The sandbox must reflect production behavior as closely as possible.

  • Authentication and Account Access Model - We need clarity on how customers will authenticate within the integration. Key questions include:

    • Are credentials customer-specific or shared?

    • Is OAuth, API key, or token authentication used?

    • How are credentials refreshed or rotated?

    • Can multiple customer accounts be supported within a single integration?
      We must understand how Pacejet customers will configure their accounts inside the connector.

  • Service Definitions and Capabilities - The integration must clearly define:

    • Modes Supported

      • LTL

      • Small parcel

      • International freight

      • Hazardous freight

    • Service Areas

      • Domestic only

      • Cross-border

      • International

      • Region-specific limitations

    • Classes of Service

      • Standard

      • Expedited

      • Guaranteed

      • Economy

      • White-glove or specialized services

    • Available Accessorials

      • Liftgate

      • Residential

      • Inside delivery

      • Limited access

      • Appointment required

      • Hazmat
        Accessorial codes must be documented, including how they are requested and how they appear in rating and shipping responses.

  • Key Contacts - We require:

    • Technical API contact

    • Product owner contact

    • Escalation contact

    • Sandbox environment administrator
      Clear communication channels are critical during development and post-launch support.


Key Design Decisions During Integration Development

Each connector requires architectural and operational decisions.


Pro Number Assignment

We determine:

  • Is the Pro number generated at shipment creation?

  • Is it returned synchronously?

  • Can it change after tender?

  • Is it available in tracking responses?

Pro number lifecycle must be clearly defined.

Tracking Model

We evaluate:

  • Is a tracking API available?

  • What tracking statuses are returned?

  • Is a public tracking URL available for customer-facing use?

If a public tracking link is supported, we determine how it is constructed and embedded into the ERP record.


Label and Document Format

We confirm:

  • Supported label formats such as PDF, ZPL, or EPL

  • BOL generation responsibility

  • Multi-page document handling

  • International documentation support

Document standards must be consistent across customers.

Test Mode and Production Mode

Customers typically begin in test mode.

We define:

  • How test credentials are configured

  • How endpoints switch between sandbox and production

  • Whether separate accounts are required

  • Validation steps before production activation

Activation to production must be controlled and auditable.

Upgrade and Version Compatibility

Carriers and 3PLs frequently enhance APIs.

We assess:

  • Backward compatibility

  • Deprecation timelines

  • Versioning strategy

  • Change notification process

Integrations must support safe upgrades without breaking existing customers.


Pacejet’s Connector Development Model

We do not build custom integrations per customer request. We build reusable, version-controlled connectors designed for many customers.


One Build, Many Customers

Each connector is:

  • Architected as a productized module

  • Designed for configurable customer credentials

  • Abstracted to support multiple accounts

Once built, the connector becomes part of the carrier library.

Version Control and Release Management

All integrations are:

  • Version controlled

  • Regression tested

  • Documented internally

  • Released in structured updates

When enhancements are required, updates are made centrally rather than per customer.

Carrier Library Publication

After testing and validation, connectors are:

  • Published in the Pacejet carrier library

  • Made available for fast activation

  • Configurable through standard activation workflows

This enables rapid onboarding for new customers using the same 3PL or carrier.

Fast Activation Model

Once an integration exists:

  • Customers configure credentials

  • Services and accessorials are mapped

  • Test mode validation is completed

  • Production is activated

This activation process is significantly faster than initial development.

Continuous Enhancement

As carriers and 3PLs evolve their APIs:

  • Enhancements are incorporated into the productized connector

  • Updates are deployed centrally

  • Customers benefit from improvements automatically

This model reduces fragmentation and long-term maintenance risk.

Summary: What’s Needed to Build a New Integration

To create a new 3PL or carrier connector, we require:

  • Complete API documentation

  • Fully functional sandbox environment

  • Clear authentication model

  • Defined service areas and accessorials

  • Label and tracking specifications

  • Design alignment on Pro numbers and shipment lifecycle

  • Stable versioning and upgrade strategy

  • Technical and business contacts

Our objective is to build integrations that are scalable, reusable, and maintainable across the entire customer base.

By following a structured, productized connector model, Descartes Pacejet™ ensures new 3PL and carrier integrations are not only technically sound but also operationally sustainable over time.