Support Portal

Welcome
Login

Carriers

This endpoint allows you to retrieve all available carriers that you can use to create shipments inside your Seven Senders account.

Endpoint

https://api.sevensenders.com/v2/docs.html#/Carrier/getCarrierCollection

Headers

Parameter
Mandatory
Description
API-KEY
YES
Your authorization key to access Seven Senders API

Methods

GET

Request

Curl example

curl -X "GET" -H "Accept:\ application/json" -H "Content-type:\ application/x-www-form-urlencoded" -H "API-KEY:\ <API-KEY>" http://api.sevensenders.com/v2/carriers.json

Response

The API will respond with an array of carriers, each element inside the array has the following properties.

 

Field
Type
Example
Description
carrier
string
"deutschepost"
Carrier identifier that should be used when you want to create a shipment via API
label
string
"Deutsche Post Mail"
Carrier business name
allowedCountries
array of strings
["de"]
List of country codes where the use of this carrier is allowed

Response to a GET carriers call

[{

  // ...

}, {

  "carrier": "deutschepost",

  "label": "Deutsche Post Mail",

  "allowedCountries": ["de"]

}, {

  "carrier": "colissimo",

  "label": "Colissimo",

  "allowedCountries": ["fr"]

}, {

  // ...

}]