Carrier Country Service Mapping (CCSM)

This Concept supports in defining, checking & reassuring the presence of values needed for specific carrier & country combinations.

Overview & Idea

While Carrier companies such as DHL or FedEx serve the same business (in a nutshell: transporting goods from A to B) their APIs and Interfaces look and behave very differently. The access is very unique from carrier to carrier and also the provided information varies - even within the interface of the same carrier but with different source or destination countries.

In fulfillmenttools we use Carrier Country Service Mappings (or: CCSMs for short) in order to tackle this situation. They aim at easing the implementation of clients that gather all the information needed before even requesting a parcel label. In a way they serve as a template for successful label requests of an arbitrary order contents.

Description

A CCSM is definable per Carrier. The information it holds is structured in the following way:

Taking a look at the example above the following statements are useful to understand the concept:

• For carriers operated by fulfillmenttools you do not need to set any CCSM - it is provided by fulfillmenttools

• A carrier can have multiple or none Carrier Country Service Mappings. In case it does not have a set configuration for a needed source/destination combination increases the possibility of issues during runtime due to clients not knowing which data needs to be present

• A CCSM can have one source but multiple destinations to allow for configurations like "for every parcel with carrier X from Germany to France, the US, Canada or Sweden the following configuration is valid". This eases the configuration of new carriers and their often similar configuration

Example

Let's find out about the CCSMs of a carrier provided by fulfillmenttools. We start by retrieving the ID of the carrier we are interested in:

Returns all configured CEP partners

GEThttps://%%HOST%%//api/carriers

Authorization

firebase

Query parameters

Response

200401403404

The current list of available carriers

Body

application/json

carriersarray of StrippedCarrier (all of)

totalinteger

Total number of found entities for this query

Example: 42

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/carriers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "carriers": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "deliveryType": "SAMEDAY",
      "id": "climk4dcQFiPdA5ULuhS",
      "key": "text",
      "lifecycle": "GA",
      "name": "DHL Köln",
      "status": "ACTIVE"
    }
  ],
  "total": 42
}

In this example the response looks like this:

200 OK

{
    "total": 13,
    "carriers": [
        {
            "id": "2f7fc1c8-ed29-4772-814a-28c139919cc7",
            "name": "INTEX",
            "key": "INTEX",
            "deliveryType": "DELIVERY",
            "status": "ACTIVE",
            "version": 1
        },
        ...12 more...
    ]
}

We are facing a system with 13 configured carriers. We will take a look at INTEX in this example which is used for sending from germany to germany.

Let's fetch the CCSMs für said carrier

Get a CarrierCountryServiceMappings for carrier with given ID

GEThttps://%%HOST%%//api/carriers/{carrierId}/configuration/countryservicemappings

Authorization

firebase

Path parameters

carrierId*string

ID of the carrier you want to get the countryservicemappings for

Response

200401403404

Carrier's countryservicemappings found & you are allowed to access it. The result is in the body.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/carriers/{carrierId}/configuration/countryservicemappings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

200 OK

[
    {
        // deprecated fields omitted
        "id": "76486a41-f84c-4ebd-b46d-1654915ae8d4",
        "source": {
            "countryCode": "DE"
        },
        "destinations": [
            {
                "countryCode": "DE"
            }
        ],
        "mandatoryShippingItemAttributes": [
            {
                "referencedField": "quantity",
                "dataType": "Number",
                "descriptionLocalized": {
                    "en_US": "Quantity",
                    "de_DE": "Menge",
                    "nl_NL": "Hoeveelheid",
                    "fr_FR": "Quantité en grammes",
                    "it_IT": "Quantità",
                    "nb_NO": "Antall",
                    "es_ES": "Cantidad",
                    "pl_PL": "Ilość",
                    "ru_RU": "Количество"
                }
            },
            {
                "referencedField": "parcelItemValue.value",
                "dataType": "Number",
                "descriptionLocalized": {
                    "en_US": "Value per item",
                    "de_DE": "Wert pro Artikel",
                    "nl_NL": "Waarde per item",
                    "fr_FR": "Valeur par article",
                    "it_IT": "Valore per articolo",
                    "nb_NO": "Verdi per vare",
                    "es_ES": "Valor por artículo",
                    "pl_PL": "Wartość za sztukę",
                    "ru_RU": "Стоимость за штуку"
                }
            }
            {
                "referencedField": "parcel.values.insurance.currency"
                "dataType": "String",
                "descriptionLocalized": {
                    "en_US": "Currency",
                    "de_DE": "Währung",
                    "nl_NL": "Valuta",
                    "fr_FR": "Monnaie",
                    "it_IT": "Moneta",
                    "nb_NO": "Valuta",
                    "es_ES": "Divisa",
                    "pl_PL": "Waluta",
                    "ru_RU": "валюта"
                }
            }
        ],
        "mandatoryShippingAttributes": [
            {
                "referencedField": "pickUpInformation.startTime",
                "dataType": "Date",
                "descriptionLocalized": {
                    "en_US": "Start pickup time",
                    "de_DE": "Beginn Abholzeit",
                    "nl_NL": "Begin afhaaltijd",
                    "fr_FR": "Heure de début de l'enlèvement",
                    "it_IT": "Orario di inizio ritiro",
                    "nb_NO": "Starttidspunkt for henting",
                    "es_ES": "Hora de recogida",
                    "pl_PL": "Czas rozpoczęcia odbioru",
                    "ru_RU": "Время начала самовывоза"
                }
            },
            {
                "referencedField": "pickUpInformation.endTime",
                "dataType": "Date",
                "descriptionLocalized": {
                    "en_US": "End pickup time",
                    "de_DE": "Ende Abholzeit",
                    "nl_NL": "Eindtijd ophalen",
                    "fr_FR": "Heure de fin d'enlèvement",
                    "it_IT": "Ora di fine ritiro",
                    "nb_NO": "Sluttidspunkt for henting",
                    "es_ES": "Fin del horario de recogida",
                    "pl_PL": "Końcowy czas odbioru",
                    "ru_RU": "Время окончания самовывоза"
                }
            }
        ]
    }
]

As you can see:

• For parcels from Germany to Germany (indicated by ISO code "DE" and further definable into postalcodes (not used here)) there are

• two required attributes for each parcel called "Start pickup time" and "End pickup time" which define a time window for picking up the shipment.

• Furthermore you need to have the Quantity and Value of each shipped line (used to calculate insurance & helps to select this carrier automatically in specific cases) as well as

• the overall Value of the parcel.