Carrier, Service, Value-Added Service and Info Text Identifiers

In this section you will learn where to find the correct identifiers for carriers, services, value-added services and info texts.

Carrier Identifiers: carrierIdentCode

"shipment": {
    "...":"...",
    "carrierIdentCode": "UPS",
}
<shipment>
  <...></...>
  <carrierIdentCode>UPS</carrierIdentCode>
</shipment>

Each carrier is assigned a unique code within Carrier Connect. You can find the carrierIdentCode in Carrier Connect under Master data > Carrier configurations in the column ID:

carrierIdentCode

Service Identifiers: serviceCode

"shipment": {
    "...":"...",
    "serviceCode": "UPS_EXPR",
}
<shipment>
  <...></...>
  <serviceCode>UPS_EXPR</serviceCode>
</shipment>

Services offered by carriers, such as express delivery or standard shipping, have specific codes. In Carrier Connect go to Master data > Carrier configurations. Open the desired carrier and chose the tab Services. You can find the serviceCode in the column ID:

serviceCode

Value-Added Service Identifiers: valueAddedServices

"shipment": {
    "...":"...",
    "valueAddedServices": [
      {
        "identCode": "COD"
      }
    ]
}
<shipment>
  <...></...>
  <valueAddedServices>
    <identCode>COD</identCode>
  </valueAddedServices>
</shipment>

Additional services, like saturday delivery or a return service, are also identified by unique codes. In Carrier Connect go to Master data > Carrier configurations. Open the relevant carrier and chose the tab Value-added services. You can find the right identCode in the column ID:

Info Text Identifiers: carrierInfoTexts

"shipment": {
    "...":"...",
    "carrierInfoTexts": [
      {
        "identCode": "00",
        "parameter": "some info for the carrier" //only necessary if Additional info = Required.
      }
    ]
}
<shipment>
  <...></...>
  <carrierInfoTexts>
    <identCode>00</identCode>
    <parameter>some info for the carrier</parameter> //only necessary if Additional info = Required.
  </carrierInfoTexts>
</shipment>

The identCode for an info text specifies which predefined message will be sent to the carrier.

In Carrier Connect go to Master data > Carrier configurations. Open the relevant carrier and chose the tab Info texts. You can find the right identCode in the column Name:

❗️

Important

Use only the part before the hyphen.

Example:
For 00 - General comment:, use 00 as the identCode.

If additional information is needed, enter it in the parameter field.