Extended information: References and texts

💡

in german: Referenztexte

Reference texts can be used to transmit standardized types of information to Carrier Connect. These fields are often used as additional shipment data. However, not every text will be transmitted to the carrier. This depends on the carrier and their systems.

"shipment": {
  "referencesTexts": [
    {
      "type": "PO_NUMBER",
      "value": "order123456789"
    }
  ],
  ...
}
  

<shipment>
  <referencesTexts>
      <type>PO_NUMBER</type>
      <value>order123456789</value>
  </referencesTexts>
  ...
</shipment>

To use these references and texts there are two fields to be filled:

• type: Name of the reference field. All valid types are listed in the API Reference of Carrier Connect.
• value: Value of the reference field.

Extra fields

💡

in german: Zusatzfelder

There are two usecases for extra fields:

1. A carrier can require specific information for each shipment, that are not typically needed by other carriers.
2. The fields can be customer-specific and help with the process control.

To use an extra field in Carrier Connect, there are three fields to be considered:

• name: The name of the additional value field (available in the carrier configuration).
• type: The type of format that is used for the value.
• value: The actual value of the field.

"shipment": {
  "additionalValues": {
    "fields": [
      {
        "name": "ACCNO",
        "type": "string",
        "value": "123456"
      }
    ]
  }
}

<shipment>
  <additionalValues>
      <fields>
          <name>ACCNO</name>
          <type>string</type>
          <value>123456</value>
      </fields>
  </additionalValues>
  ...
</shipment>

Depending on the type of field there are different formats. All valid types are listed in the API Reference of Carrier Connect.

Value-added services

💡

in german: Zusatzleistungen

Value-added services are additional services, that can be combined with the typical service products of each carrier. These are often related to additional costs with the carrier, for specific information please check with your carrier person of contact.

"shipment": {
  "valueAddedServices": [
    {
      "identCode": "RETURNSERVICEALP"
    }
  ],
  ...
}
  

<shipment>
  <valueAddedServices>
      <identCode>RETURNSERVICEALP</identCode>
  </valueAddedServices>
  ...
</shipment>

To use these value-added services, there is one fields to be filled:

• identCode: Code of the value added service - available in the carrier configuration (ID next to the name).

In order to be able to use the value-added service, it has to be enabled in the carrier configuration (indicated by the green checkmark in the carrier configuration).

Info texts

💡

in german: Hinweistexte

Info texts are used by carriers that need or can process additional data of a specific text type.

The type of available info texts varies for each carrier. The available info texts can be found in the specific carrier section of the System Description of Carrier Connect. If the info texts section does not exist, the carrier does not have specific info texts, or does not have any info texts other than the reference texts.

"shipment": {
  "carrierInfoTexts": [
    {
      "identCode": "003",
      "parameter": "81685818"
    }
  ],
  ...
}
  

<shipment>
  <carrierInfoTexts>
      <identCode>003</identCode>
      <parameter>81685818</parameter>
  </carrierInfoTexts>
  ...
</shipment>

To use the info texts there are two fields to be filled:

• identCode: Code of the info text field - see abbreviation in front of the name in the System Description of Carrier Connect.
• parameter: Value of the info text field.