Дополнительные поля

При отслеживании посылки через некоторые службы доставки необходимо указывать дополнительную информацию, такую, как, например, индекс или фамилия получателя. Список всех обязательных и необязательных дополнительных полей передается в массиве extra_fields объекта Courier. Значения дополнительных полей могут быть как произвольные, так и выбранные только из доступных вариантов. Оба варианта объектов описаны в этом разделе.

1. Дополнительные поля с произвольным значением

Пример объекта:

        
{
    "name": "zip",
    "type": "text",
    "placeholder": "Индекс получателя",
    "field_regexp": "^(3S|KG)([A-Z]{4}|)\\d{9}$",
    "validate_regexp": "^[A-Z0-9]{5,8}$"
}
        
    

Описание объекта:

Свойство	Тип	Описание
name	String	Название POST-параметра, в котором необходимо передавать значение при добавлении посылки. Меняется в зависимости от службы доставки и назначения поля. Актуальный список дополнительных полей для каждой службы доставки можно получить из API списка служб доставки.
type	String	Тип дополнительного поля: text - произвольное значение.
placeholder	String	Описание необходимой дополнительной информации, которая должна быть передана в этом поле.
field_regexp	String	Регулярное выражение, с помощью которого проверяется обязательность заполнения этого поля для получения информации от службы доставки. Если трек-номер подходит под это регулярное выражение - поле обязательно для заполнения.
validate_regexp	String	Регулярное выражение, с помощью которого проверяется правильность ввода значения дополнительного поля.

2. Дополнительные поля со значением, выбранным из доступных вариантов

Пример объекта:

        
{
    "name": "extra_destination_country",
    "type": "dropdown",
    "placeholder": "Страна назначения",
    "field_regexp": "^(3S|KG)([A-Z]{4}|)\\d{9}$",
    "values": {
        "AU": "Австралия",
        "AT": "Австрия",
        "AZ": "Азербайджан",
        "AX": "Аландские Острова"
    }
}
        
    

Описание объекта:

Свойство	Тип	Описание
name	String	Название POST-параметра, в котором необходимо передавать значение при добавлении посылки. Меняется в зависимости от службы доставки и назначения поля. Актуальный список дополнительных полей для каждой службы доставки можно получить из API списка служб доставки.
type	String	Тип дополнительного поля: dropdown - значение, выбранное из доступных вариантов.
placeholder	String	Описание необходимой дополнительной информации, которая должна быть передана в этом поле.
field_regexp	String	Регулярное выражение, с помощью которого проверяется обязательность заполнения этого поля для получения информации от службы доставки. Если трек-номер подходит под это регулярное выражение - поле обязательно для заполнения.
values	String	Список доступных значений с их описаниями.