ESW Onboarding Requirements and Configuration Guides [Information]

Modified on Tue, 7 Jul at 1:11 PM


Onboarding and Configuration	Baseline Account	(Billing) Account	Order-Level Fields
You are here

This article is the central hub for adding ESW with techSHIP. It summarizes onboarding requirements, links the related configuration guides, and lists confirmed carrier-specific constraints.

To review all supported carriers and their specific requirements, see: techSHIP supported Carriers - Master List [Guides List].

TABLE OF CONTENTS

Onboarding Requirements
- Information to be Provided
- Settings to be Verified
Setup Articles
Carrier Specifications and Constraints
- Labels
- Operational Details
Next Steps

Onboarding Requirements

Before configuring ESW in techSHIP, gather the required credentials and verify the required account settings.

Information to be Provided

The following credentials and data points must be available before starting the setup:

DATA ELEMENT	SOURCE / VALIDATION
Client Id	Obtain the Client Id from ESW for the brand integration.
Client secret	Obtain or generate the Client secret through ESW using an authorized account.
Brand code	Obtain the ESW brand code and confirm whether it will be configured in the Baseline Account, the Client (Billing) Account, or both.
ESW order reference	Confirm the source value that identifies the existing ESW order and is sent as orderReference.
Package reference	Confirm the source value sent to ESW as packageReference during package creation.

Settings to be Verified

The following account settings should be validated before configuring or testing the integration:

FEATURE / SETTING	VALIDATION ACTION
Billing Type	Confirm that ESW is configured as a Consolidator carrier.
Carrier code	Confirm that the configured carrier code is ESW.
Brand code location	Confirm whether the Brand code will be configured in the Baseline Account, the Client (Billing) Account, or both.

Setup Articles

Use the setup articles below to complete the setup in order. Start with onboarding requirements, then configure the Baseline Account, Client (Billing) Account, and optionally, Order-Level Fields. Select an article number to open the corresponding guide:


COMPONENT	ONBOARDING REQUIREMENTS	BASELINE ACCOUNT	(BILLING) ACCOUNT	ORDER-LEVEL FIELDS
Mandatory
Scope	Requirements	Carrier	Client	Transaction
Description	Identifies the required onboarding information and organizes the related setup guides for this carrier.	Establishes the carrier connection. Must be created first.	Connects a specific client to the Baseline. At least one is required to ship.	Defines order-level fields and settings used when processing shipments for this carrier.

Carrier Specifications and Constraints

This section outlines confirmed operational behaviors, document support, label support, and limitations specific to this carrier.

Labels

The following table summarizes confirmed label support:

ITEM	SUPPORTED
Label	Supported. Confirmed label formats are ZPL and PDF.
References	Supported with Reference 1 and Reference 2.

The table below summarizes the confirmed Label References support for ESW:

CONSTRAINT TYPE	LIMIT / REQUIREMENT
Supported references	Reference 1 and Reference 2
Reference count	2
Reference 1 use	Sent to ESW as orderReference.
Reference 2 use	Sent to ESW as parentOrderReference when configured.
Package reference source	Sent from Additional Carrier Data 1 as packageReference.
Character limit	Not Confirmed

Confirm the expected label format with ESW before setup. The label format is configured by ESW and is not changed on demand in the package creation request.

For a comprehensive guide on how to use label references, see: Using order References in your labels [Step-by-Step guide].

Operational Details

This section lists confirmed operational rules and limitations for this carrier:

ESW is configured as a single-code Consolidator carrier in techSHIP.
ESW handles final carrier and service selection internally for existing ESW orders.
techSHIP does not rate-shop ESW shipments.

Orders must already exist in ESW before they are processed in techSHIP. Use Reference 1 to provide the existing ESW order reference.

Do not configure RETURN as the Order type unless ESW confirms support for the client.

Next Steps

After reviewing the onboarding requirements, continue with the Reference Data: ESW Baseline Account Fields [Guide] article to configure the carrier connection in techSHIP.

	Go to

Onboarding and Configuration	Baseline Account	(Billing) Account	Order-Level Fields