Activate integration

In SAPIENT, carrier integration plays a crucial role in streamlining shipping processes for eCommerce businesses. The integration allows seamless connectivity with multiple carriers, enabling you to easily manage and monitor their shipping operations from a single platform.

💡

Tip

You may need to refer to this section every time you wish to activate a new integration. Therefore, we recommend you to get familiar with this section and understand the icons and functionalities offered in the SAPIENT platform.

Access integrations page

This section explains the components available on the Integrations page of the SAPIENT platform. The Integrations page displays the carrier(s) that are available or coming soon to the platform. Each carrier has its own specific block with its description of what it offer as well as showcasing its available integration types. You can click into the carrier specific page by clicking their logo or the Learn More button.

To access the Integrations page, perform the steps as explained in the following procedure:

  1. Log in to the SAPIENT platform using your credentials.
Logging into SAPIENT

Logging into SAPIENT

  1. On the Home page that opens, in the left navigation panel, select Integrations.
Accessing integrations

Accessing integrations

🚧

Important

The Integrations page contains access to some services that are chargeable, the associated fees are stated during the process. If you activate any of the chargeable services, you will be invoiced directly and any associated usage fees will be applied going forwards. Only approved personnel should be given permission to access these pages and activate these services from your company.

  1. On the Integrations page that opens, next to each carrier, the following integration types are displayed with their corresponding icons and symbols. Please select the needed integrations as per your business requirements.
Selecting integrations

Selecting integrations

Integration types and iconsDescription
Create shipments and labels.
Receive tracking data for shipments via the tracking webhook.
Retrieve a list of available <<glossary:Pick-up and Drop-off (PUDO)>> locations for local collect and return services.
Arrange the collections via an API. Mostly referred to as the home collection service.
Manage compliance with cross-border trade.
Get more information on the carrier-specific integrations and services.
Represents the integrations that are not yet available and coming soon!
Represents the integrations that are available on the platform but are not activated by you.
Represents the integration that are activated and ready to be configured.

After viewing the general information, you may select a particular carrier that you wish to integrate and learn more about its additional features and services.


View carrier-specific integrations

The carrier-specific integrations can be accessed by selecting the carrier on the Integrations page. The carrier-specific page provide you with the full range of additional features and services offered by that carrier that includes the following:

  • Top Services: this block highlights the primary services offered by the carrier, such as standard shipping, international delivery, tracking options, special delivery, and so on.
  • Top Features: this block entails the key functionalities that enhance the user experience and operational efficiency. This may include real-time tracking capabilities, automated label generation, home collection services, and much more.
  • Useful Links: this block provides valuable resources for users, such as direct links to the carrier's website, API documentation, user guides, FAQs, and support contact information.

Additionally, you can also see the list of available integrations types for that carrier.

Viewing carrier-specific integrations

Viewing carrier-specific integrations


Activate integration

After you have viewed the carrier-specific integrations and have decided to move forward with that carrier, you can now activate the integration. To do so, follow the instructions provided in the following procedure:

  1. Select the carrier the carrier that you want to integrate and then choose the integration that that you want to activate for that carrier.
  2. Based on your selected integration type, you may see one of the following Integration Activation screens.
Available integrationPricing and contract agreementUpcoming integrations
  1. In the Integration Activation screen, select the Terms and Conditions checkbox to agree to the company's terms on accessing and using their services.

🚧

Important

You can only use the integration once you have activated it.

  1. After the integration is activated, you can now start configuring it. For more information on how to configure the integration, refer to the Carrier specific user guides and the Additional services guides section.

Once the activation is confirmed, the system sends an email to the main user on the account as well as to the one who activated the integration.

📘

Note

If you do not see the carrier(s) you are looking for, please reach out to our Customer Solutions team at [email protected] and we can consider getting these added in our upcoming deployment.