Couriers

Returns a list of all available couriers with their capabilities and delivery countries.

Returns the configuration schema for a specific courier, including all configurable fields and their types.

The schema enables API clients to dynamically generate configuration forms without hardcoding courier-specific logic.

Field Naming Convention (Dot-Notation Keys):

Configuration field paths use a dot-notation format where the first segment is the group name and the rest is the literal key (dots included).

• defaultValues.parameters.services -- group is defaultValues, key is parameters.services
• defaultValues.weight -- group is defaultValues, key is weight
• api.user -- group is api, key is user

When reading or submitting configuration JSON, keys within a group may themselves contain dots. For example, the group defaultValues may contain the key parameters.services as a direct property name:

Code
{
  "defaultValues": {
    "packageCount": 1,
    "parameters.services": ["FDS", "FSS"]
  }
}

Root-level fields (where group is null) have no group prefix and appear at the top level of the configuration object.

Field Types and Dropdowns:

Each field's type tells you how the value is serialized, not which UI control to render. The allowed values are string, number, integer, boolean, array, object and time. There is no select type.

A field is a dropdown (choice) whenever it carries a non-empty options array. The type of a dropdown then distinguishes single- from multi-select:

• Single-select → type: "string" with options. The user picks one option and you submit its value as a plain string (e.g. PPL defaultValues.productType, PBH defaultValues.predefinedCourierId).
• Multi-select → type: "array" with options (and optional minItems / maxItems validation). The user picks several options and you submit an array of their values (e.g. defaultValues.parameters.services).

Fields without an options array are free input: string for text, number / integer for numerics, boolean for on/off toggles, object for nested structures, and time for a 24-hour local time-of-day sent as an HH:mm string (e.g. DPD sender.timeFrom). Each option exposes a pre-translated title (what to show) and a value (what to submit).