Документация к API v.2
для проценки и заказа товаров

{
    "META": {
        "resource":"resource_name",
        "version":"1.0",
        "section": "shop",
        "resource":"resource_name",
        "parameters":   {
            "param_1": "value-1",
            "param_2": 123,
        },
        "date": "2019-12-01 08:04:15",
        "user_id": "e335d40b-3785-4ca7-946c-89a195c1ee9e"

    },
    "DATA": [
        {
            "value1": "ABC",
            "value2": 123.456
        },
        {
            "value1": "DEF",
            "value2": 987.654
        }
    ]
}

{
    "META": {
        "resource":"resource_name",
        "version":"1.0",
        "section": "shop",
        "resource":"resource_name",
        "parameters":   {
            "param_1": "value-1",
            "param_2": 123,
        },
        "date": "2019-12-01 08:04:15",
        "user_id": "e335d40b-3785-4ca7-946c-89a195c1ee9e"

    },
    "ERROR": {
        "code": 403,
        "message": "Действие не разрешено"
    }
}

Баланс клиента

Получение детальной информации о состоянии баланса личного счета

HTTP метод запроса: GET/POST

Входные данные:

Выходные данные:

balance [float]	Текущий баланс клиента (для всех плательщиков). Если меньше 0 — есть долг и задействован кредит. Если больше 0 — у клиента есть аванс.
credit [float]	Сумма предоставленного кредита
ordered [float]	Сумма заказанного товара не готового к отгрузке ("в работе")
reserved [float]	Сумма заказанного товара готового к отгрузке
limit [float]	Сумма доступная для заказов. limit=balance credit
pay_tomorrow [float]	Сумма к оплате завтра. Если не будет оплачена, то произойдет блокировка работы клиента за долги.
shipping_from [float]	Минимальная сумма для оформления доставки
active [bit]	Статус клиента: 1 — клиент активен 0 — клиент заблокирован

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Варианты получения

Получение массива возможных вариантов получения товара для клиента

HTTP метод запроса: GET/POST

Входные данные:

Выходные данные:

Хотя варианты получения для клиента не статичны, их можно кэшировать (рекомендуем на сутки). Рекомендуем добавить возможность принудительно обновить кэш на случай, если клиенту добавили/изменили новый адрес доставки и он хочет увидеть изменения прямо сейчас.

delivery_key [string]	Ключ варианта получения. Необходим при поиске и заказе
name [string]	Человекопонятное название варианта получения.
time_shift_msk [float]	Сдвиг времени от московского.

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Список складов

Список складов, доступных клиенту для способа доставки

ВНИМАНИЕ! Эта процедура оставлена для облегчения перехода с предыдущего API. Мы рекомендуем отойти от использования в логике вашего приложения понятия «склад» и опираться на «время получения».

HTTP метод запроса: GET/POST

Входные данные:

Если передан ключ delivery_key, то возвращаются склады только для указанного метода получения, иначе выводятся все доступные клиенту склады

delivery_key [string]

Ключ способа доставки

Выходные данные:

warehouse_id [string]	id склада (для совместимости с существующими интеграциями). В будущих версиях API это поле будет удалёно
warehouse_key [string]	Ключ склада
warehouse_name [string]	Название склада

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Список плательщиков

Получение списка плательщиков (подразделений) для клиента

HTTP метод запроса: GET/POST

Входные данные:

Выходные данные:

payer_name [string]	Название плательщика
payer_key [string]	Ключ плательщика. Необходим при вызове /order

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Бренды/производители

Получение списка производителей

При поиске по коду и названию производителя желательно указывать название производителя именно так, как оно указано в этой таблице. Данные меняются редко, поэтому результат можно кэшировать в вашем приложении на длительный срок (1-7 дней).

HTTP метод запроса: GET/POST

Входные данные:

Выходные данные:

В ветке DATA возвращается массив названий брендов.

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Поиск бренда по коду

Получение списка брендов у которых есть искомый артикул

HTTP метод запроса: GET/POST

Входные данные:

code [string:200]

Искомый артикул/код товара

Выходные данные:

Нужную пару brand/code необходимо передать в процедуру search

brand [string]	Название бренда/производителя
code [string]	Нормализованный артикул
name [string]	Название/описание товара

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Поиск товара

Поиск доступных для заказа товаров по бренду и коду с кроссами из наличия и под заказ

HTTP метод запроса: GET/POST

Входные данные:

У процедуры три обязательных поля: "brand" и "code" (указатели на искомый товар) и "delivery_key" (без него невозможно рассчитать время получения). Обратите внимание, что если указано поле "brand" и в этом поле название производителя/бренда написано с ошибкой, результат будет пустой. Сверяйте название бренда с /get_brands.

brand [varchar:255]	Наименование бренда/производителя (см. /specify) Внимание, т.к. это поле может содержать специальные параметры при передача методом GET используйте URL-кодирование!
code [varchar:255]	Артикул по каталогу производителя. Внимание, т.к. это поле может содержать специальные параметры при передача методом GET используйте URL-кодирование!
delivery_key [text]	Ключ желаемого способа получения (см. /deliveries)
with_crosses [bit]	1 — включить в результаты аналоги/кроссы. 0 — только искомый товар.
with_offers [bit]	1 — включить в результаты партнерские предложения. 0 — будет отображено только складское наличие.

Выходные данные:

offer_key [string]	Ключ предложения товара, который необходимо передать в заказ.
stock [bit]	Признак складского или партнерского товара. 1 — наличие, с собственного складе AE. 0 — товар партнера (заказной).
cross [int]	Тип предложения: NULL — Искомый товар 0 — Кросс (аналог) 1 — Замена номера 2 — Синоним бренда 3 — Проверенный кросс 10 — Комлект 11 — Часть 12 — Тюнинг
brand [string]	Наименование бренда/производителя
code [string]	Артикул по каталогу производителя
name [string]	Наименование товара
packing [int]	Кратность (или упаковка), 0 - нет кратности (т.е. можно заказывать поштучно)
price [float]	Цена клиента за единицу товара в рублях
currency [string]	Валюта
amount [int]	Доступное количество для заказа
unit [string]	Единица измерения
return [bit]	Гарантированный возврат. 1 - есть, 0 - нет
order_before [datetime]	Крайнее время заказа, до которого действителен delivery_time. В формате ГГГГ-ММ-ДД ЧЧ:ММ:СС В случае самовывоза с ПВЗ, когда товар находится на этом же складе, в этом поле вернется NULL (товар уже в ПВЗ и может быть заказан в любое время)
delivery_time [datetime]	Расчетное время доставки. В формате ГГГГ-ММ-ДД ЧЧ:ММ:СС В случае самовывоза с ПВЗ, когда товар находится на этом же складе, в этом поле вернется NULL (товар уже в ПВЗ и может быть получен в любое время)
delivery_time_max [datetime]	Максимальное время доставки. В формате ГГГГ-ММ-ДД ЧЧ:ММ:СС В случае самовывоза с ПВЗ, когда товар находится на этом же складе, в этом поле вернется NULL (товар уже в ПВЗ и может быть получен в любое время)
rejects [float]	Вероятность отказа в процентах. 0% - на складе.
dealer [bit]	Признак предложения от официального дилера
warehouse_name [string]	Текстовое название склада на котором лежит товар. В случае заказного товара: NULL
warehouse_key [string]	Ключ склада, с которого будет отгружен товар. Список складов для каждого варианта получения можно получить /deliveries

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Оформление заказа

HTTP метод запроса: GET/POST

Входные данные:

delivery_key [text]	Идентификатор способа доставки (см. Варианты получения)
payer_key [text]	Идентификатор плательщика/подразделения на которое будет выставлен счет (см. Список плательщиков/подразделений)
stock_items [array]	Массив заказываемых товаров
offer_key [string]	Идентификатор строки предложения поиска (см. /search_items)
quantity [int]	Количество заказываемого товара
price [float]	Максимальная цена. Если параметр указан, то делается сверка с актуальной ценой предложения и в случае превышения последней заказ не будет оформлен. Если 0, то проверка производиться не будет.
comment [string]	Комментарий к строке
wait_all_goods [bit]	Доставить весь заказ сразу или по мере поступления на склад. По умолчанию : 1 (всё сразу)
comment [string:255]	Комментарий к заказу
delivery_date [string]	Желаемая дата получения (не раньше чем). В формате ГГГГ-ММ-ДД

Обратите внимание, что комментарий обрабатывается в контексте заказа, а не позиции. Т.е. при отправке заказа окончательный комментарий к нему сложится из комментария к заказу и всех комментариев к строкам. Разделитель — точка с запятой



Параметр price нужно использовать если вы хотите жестко зафиксировать цену по которой нашли предложение.

Выходные данные:

order_id [int]	Номер заказа для дальнейшего отслеживания через /get_orders. Если заказ не принят в это поле возвращается NULL
result [bool]	Результат обработки. TRUE — заказ принят FALSE — заказ не принят.
result_description [string]	Описание результата. Рекомендуется транслировать пользователю.

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Список заказов

Получение списка текущих, завершенных и отменных товаров с деталями заказа

• Список всех товаров во всех текущих заказах: вызов процедуры без параметров
• Проверка статуса по номерам заказов: передать только orders. При этом filters передавать не надо, он не будет обрабатываться.
• Поиск заказов (параметр filters): нужно обязательно указать даты. Плательщик и получение - опционально.

HTTP метод запроса: GET/POST

Входные данные:

Внимание: фильтры работают в конъюнкции (логическое"AND")

orders [array]	Простой массив номеров заказов
filters [array]	Массив фильтров
from [string:10]	Начало диапазона дат заказов (ГГГГ-ММ-ДД)
to [string:10]	Конец диапазона дат заказов (ГГГГ-ММ-ДД)
delivery_key [string]	ключ варианта получения
payer_key [string]	ключ плетельщика

Пример посылаемых данных в JSON (аналогично можно передать в XML или serialized array):



[

   1234567890,

   9876543210

]



или

{

   "dates":

      {

         "from":"2021-01-01",

         "to":"2021-12-31"

      },

   "delivery_key":"1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz",

   "payer_key":"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

}

Выходные данные:

brand [string]	Наименование бренда/производителя
code [string]	Артикул по каталогу производителя
name [string]	Наименование товара
price [float]	Цена за единицу товара в рублях
amount [int]	Заказанное количество
unit [string]	Единица измерения
dealer [bit]	Товар от оф. дилера.
cancelable [bit]	Возможность отмены на текущей стадии (см. поле статус) 0 — отмена невозможна 1 — отмена возможна
returnable [bit]	Возможность возврата 0 — возврат невозможен 1 — возврат возможен
status_id [int]	Текущий ID статуса позиции заказа. Возможные можно получить в процедуре /get_statuses
status [string]	Текущий статус позиции заказа. Возможные варианты можно получить в процедуре /get_statuses
document [string]	Название документа
order_id [int]	Идентификатор заказа (полученный при оформлении /create_order)
comment [string]	Коментарий к заказу
united [bit]	Доставка/получение всех товаров в заказе вместе или по мере поступления 0 — отдельно 1 — вместе
order_date [date]	Дата/время оформления заказа
order_number [string]	Номер заказа в документообороте AE
delivery [string]	Способ и место получения заказа
delivery_date [date]	Ожидаемая/фактическая дата получения заказа
order_key [date]	Ключ заказа (см. cancel_order)

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться

Список статусов

Список возможных статусов для списка заказов

Используйте эту процедуру если необходимо связать наши статусы с принятыми в вашей системе. Для маппинга используйте поле status_id.

HTTP метод запроса: GET/POST

Входные данные:

Выходные данные:

При сортировке данных по status_id, статусы выстроятся по порядку их изменения у товара в процессе выполнения заказа.

group [string]	Название группы статусов
status_id [int]
name [string]
description [text]

Примеры запросов:

Для доступа к построителю запросов и просмотра результатов необходимо авторизироваться