Sendcloud WMS Integration Configuration Guide
Overview
This document describes how to configure the Sendcloud shipping integration in Boltrics, including marketplace setup, message types, and shipping configuration. Use this as a reference when you implement your Sendcloud shipping integration flows.
Sendcloud is a shipping platform that provides multi-carrier shipping solutions. This integration allows you to automatically create shipping labels and update the shipment with tracking information.
Prerequisites
- Access to Boltrics system with integration configuration permissions
- Understanding of shipping concepts and package configuration
- Access to DataHub for flow management
- Sendcloud account with API credentials (PublicKey and SecretKey)
- Active DataHub EDI subscription
- Contact with Sendcloud representative to obtain required credentials
Step-by-Step Configuration Process
1. Preparation
Before you start integrating with Sendcloud, you need to obtain the necessary credentials from Sendcloud.
Key Requirements:
- Contact your Sendcloud representative or access your Sendcloud account to obtain the following credentials:
- PublicKey: Your Sendcloud API public key
- SecretKey: Your Sendcloud API secret key
đ Important: See the Sendcloud documentation for how to create or request these credentials: https://support.sendcloud.com/hc/en-us/articles/360024967012-Sendcloud-API-documentation-and-Quick-Start-Guide
2. Marketplace Configuration (Installing Sendcloud Interface in Boltrics 3PL Dynamics)
The integration with Sendcloud can be initialized from the 3PL Marketplace. This will configure the entire integration with the credentials you obtained from Sendcloud.
Installation Process
Install Sendcloud Integration The Sendcloud marketplace item will configure the DataHub and Boltrics 3PL Dynamics completely. During installation, you will be prompted to enter:
- PublicKey (obtained from Sendcloud)
- SecretKey (obtained from Sendcloud)
- Label Format: Choose whether labels should be retrieved as ZPL or PDF (ZPL is recommended)
đĄ Best Practice: It is recommended to set the label format to ZPL during installation.
After installation, a message type will be installed in your 3PL Dynamics environment:
- SND-SENDCLOUD-BOOKIN: Sends shipment data to Sendcloud and receives Label information and tracking data.
- The connection with Sendcloud via the DataHub is set up
3. 3PL Dynamics Configuration
After installation, 3PL Dynamics must be configured by a Logistics Consultant. The following sections describe the relevant configuration information.
3.1. Shipping Agent Setup
đĄ Best Practice: Create a single Shipping Agent named "SENDCLOUD" that includes all service levels
Shipping Agent Service Configuration:
- Code and description: Configurable as needed
- Service Level Time: Must contain corresponding SendCloud service ID
- Service Level Time 8: Default shipping rules from SendCloud
âšī¸ Note: Contact SendCloud to determine your available service levels
3.2. Document Header Conditions
Configure the following conditions on document headers:
| Condition | Purpose | Type |
|---|---|---|
| SENDCLOUDC | Sendcloud Multi Collo - Set on Shipping Agent Service Level | BOOLEAN |
| SENDCLOUDS | Sendcloud ID of the Sender Address - Set on customer level | TEXT |
3.3. Track and Trace URL
The tracking URL is stored in the record links when SETTRACKINGURL parameter is set to "YES" in the message type configuration.
4. Package Configuration
đ Important: The carrier number of the detail line must match the "Marks & Numbers" of the package line to determine which goods are packed in which package.
Package Matching:
- No match: No package contents will be created per package (not an issue for EU shipments)
- Multi Colli: Combine multiple parcels into one shipment for coordinated delivery
- â ī¸ Note: Multi Colli shipments are only possible within the EU
- đ See Multicollo Documentation
4.1. Multi Collo Settings
To create labels as multi collo, configure:
| Setting | Configuration |
|---|---|
| Document header | Include condition "SENDCLOUDC" with value "YES" |
| Ship to address | Must be an EU country (The 'EU Country/Region Code' field must be filled) |
4.2. Document Package Line Values
| Field | Description |
|---|---|
| NumberofPackages | Number of packages (default: 1) |
| AirwayBillNo | Contains tracking ID upon receipt of label |
| Package Status | Contains "ZPL" or "PDF" upon label receipt |
| Marks & Numbers | Determines which goods are in which colli (mandatory for non-EU shipments) |
4.3. Label Handling
- ZPL Labels (Recommended): Stored in the matching colli line blob
- PDF Labels: Stored in the record links of the first colli line
The trigger for creating a SENDCL-CREATE-PARCEL message can be configured via status change or scan trigger. See Message Type Setup for more details.
5. Message Type Setup
5.1. SENDCL-CREATE-PARCEL Configuration
Message Type Details:
- Object ID: 11172797
- Function ID: 110
- Transport Locations:
- PROD: Find URL in Datahub flow "Sendcloud labels" (Navigate via Flow Mgt in ribbon â Copy URL)
Message Type Parameters:
| Parameter | Value | Description |
|---|---|---|
| ADDPDFTOSPECLINE | YES | Add PDF to specified package lines |
| SETTRACKINGURL | YES | Store tracking URL in record links (optional) |
5.2. Trigger Configuration
The message can be triggered via:
- Status change: Configure status function to trigger on status change
- Scan trigger: Configure to trigger when package is scanned
6. Non-EU Shipments Configuration
For shipments outside the European Union, additional configuration is required.
Required Settings:
- Marks & Numbers: Must match carrier number of detail line with colli line
- EU Country/Region Code: Must be blank for non-EU addresses
Additional Document Line Requirements:
| Field | Description |
|---|---|
| TariffNo | HS code set on the item |
| CountryofOriginCode | Origin country set on the item |
| CustomsValueper | Value on the item (defaults to 0 for samples) |
7. Label Processing and Monitoring
Once the integration is configured, shipping labels will be automatically created and processed through Sendcloud.
Label Flow Process
When a shipment is prepared and the trigger condition is met:
- The system creates a message in message type SND-SENDCLOUD-BOOKIN
- The message is sent to the DataHub
- In the DataHub, you can find the transaction in the "Sendcloud labels" flow
- The label (ZPL or PDF) is retrieved from Sendcloud and stored in the Packages.
- The tracking ID is stored in the AirwayBillNo field of the Package line
- The label format is stored in the Package Status field of the Package line
Monitoring and Troubleshooting
integration messages
- DataHubErrorAnalysis.md - Comprehensive guide for analyzing and resolving DataHub errors
Transaction Status
You can monitor the status of your label transactions by:
- DataHub Flow List: View all configured flows and their transaction counts
- Transaction Details: Click on transaction numbers to see detailed processing information
- Error Analysis: Use the error analysis guide to troubleshoot any issues
- Restart Transactions: Restart failed transactions after resolving underlying problems
Support Resources
- DataHub Error Analysis: Error Analysis Guide
- DataHub Transactions: Transaction Management
- Sendcloud API Documentation: Sendcloud API Guide
- Sendcloud Multicollo: Multicollo Documentation