Skip to main content

/api/lite/orders/worksheet

Запрос анкеты FBM по заказу

/api/lite/orders/worksheet?orderId=TS100307

параметр orderId - ИД заказа в Кактусе, обязательный.

Поле

Тип Описание
id string ИД поля анкеты в Кактусе.
extId string Внешний ИД поля анкеты. Используется для сопоставления при передаче во внешние системы
name  string Вопрос, который отображается над полем
tooltip  string

Подсказка к полю (всплывайка при наведении на символ (?))

Если null, или отсутствует, то символ подсказки не отображается

value string

Значение поля по умолчанию

mandatory boolean

Обязательность заполнения поля. При дальнейшей валидации, проверяется заполненность value

inputType string

Тип поля ввода. Влияет на отрисовку на форме.

Значения: INPUT, TEXTAREA

Пример результата запроса

Если анкета заполнялась:

{
    "success": true,
    "orderId": "1000",
    "form_content": [
        {
            "id": "1000",
            "extId":"WB000001"
            "name": "Порядковый номер палеты",
            "tooltip": "Подсказка к полю (всплывайка при наведении на символ (?))"
            "value": "23445",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1001",
            "name": "Количество палет в поставке",
            "value": "5",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1002",
            "name": "Количество коробов на данной палете",
            "value": "2",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1003",
            "name": "Номер поставки",
            "value": "4433221",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1004",
            "name": "Склад назначения (а при транзите также транзитный склад)",
            "value": "ООО Вектор, ул. Складская, стр.1",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1005",
            "name": "Тип коробов (моно, микс)",
            "value": "моно",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1006",
            "name": "Наименование юридического лица",
            "value": "ООО Вектор",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1007",
            "name": "Дата поставки",
            "value": "20.07.2021",
            "mandatory": true,
            "inputType": "INPUT"
        }
    ]
}

Либо, если анкета не заполнялась:

{
    "success": true,
    "orderId": "1000",
    "form_content": null
}

Создание/редактирование анкеты FBM по заказу

/api/lite/orders/worksheet

orderId - ИД заказа в Кактусе, следует обязательно указывать.

Пример запроса

{
    "success": true,
    "orderId": "1000",
    "form_content": [
        {
            "id": "1000",
            "extId":"WB000001"
            "name": "Порядковый номер палеты",
            "tooltip": "Подсказка к полю (всплывайка при наведении на символ (?))"
            "value": "23445",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1001",
            "name": "Количество палет в поставке",
            "value": "5",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1002",
            "name": "Количество коробов на данной палете",
            "value": "2",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1003",
            "name": "Номер поставки",
            "value": "4433221",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1004",
            "name": "Склад назначения (а при транзите также транзитный склад)",
            "value": "ООО Вектор, ул. Складская, стр.1",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1005",
            "name": "Тип коробов (моно, микс)",
            "value": "моно",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1006",
            "name": "Наименование юридического лица",
            "value": "ООО Вектор",
            "mandatory": true,
            "inputType": "INPUT"
        },
        {
            "id": "1007",
            "name": "Дата поставки",
            "value": "20.07.2021",
            "mandatory": true,
            "inputType": "INPUT"
        }
    ]
}

Ошибка:

{
  "success": false,
  "errors": [
    {
    "code": 0,
    "message": "Текст ошибки"
    }
  ]
}