ℹ️ Carrier Specific Information

What is a Carrier?

A carrier represents a shipping company that delivers parcels to customers. In Seven Senders, each carrier is defined by:

• Carrier Name - The shipping company (e.g., dhl, dpd, gls)
• Carrier Country - The country where the carrier operates (ISO 3166-1 alpha-2)

Together, these create a unique carrier identifier like dhl-DE or dpd-FR.

Getting Available Carriers

To retrieve the list of carriers available for your shop, use the Carriers API endpoint:

[GET] /carriers

This returns all carriers configured for your account, including:

• Carrier name and operating country
• Available service levels
• Tracking URL templates
• Carrier-specific requirements

The response helps you understand which carriers you can use when creating shipments.

Carrier Selection

Specify a carrier on shipment creation:

[POST] /shipments

{
  "recipient_country": "FR",
  "recipient_address": "123 Rue de Paris",
  "carrier": {
    "name": "dhl",
    "country": "DE"
  }
}

Carrier Service Levels

Choose the service level (optional) that matches your delivery needs (Service / Product / Tariff used by the carrier):

standard - Regular delivery (default)

express - Faster delivery

other - Alternative services

Example with service level:

{
  "carrier": {
    "name": "dhl",
    "country": "DE"
  },
  "carrier_service": "express"
}

Carrier Information in Responses

When you retrieve a shipment, the response includes carrier details:

{
  "id": 12345,
  "carrier": {
    "name": "dhl",
    "country": "DE"
  },
  "carrier_service": "standard",
  "tracking_code": "1234567890",
  "carrier_tracking_url": "https://www.dhl.de/tracking?code=1234567890"
}

tracking_code - Carrier's tracking number (populated after carrier processing)

carrier_tracking_url - Direct link to track the parcel (auto-generated)

Validation Rules

When specifying a carrier manually:

• Both the name and the country must be provided together
• The carrier-country combination must be available for your shop
• Use lowercase for carrier names ("dhl" not "DHL")
• Use ISO 3166-1 alpha-2 for country codes ("DE" not "Germany")

Valid Example:

{
  "carrier": {
    "name": "dpd",
    "country": "FR"
  }
}