Appearance
Carrier settings
The Carrier group holds, per carrier, the time the carrier picks up at the warehouse and the details Boxture needs to request shipping labels from the carrier connection. Find them under Admin › Settings › Carrier, or open a carrier under Admin › Carriers & Services › Carriers: the carrier page shows exactly these settings with the carrier already filled in as condition. For how levels and conditions work, see Settings; for carriers themselves see Carriers and shipping methods.
How carrier labels are requested
A carrier label (waybill) is requested automatically for a shipment when its carrier has an Integration method. Boxture sends the shipment to the configured Api endpoint, authenticated with the Authentication key, and stores the tracking number and label it gets back. Whether this happens when the order is fully packed or when the shipment is shipped is set by Create label on pack complete. See Labels and documents.
The credentials (account number, key, password, endpoint) are looked up per shipment, starting at the shipment's own account and moving up to its parent accounts. For each credential, the nearest account that has a value wins. This lets a 3PL set up one carrier contract on the top-level account, while a customer with its own carrier contract enters its own credentials on its own account.
Pickup time
| Key | carrier.pickup_time |
| Type | Time, as HH:MM |
| Default | 17:00 |
| Conditions | Location, Carrier, Service-type |
| Account lookup | The order's account |
At what time does the carrier come for pickup (local to the location).
Used to calculate the ship at of a sales order when it is allocated. An order allocated before the cutoff time gets ship at = today (or the next working day) at this pickup time. The carrier and service type are those of the order's shipping method; the location is the order's origin location.
Set a level per carrier and location, for example:
| Level | Location | Carrier | Value |
|---|---|---|---|
| 1 | Warehouse Venlo | DHL | 16:30 |
| 2 | Warehouse Venlo | PostNL | 18:00 |
| 3 | 17:00 |
Account number
| Key | carrier.account_number |
| Type | Text |
| Default | Empty |
| Conditions | Carrier, Service-type, Purpose, Location |
| Account lookup | The shipment's account, then parent accounts |
Account number.
Your customer or contract number with the carrier. The Purpose condition (Shipping or Customs) lets you store a separate account number for customs; labels are requested with purpose Shipping. The current label connection (Skepr) authenticates with the authentication key; the account number is kept with the carrier credentials.
Authentication key
| Key | carrier.authentication_key |
| Type | Text |
| Default | Empty |
| Conditions | Carrier, Service-type, Location |
| Account lookup | The shipment's account, then parent accounts |
Authentication key.
The API key or token for the carrier connection. It is sent as a bearer token with every label request. When it is missing, requesting a label fails with an error about the missing authorization key.
Authentication password
| Key | carrier.authentication_password |
| Type | Text |
| Default | Empty |
| Conditions | Carrier, Service-type, Location |
| Account lookup | The shipment's account, then parent accounts |
Authentication password.
A password for carrier connections that need one in addition to the key. The current label connection (Skepr) does not use it.
Api endpoint
| Key | carrier.api_endpoint |
| Type | Text (URL) |
| Default | Empty |
| Conditions | Carrier, Service-type, Location |
| Account lookup | The shipment's account, then parent accounts |
API Endpoint.
The URL Boxture posts the shipment to when requesting a label. When it is missing, requesting a label fails with an error about the missing API endpoint. If the carrier responds with an error, the label request fails and the error message from the carrier is shown in the notification.
Integration method
| Key | carrier.integration_method |
| Type | Choice: Porto, Skepr |
| Default | None |
| Conditions | Carrier, Location |
| Account lookup | Hierarchy (top-level account first) |
Integration method to use to communicate with the carrier.
Switches automatic label requests on for a carrier, and selects the connection. Without an integration method, no labels are requested from the carrier automatically.
Only Skepr is supported for label requests. Choosing Porto results in Integration method porto is not supported. when a label is requested.
The value is looked up from the top-level account down to the shipment's account; the first account that has a value for the carrier and location wins.