API

GET /api/api-versions Получение списка доступных версий API

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

Метод позволяет получить все версии API, с которыми можно работать на данном аккаунте

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
versions array Доступные версии API

GET /api/credentials Получение списка доступных методов и магазинов для данного ключа

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

Метод позволяет получить список методов API и информацию о доступе к магазинам для данного API-ключа.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
credentials[] array of strings deprecated Доступные методы для ключа
scopes[] array of strings Разрешенные доступы для ключа
siteAccess string Режим доступа к магазинам. Возможные значения:
access_full - доступ к данным всех магазинов;
access_selective - доступ к данным отдельных магазинов.
Доступные магазины перечислены в поле sitesAvailable
sitesAvailable[] array of strings Доступные магазины

Клиенты

GET /api/v4/customers Получение списка клиентов, удовлетворяющих заданному фильтру

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

Для доступа к методу необходимо разрешение customer_read.

Результат возвращается постранично. В поле pagination содержится информация о постраничной разбивке.

В фильтрах filter[sourceName], filter[mediumName], filter[campaignName], filter[keywordName], filter[adContentName] указывается название элементов.

В фильтрах filter[managers][] указывается массив внутренних ID элементов в системе.

В фильтре filter[managerGroups][] указывается массив символьных кодов элементов.

Фильтр filter[discountCardNumber] доступен, если включено поле «Дисконтная карта» в модуле «Лояльность».

В фильтрах filter[ids][] и filter[externalIds][] передается массив внутренних и внешних идентификаторов соответственно.

Фильтр filter[classSegment] позволяет получить сегменты RFM-анализа клиентов. Доступны следующие значения: monetary[0..2]_recency[0..2]frequency[0..2]_recency[0..2]monetary[0..2]_frequency[0..2].

Фильтром filter[name] можно производить поиск по ФИО или телефону клиента.

С помощью фильтра filter[customFields][] можно производить поиск по значениям пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» и «Дата-время» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Для пользовательских полей типа Целое число, Число, Дата и Дата-время фильтрация осуществляется по диапазону, для остальных типов полей — по точному значению. Имя фильтра соответствует символьному коду поля. Пример: для поля типа Дата с символьным кодом birth_date доступны фильтры filter[customFields][birth_date][min] и filter[customFields][birth_date][max]. Для поля типа Справочник с символьным кодом quality доступен множественный фильтр filter[customFields][quality][].

В фильтре filter[attachments] можно указать одно из трех значений:

В фильтре filter[tasksCounts] можно указать одно из трех значений:

Поля personalDiscount, cumulativeDiscount и discountCardNumber возвращаются, если они включены в настройках.

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100], [20|50|100|250]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (CustomerFilterData)
filter[ids][]array of integers Массив ID клиентов
filter[externalIds][]array of strings Массив externalID клиентов
filter[name]string{length: {max: 255}} Клиент
filter[discountCardNumber]string{length: {max: 255}} Номер дисконтной карты
filter[ordersCount]string
filter[averageSumm]string
filter[totalSumm]string
filter[costSumm]string
filter[createdAt]string
filter[firstOrder]string
filter[lastOrder]string
filter[city]string{length: {max: 255}} Город
filter[region]string{length: {max: 255}} Регион
filter[attachments]integer[1|2|3] Прикрепленные объекты (вложения)
filter[tasksCounts]integer[1|2|3] Задачи
filter[classSegment]string{match: /^(monetary|recency|frequency)[0-2]_(recency|frequency|monetary)[0-2]$/} Сегмент
filter[sex]string[female|female_with_presumable|male|male_with_presumable] Пол
filter[email]string{length: {max: 255}} E-mail
filter[browserId]string Идентификатор устройства в Collector
filter[contragentName]string{length: {max: 255}} Полное наименование
filter[contragentInn]string{match: /\d+/} ИНН
filter[contragentKpp]string{match: /\d+/} КПП
filter[contragentBik]string{match: /\d+/} БИК банка
filter[contragentCorrAccount]string{match: /\d+/} Корр. счет банка
filter[contragentBankAccount]string{match: /\d+/} Расчетный счет
filter[contragentTypes][]array of strings{choice of [enterpreneur|individual|legal-entity]} Типы контрагента
filter[sourceName]string{length: {max: 255}} Источник
filter[mediumName]string{length: {max: 255}} Канал
filter[campaignName]string{length: {max: 255}} Кампания
filter[firstWebVisit]string
filter[lastWebVisit]string
filter[countries][]array of strings Страны
filter[lastManagerCommunicatedAt]string
filter[tags][]array of strings Теги
filter[attachedTags][]array of strings Список прикреплённых тегов (или)
filter[subscriptions][]array of objects (CustomerFilterCustomerSubscriptionData) Фильтр по подпискам пользователя
filter[subscriptions][][channel]string Канал категории подписки
filter[subscriptions][][subscription]string Код категории подписки
filter[subscriptions][][subscribed]boolean Флаг подписки
filter[customFields]array Пользовательские поля
filter[sites][]array of strings Магазины
filter[managers][]array of integers Менеджеры
filter[managerGroups][]array of strings Группы менеджеров
filter[notes]string Заметки
filter[vip]boolean Важный клиент
filter[bad]boolean Плохой клиент
filter[minOrdersCount]integer Количество заказов (от)
filter[maxOrdersCount]integer Количество заказов (до)
filter[minAverageSumm]integer Средний чек (от)
filter[maxAverageSumm]integer Средний чек (до)
filter[minTotalSumm]integer Сумма по заказам (от)
filter[maxTotalSumm]integer Сумма по заказам (до)
filter[minCostSumm]integer Сумма расходов по заказам (от)
filter[maxCostSumm]integer Сумма расходов по заказам (до)
filter[dateFrom]DateTimeY-m-d Дата регистрации (от)
filter[dateTo]DateTimeY-m-d Дата регистрации (до)
filter[firstOrderFrom]DateTimeY-m-d Первый заказ (от)
filter[firstOrderTo]DateTimeY-m-d Первый заказ (до)
filter[lastOrderFrom]DateTimeY-m-d Последний заказ (от)
filter[lastOrderTo]DateTimeY-m-d Последний заказ (до)
filter[isContact]boolean Клиент является контактным лицом
filter[online]boolean Клиент на сайте
filter[segment]string Сегмент
filter[commentary]string Комментарий оператора
filter[mgChannels][]array of integers Каналы чатов
filter[keywordName]string Ключевое слово
filter[adContentName]string Содержание кампании
filter[abandonedCart]boolean
filter[emailMarketingUnsubscribed]booleandeprecated Отписан от email рассылок
filter[mgCustomerId]string Идентификатор клиента MessageGateway
filter[firstWebVisitFrom]DateTimeY-m-d Первое посещение (от)
filter[firstWebVisitTo]DateTimeY-m-d Первое посещение (до)
filter[lastWebVisitFrom]DateTimeY-m-d Последнее посещение (от)
filter[lastWebVisitTo]DateTimeY-m-d Последнее посещение (до)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
customers[] array of objects (Customer) Клиент
customers[][id] integer ID клиента
customers[][externalId] string Внешний ID клиента
customers[][isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
customers[][createdAt] DateTime Создан
customers[][managerId] integer Менеджер клиента
customers[][vip] boolean Важный клиент
customers[][bad] boolean Плохой клиент
customers[][site] string Магазин, с которого пришел клиент
customers[][contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
customers[][contragent][contragentType] string Тип контрагента
customers[][contragent][legalName] string Полное наименование
customers[][contragent][legalAddress] string Адрес регистрации
customers[][contragent][INN] string ИНН
customers[][contragent][OKPO] string ОКПО
customers[][contragent][KPP] string КПП
customers[][contragent][OGRN] string ОГРН
customers[][contragent][OGRNIP] string ОГРНИП
customers[][contragent][certificateNumber] string Номер свидетельства
customers[][contragent][certificateDate] DateTime Дата свидетельства
customers[][contragent][BIK] string БИК
customers[][contragent][bank] string Банк
customers[][contragent][bankAddress] string Адрес банка
customers[][contragent][corrAccount] string Корр. счёт
customers[][contragent][bankAccount] string Расчётный счёт
customers[][firstClientId] string Первая метка клиента Google Analytics
customers[][lastClientId] string Последняя метка клиента Google Analytics
customers[][customFields] array Ассоциативный массив пользовательских полей
customers[][personalDiscount] double Персональная скидка
customers[][cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
customers[][discountCardNumber] string Номер дисконтной карты
customers[][avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)
customers[][marginSumm] float LTV (в базовой валюте)
customers[][totalSumm] float Общая сумма заказов (в базовой валюте)
customers[][averageSumm] float Средняя сумма заказа (в базовой валюте)
customers[][ordersCount] integer Количество заказов
customers[][address] object (CustomerAddress) Адрес клиента
customers[][address][id] integer ID адреса
customers[][address][index] string Индекс
customers[][address][countryIso] string ISO код страны
customers[][address][region] string Регион
customers[][address][regionId] integer Идентификатор региона в Geohelper
customers[][address][city] string Город
customers[][address][cityId] integer Идентификатор города в Geohelper
customers[][address][cityType] string Тип населенного пункта
customers[][address][street] string Улица
customers[][address][streetId] integer Идентификатор улицы в Geohelper
customers[][address][streetType] string Тип улицы
customers[][address][building] string Дом
customers[][address][flat] string Номер квартиры/офиса
customers[][address][floor] integer Этаж
customers[][address][block] integer Подъезд
customers[][address][house] string Строение
customers[][address][housing] string Корпус
customers[][address][metro] string Метро
customers[][address][notes] string Примечания к адресу
customers[][address][text] string Адрес в текстовом виде
customers[][maturationTime] integer Время «созревания», в секундах
customers[][firstName] string Имя
customers[][lastName] string Фамилия
customers[][patronymic] string Отчество
customers[][email] string E-mail
customers[][emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
customers[][customerSubscriptions][] array of objects (CustomerSubscription) Подписки
customers[][customerSubscriptions][][subscription] object (Subscription) Категория подписки
customers[][customerSubscriptions][][subscription][id] integer ID категории подписки
customers[][customerSubscriptions][][subscription][channel] string Канал
customers[][customerSubscriptions][][subscription][name] string Название
customers[][customerSubscriptions][][subscription][code] string Символьный код
customers[][customerSubscriptions][][subscription][active] boolean Статус активности
customers[][customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
customers[][customerSubscriptions][][subscription][ordering] integer
customers[][customerSubscriptions][][subscribed] boolean Активность подписки
customers[][customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
customers[][phones][] array of objects (CustomerPhone) Телефоны
customers[][phones][][number] string Номер телефона
customers[][birthday] DateTime День рождения
customers[][source] object (SerializedSource) Источник клиента
customers[][source][source] string Источник
customers[][source][medium] string Канал
customers[][source][campaign] string Кампания
customers[][source][keyword] string Ключевое слово
customers[][source][content] string Содержание кампании
customers[][mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
customers[][mgCustomers][][id] integer ID клиента
customers[][mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
customers[][mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
customers[][mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
customers[][commentary] string deprecated Комментарий
customers[][photoUrl] string URL фотографии

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/customers/create Создание клиента

Создание клиента

Для доступа к методу необходимо разрешение customer_write.

Метод создает клиента и возвращает внутренний ID созданного клиента.

Если не указывать customer[createdAt], то будет использовано текущее время в качестве даты/времени регистрации клиента.

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

Поля customer[personalDiscount] и customer[discountCardNumber] принимаются, если они включены в настройках.

В поле customer[customFields] можно передавать массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Адрес клиента customer[address] можно указывать либо в строковом виде в поле customer[address][text], либо в подробном виде, заполняя все поля кроме customer[address][text].

Параметры

ПараметрТипФорматОписание
sitestring Символьный код магазина
customerobject (SerializedCustomer)
customer[externalId]string Внешний ID клиента
customer[isContact]boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
customer[createdAt]DateTime Создан
customer[vip]boolean Важный клиент
customer[bad]boolean Плохой клиент
customer[contragent]object (CustomerContragent)deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
customer[contragent][contragentType]string Тип контрагента
customer[contragent][legalName]string Полное наименование
customer[contragent][legalAddress]string Адрес регистрации
customer[contragent][INN]string ИНН
customer[contragent][OKPO]string ОКПО
customer[contragent][KPP]string КПП
customer[contragent][OGRN]string ОГРН
customer[contragent][OGRNIP]string ОГРНИП
customer[contragent][certificateNumber]string Номер свидетельства
customer[contragent][certificateDate]DateTime Дата свидетельства
customer[contragent][BIK]string БИК
customer[contragent][bank]string Банк
customer[contragent][bankAddress]string Адрес банка
customer[contragent][corrAccount]string Корр. счёт
customer[contragent][bankAccount]string Расчётный счёт
customer[customFields]array Ассоциативный массив пользовательских полей
customer[personalDiscount]double Персональная скидка
customer[discountCardNumber]string Номер дисконтной карты
customer[address]object (CustomerAddress) Адрес клиента
customer[address][index]string Индекс
customer[address][countryIso]string ISO код страны
customer[address][region]string Регион
customer[address][regionId]integer Идентификатор региона в Geohelper
customer[address][city]string Город
customer[address][cityId]integer Идентификатор города в Geohelper
customer[address][cityType]string Тип населенного пункта
customer[address][street]string Улица
customer[address][streetId]integer Идентификатор улицы в Geohelper
customer[address][streetType]string Тип улицы
customer[address][building]string Дом
customer[address][flat]string Номер квартиры/офиса
customer[address][floor]integer Этаж
customer[address][block]integer Подъезд
customer[address][house]string Строение
customer[address][housing]string Корпус
customer[address][metro]string Метро
customer[address][notes]string Примечания к адресу
customer[address][text]string Адрес в текстовом виде
customer[firstName]string Имя
customer[lastName]string Фамилия
customer[patronymic]string Отчество
customer[email]string E-mail
customer[emailMarketingUnsubscribedAt]DateTimedeprecated Дата отписки от email рассылок
customer[phones][]array of objects (CustomerPhone) Телефоны
customer[phones][][number]string Номер телефона
customer[birthday]DateTime День рождения
customer[commentary]stringdeprecated Комментарий
customer[photoUrl]string URL фотографии
customer[managerId]integer Менеджер клиента
customer[source]object (SerializedSource) Источник клиента
customer[source][source]string Источник
customer[source][medium]string Канал
customer[source][campaign]string Кампания
customer[source][keyword]string Ключевое слово
customer[source][content]string Содержание кампании
customer[browserId]string Идентификатор устройства в Collector

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
id integer Внутренний ID созданного клиента

Статусы ответа

Код статуса ответаОписание
201
  • Клиент создан
400
  • Ошибка при создании клиента

POST /api/v4/customers/fix-external-ids Массовая запись внешних ID клиентов

Массовая запись внешних ID клиентов

Для доступа к методу необходимо разрешение customer_write.

Данный метод полезен в случае обратной синхронизации клиентов, которые исходно оформлены в системе.

Магазин запрашивает клиентов, созданных в системе, и создает их в своей базе. При создании клиентов в магазине формируются собственные ID клиентов (externalId клиентов в нотации системы). Сразу после создания клиентов интернет-магазин вызывает метод /api/v*/customers/fix-external-ids, сохраняя в системе собственные ID клиентов.

Параметры

ПараметрТипФорматОписание
customers[]array of objects (FixExternalRow) Идентификаторы загруженных объектов
customers[][id]integer{not blank}{range: {>=1, <=2147483647}}} Внутренний ID
customers[][externalId]string{not blank} Внешний ID

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/customers/history Получение истории изменения клиентов

Получение истории изменения клиентов

Для доступа к методу необходимо разрешение customer_read.

Возвращает изменения в клиентах, произведенные в указанный диапазон дат (используя фильтры filter[startDate] и filter[endDate]), либо инкрементальные изменения (используя filter[sinceId]). При реализации постоянной трансляции изменений во внешнюю систему ​рекомендуется​ использовать подход с забором инкрементальных изменений через filter[sinceId] передавая id последней полученной записи истории.

Для записей создания и удаления клиента возвращается полный набор полей в контексте customer.

Результат возвращается постранично. В поле pagination содержится информация о постраничной разбивке. Для постраничного перебора записей истории ​необходимо​ использовать filter[sinceId]. Параметр page использовать не рекомендуется.

Более подробно о работе с историей вы можете ознакомиться в отдельной статье документации.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (CustomerHistoryFilterV4Type)
filter[customerId]integer{range: {>=0, <=4294967295}} ID клиента
filter[sinceId]integer{range: {>=0, <=4294967295}} Начиная с ID истории клиентов
filter[customerExternalId]string{length: {max: 255}} Внешний ID клиента
filter[startDate]DateTimeY-m-d H:i:s Дата/время изменения (от)
filter[endDate]DateTimeY-m-d H:i:s Дата/время изменения (до)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
generatedAt DateTime Время формирования ответа
history[] array of objects (CustomerHistory)
history[][id] integer Внутренний идентификатор записи в истории
history[][createdAt] DateTime Дата внесения изменения
history[][created] boolean Признак создания сущности
history[][deleted] boolean Признак удаления сущности
history[][source] string Источник изменения
history[][user] object (User) Пользователь
history[][user][id] integer ID пользователя
history[][field] string Имя изменившегося поля
history[][oldValue] custom handler result for (mixed) Старое значение свойства
history[][newValue] custom handler result for (mixed) Новое значение свойства
history[][apiKey] object (ApiKey) Информация о ключе api, использовавшемся для этого изменения
history[][apiKey][current] boolean Изменение было сделано с помощью ключа, используемого в данный момент
history[][customer] object (Customer) Клиент
history[][customer][id] integer ID клиента
history[][customer][externalId] string Внешний ID клиента
history[][customer][site] string Магазин, с которого пришел клиент
history[][subscription] object (Subscription) Категория подписки
history[][subscription][channel] string Канал
history[][subscription][name] string Название
history[][subscription][code] string Символьный код
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/customers/upload Пакетная загрузка клиентов

Пакетная загрузка клиентов

Для доступа к методу необходимо разрешение customer_write.

Метод позволяет загружать пакетно до 50 клиентов.

Подробную информацию по формату данных см. в описании метода /api/v*/customers/create.

Параметры

ПараметрТипФорматОписание
sitestring Символьный код магазина, к которому относятся загружаемые клиенты
customers[]array of objects (SerializedCustomer)
customers[][externalId]string Внешний ID клиента
customers[][isContact]boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
customers[][createdAt]DateTime Создан
customers[][vip]boolean Важный клиент
customers[][bad]boolean Плохой клиент
customers[][customFields]array Ассоциативный массив пользовательских полей
customers[][personalDiscount]double Персональная скидка
customers[][discountCardNumber]string Номер дисконтной карты
customers[][address]object (CustomerAddress) Адрес клиента
customers[][address][index]string Индекс
customers[][address][countryIso]string ISO код страны
customers[][address][region]string Регион
customers[][address][regionId]integer Идентификатор региона в Geohelper
customers[][address][city]string Город
customers[][address][cityId]integer Идентификатор города в Geohelper
customers[][address][cityType]string Тип населенного пункта
customers[][address][street]string Улица
customers[][address][streetId]integer Идентификатор улицы в Geohelper
customers[][address][streetType]string Тип улицы
customers[][address][building]string Дом
customers[][address][flat]string Номер квартиры/офиса
customers[][address][floor]integer Этаж
customers[][address][block]integer Подъезд
customers[][address][house]string Строение
customers[][address][housing]string Корпус
customers[][address][metro]string Метро
customers[][address][notes]string Примечания к адресу
customers[][address][text]string Адрес в текстовом виде
customers[][firstName]string Имя
customers[][lastName]string Фамилия
customers[][patronymic]string Отчество
customers[][email]string E-mail
customers[][emailMarketingUnsubscribedAt]DateTimedeprecated Дата отписки от email рассылок
customers[][phones][]array of objects (CustomerPhone) Телефоны
customers[][phones][][number]string Номер телефона
customers[][birthday]DateTime День рождения
customers[][commentary]stringdeprecated Комментарий
customers[][photoUrl]string URL фотографии
customers[][managerId]integer Менеджер клиента
customers[][source]object (SerializedSource) Источник клиента
customers[][source][source]string Источник
customers[][source][medium]string Канал
customers[][source][campaign]string Кампания
customers[][source][keyword]string Ключевое слово
customers[][source][content]string Содержание кампании
customers[][browserId]string Идентификатор устройства в Collector

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
uploadedCustomers[] array of objects (FixExternalRow) Идентификаторы загруженных объектов
uploadedCustomers[][id] integer Внутренний ID
uploadedCustomers[][externalId] string Внешний ID
failedCustomers[] array of objects (EntityWithExternalId) Идентификаторы незагруженных объектов
failedCustomers[][externalId] string Внешний ID (при наличии)

Статусы ответа

Код статуса ответаОписание
201
  • Все клиенты успешно загружены
400
  • Не передан массив клиентов, либо массив слишком большой
460
  • Во время загрузки возникли ошибки. Часть клиентов не загружена (в ответе также присутствует массив ошибок "errors")

GET /api/v4/customers/{externalId} Получение информации о клиенте

Получение информации о клиенте

Для доступа к методу необходимо разрешение customer_read.

Метод возвращает полную информацию по клиенту. Можно обращаться к клиенту как по внешнему ID клиента (by=externalId), так и по внутреннему ID (by=id).

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

Пустые поля без значений не возвращаются.

В поле managerId возвращается внутренний ID сущности в системе.

Поля personalDiscount, cumulativeDiscount и discountCardNumber возвращаются, если они включены в настройках.

В поле customFields возвращается массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Если адрес клиента указывался в строковом виде, то он будет возвращен в customer[address][text]. Если адрес указывался в детальном виде, то будут возвращены все заполненные поля доставки, а в customer[address][text] будет находиться автоматически сформированное текстовое представление адреса.

Параметры

ПараметрТипФорматОписание
externalIdstring ID клиента

Параметры для фильтрации

ПараметрОписание
by
Шаблонid|externalId
Значение по умолчаниюexternalId
ОписаниеУказывается, что передается в параметре externalId: внутренний (by=id) или внешний (by=externalId) ID клиента. По умолчанию externalId.
site
ОписаниеСимвольный код магазина

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
customer object (Customer) Клиент
customer[id] integer ID клиента
customer[externalId] string Внешний ID клиента
customer[isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
customer[createdAt] DateTime Создан
customer[managerId] integer Менеджер клиента
customer[vip] boolean Важный клиент
customer[bad] boolean Плохой клиент
customer[site] string Магазин, с которого пришел клиент
customer[contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
customer[contragent][contragentType] string Тип контрагента
customer[contragent][legalName] string Полное наименование
customer[contragent][legalAddress] string Адрес регистрации
customer[contragent][INN] string ИНН
customer[contragent][OKPO] string ОКПО
customer[contragent][KPP] string КПП
customer[contragent][OGRN] string ОГРН
customer[contragent][OGRNIP] string ОГРНИП
customer[contragent][certificateNumber] string Номер свидетельства
customer[contragent][certificateDate] DateTime Дата свидетельства
customer[contragent][BIK] string БИК
customer[contragent][bank] string Банк
customer[contragent][bankAddress] string Адрес банка
customer[contragent][corrAccount] string Корр. счёт
customer[contragent][bankAccount] string Расчётный счёт
customer[firstClientId] string Первая метка клиента Google Analytics
customer[lastClientId] string Последняя метка клиента Google Analytics
customer[customFields] array Ассоциативный массив пользовательских полей
customer[personalDiscount] double Персональная скидка
customer[cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
customer[discountCardNumber] string Номер дисконтной карты
customer[avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)
customer[marginSumm] float LTV (в базовой валюте)
customer[totalSumm] float Общая сумма заказов (в базовой валюте)
customer[averageSumm] float Средняя сумма заказа (в базовой валюте)
customer[ordersCount] integer Количество заказов
customer[address] object (CustomerAddress) Адрес клиента
customer[address][id] integer ID адреса
customer[address][index] string Индекс
customer[address][countryIso] string ISO код страны
customer[address][region] string Регион
customer[address][regionId] integer Идентификатор региона в Geohelper
customer[address][city] string Город
customer[address][cityId] integer Идентификатор города в Geohelper
customer[address][cityType] string Тип населенного пункта
customer[address][street] string Улица
customer[address][streetId] integer Идентификатор улицы в Geohelper
customer[address][streetType] string Тип улицы
customer[address][building] string Дом
customer[address][flat] string Номер квартиры/офиса
customer[address][floor] integer Этаж
customer[address][block] integer Подъезд
customer[address][house] string Строение
customer[address][housing] string Корпус
customer[address][metro] string Метро
customer[address][notes] string Примечания к адресу
customer[address][text] string Адрес в текстовом виде
customer[maturationTime] integer Время «созревания», в секундах
customer[firstName] string Имя
customer[lastName] string Фамилия
customer[patronymic] string Отчество
customer[email] string E-mail
customer[emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
customer[customerSubscriptions][] array of objects (CustomerSubscription) Подписки
customer[customerSubscriptions][][subscription] object (Subscription) Категория подписки
customer[customerSubscriptions][][subscription][id] integer ID категории подписки
customer[customerSubscriptions][][subscription][channel] string Канал
customer[customerSubscriptions][][subscription][name] string Название
customer[customerSubscriptions][][subscription][code] string Символьный код
customer[customerSubscriptions][][subscription][active] boolean Статус активности
customer[customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
customer[customerSubscriptions][][subscription][ordering] integer
customer[customerSubscriptions][][subscribed] boolean Активность подписки
customer[customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
customer[phones][] array of objects (CustomerPhone) Телефоны
customer[phones][][number] string Номер телефона
customer[birthday] DateTime День рождения
customer[source] object (SerializedSource) Источник клиента
customer[source][source] string Источник
customer[source][medium] string Канал
customer[source][campaign] string Кампания
customer[source][keyword] string Ключевое слово
customer[source][content] string Содержание кампании
customer[mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
customer[mgCustomers][][id] integer ID клиента
customer[mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
customer[mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
customer[mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
customer[commentary] string deprecated Комментарий
customer[photoUrl] string URL фотографии

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
404
  • Клиент не найден (если клиент был удален в результате объединения, в поле "combinedTo" будут данные целевого клиента)

POST /api/v4/customers/{externalId}/edit Редактирование клиента

Редактирование клиента

Для доступа к методу необходимо разрешение customer_write.

Метод позволяет вносить изменения в клиента. Можно обращаться к клиенту как по внешнему ID клиента (by=externalId), так и по внутреннему ID (by=id).

В случае, если производится попытка отредактировать удаленного клиента, система возвращает в ответе state=removed.

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

Поля customer[personalDiscount] и customer[discountCardNumber] принимаются, если они включены в настройках.

В поле customer[customFields] можно передавать массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Адрес клиента customer[address] можно указывать либо в строковом виде в поле customer[address][text], либо в подробном виде, заполняя все поля кроме customer[address][text].

Параметры

ПараметрТипФорматОписание
bystring Указывается, что передается в параметре externalId: внутренний (by=id) или внешний (by=externalId) ID клиента. По умолчанию externalId.
sitestring Символьный код магазина
customerobject (SerializedCustomer)
customer[externalId]string Внешний ID клиента
customer[isContact]boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
customer[createdAt]DateTime Создан
customer[vip]boolean Важный клиент
customer[bad]boolean Плохой клиент
customer[contragent]object (CustomerContragent)deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
customer[contragent][contragentType]string Тип контрагента
customer[contragent][legalName]string Полное наименование
customer[contragent][legalAddress]string Адрес регистрации
customer[contragent][INN]string ИНН
customer[contragent][OKPO]string ОКПО
customer[contragent][KPP]string КПП
customer[contragent][OGRN]string ОГРН
customer[contragent][OGRNIP]string ОГРНИП
customer[contragent][certificateNumber]string Номер свидетельства
customer[contragent][certificateDate]DateTime Дата свидетельства
customer[contragent][BIK]string БИК
customer[contragent][bank]string Банк
customer[contragent][bankAddress]string Адрес банка
customer[contragent][corrAccount]string Корр. счёт
customer[contragent][bankAccount]string Расчётный счёт
customer[customFields]array Ассоциативный массив пользовательских полей
customer[personalDiscount]double Персональная скидка
customer[discountCardNumber]string Номер дисконтной карты
customer[address]object (CustomerAddress) Адрес клиента
customer[address][index]string Индекс
customer[address][countryIso]string ISO код страны
customer[address][region]string Регион
customer[address][regionId]integer Идентификатор региона в Geohelper
customer[address][city]string Город
customer[address][cityId]integer Идентификатор города в Geohelper
customer[address][cityType]string Тип населенного пункта
customer[address][street]string Улица
customer[address][streetId]integer Идентификатор улицы в Geohelper
customer[address][streetType]string Тип улицы
customer[address][building]string Дом
customer[address][flat]string Номер квартиры/офиса
customer[address][floor]integer Этаж
customer[address][block]integer Подъезд
customer[address][house]string Строение
customer[address][housing]string Корпус
customer[address][metro]string Метро
customer[address][notes]string Примечания к адресу
customer[address][text]string Адрес в текстовом виде
customer[firstName]string Имя
customer[lastName]string Фамилия
customer[patronymic]string Отчество
customer[email]string E-mail
customer[emailMarketingUnsubscribedAt]DateTimedeprecated Дата отписки от email рассылок
customer[phones][]array of objects (CustomerPhone) Телефоны
customer[phones][][number]string Номер телефона
customer[birthday]DateTime День рождения
customer[commentary]stringdeprecated Комментарий
customer[photoUrl]string URL фотографии
customer[managerId]integer Менеджер клиента
customer[source]object (SerializedSource) Источник клиента
customer[source][source]string Источник
customer[source][medium]string Канал
customer[source][campaign]string Кампания
customer[source][keyword]string Ключевое слово
customer[source][content]string Содержание кампании
customer[browserId]string Идентификатор устройства в Collector

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
id integer Внутренний ID клиента
state string Состояние клиента (по умолчанию не возвращается)

Статусы ответа

Код статуса ответаОписание
200
  • Клиент успешно изменен
400
  • Ошибка при изменении клиента

Доставки

GET /api/v4/delivery/generic/setting/{subcode} Получение конфигурации интеграции

Получение конфигурации интеграции

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
configuration object (ConfigurationApiV4)
configuration[description] string Описание подключения
configuration[actions][] array of strings Относительные пути от базового URL до конкретных методов (массив "Код метода": "Путь", допустимые методы: calculate, save, get, delete, print, shipmentPointList, tariffList)
configuration[payerType] array Допустимые типы плательщиков за доставку (receiver - покупатель сам расплачивается напрямую со службой доставки; sender - магазин может брать деньги с покупателя за доставку и потом расплачивается со службой доставки)
configuration[platePrintLimit] integer Максимальное количество заказов при печати документов
configuration[rateDeliveryCost] boolean Рассчитывает ли интеграция со службой доставки стоимость самой доставки
configuration[allowPackages] boolean Разрешить использование упаковок
configuration[codAvailable] boolean Доставка наложенным платежом доступна/не доступна
configuration[selfShipmentAvailable] boolean Возможен самопривоз на терминал.
configuration[duplicateOrderProductSupported] boolean Возможность работы с заказом, содержащим несколько позиций с одинаковым торговым предложением
configuration[allowTrackNumber] boolean Передавать дополнительно трек номер помимо идентификатора доставки
configuration[availableCountries] array Список ISO кодов стран (ISO 3166-1 alpha-2) с которыми работает доставка. Если массив пустой, то нет ограничения на страны
configuration[requiredFields] array Список обязательных полей заказа
configuration[statusList][] array of objects (Status) Статусы службы доставки
configuration[statusList][][code] string Код статуса доставки
configuration[statusList][][name] string Наименование статуса
configuration[statusList][][isEditable] boolean Статус ("isEditable": true) допускает редактирование данных доставки
configuration[statusList][][isError] boolean Статус ("isError": true) сигнализирует о наличии проблем в процессе доставки. При попадании в этот статус менеджеру будет отправлено оповещение
configuration[statusList][][isPreprocessing] boolean Статус ("isPreprocessing": true) указывает, что доставка находится в процессе оформления и любые изменения с заказом не желательны. Данный флаг может быть необходим для интеграций, где оформление доставки выполняется в асинхронном режиме
configuration[plateList][] array of objects (Plate) Печатные формы, предоставляемых службой
configuration[plateList][][type] string Тип сущности для печатной формы (order - печатная форма для заказа (по умолчанию), shipment - печатная форма для отгрузки)
configuration[plateList][][code] string Код печатной формы
configuration[plateList][][label] string Наименование печатной формы
configuration[deliveryDataFieldList][] array of objects (DeliveryDataField) Дополнительные поля, необходимые для оформления доставки
configuration[deliveryDataFieldList][][code] string Код поля
configuration[deliveryDataFieldList][][label] string Имя поля
configuration[deliveryDataFieldList][][hint] string Пояснение к полю
configuration[deliveryDataFieldList][][type] string Тип поля. Возможны варианты (integer - числовое поле, text - текстовое поле, autocomplete - автокомплит поле, checkbox, choice - выпадающий список, date - поле с датой)
configuration[deliveryDataFieldList][][multiple] boolean Указывается для типа поля choice. Означает что можно выбирать несколько вариантов
configuration[deliveryDataFieldList][][choices] array Указывается для типа поля choice. Список возможных вариантов в выпадающем списке (массив объеков {"value": "value", "label": "label"}). Обязателен если тип поля choice
configuration[deliveryDataFieldList][][autocompleteUrl] string Указывается для типа поля autocomplete. Адрес, по окторому можно получить данные для автокомплит поля.
configuration[deliveryDataFieldList][][visible] boolean Отображать поле в карточке заказа
configuration[deliveryDataFieldList][][required] boolean Поле обязательно для заполнения
configuration[deliveryDataFieldList][][affectsCost] boolean Поле влияет на стоимость доставки. Если "affectsCost": true - значение поля используется в методе calculate
configuration[deliveryDataFieldList][][editable] boolean Разрешено ли редактировать поле. Если "editable": false - поле информационное - заполняется только данными, полученными напрямую от службы доставки (например стоимость страховки - может заполняться после оформления доставки или при расчете стоимости)
configuration[shipmentDataFieldList][] array of objects (DeliveryDataField) Дополнительные поля, необходимые для оформления доставки
configuration[settings] object (Settings) Настройки модуля
configuration[settings][defaultPayerType] string Плательщик за доставку по умолчанию
configuration[settings][costCalculateBy] string Стоимость доставки по умолчанию (Возможные значения auto|manual)
configuration[settings][nullDeclaredValue] boolean Нулевая объявленная стоимость по умолчанию
configuration[settings][lockedByDefault] boolean По умолчанию не синхронизировать со службой доставки
configuration[settings][paymentTypes][] array of objects (PaymentType) Способы оплаты (Справочник объектов)
configuration[settings][paymentTypes][][code] string Код типа платежа в системе
configuration[settings][paymentTypes][][active] boolean Возможность использования типа оплаты
configuration[settings][paymentTypes][][cod] boolean Оплата наложенным платежом
configuration[settings][shipmentPoints][] array of objects (ShipmentPoint) Склады (Справочник объектов)
configuration[settings][shipmentPoints][][code] string Код склада в системе
configuration[settings][shipmentPoints][][shipmentPointId] string Идентификатор терминала по умолчанию
configuration[settings][shipmentPoints][][shipmentPointLabel] string Название терминала по умолчанию
configuration[settings][statuses][] array of objects (Status) Соответствие статусов (Справочник объектов)
configuration[settings][statuses][][code] string Код статуса в системе
configuration[settings][statuses][][trackingStatusCode] string Код статуса в службе доставки
configuration[settings][deliveryExtraData] array Дополнительные значения полей доставки по умолчанию (deliveryDataField.code => значение)
configuration[settings][shipmentExtraData] array Дополнительные значения полей отгрузки по умолчанию (shipmentDataField.code => значение)
configuration[name] string Наименование службы доставки
configuration[code] string Код СД
configuration[logo] string Ссылка на svg логотип СД
configuration[baseUrl] string Базовый URL, на который делает запросы system
configuration[availableShipmentCountries] array Список ISO кодов стран (ISO 3166-1 alpha-2) из которых можно отправить посылку. Если массив пустой, то нет ограничения на страны
configuration[deliveryConfigurationUrl] string URL настроек интеграции со стороны службы доставки

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
404
  • Интеграция с данным кодом не зарегистрирована

POST /api/v4/delivery/generic/setting/{subcode}/edit Регистрация и конфигурация службы доставки

Регистрация и конфигурация службы доставки

Метод позволяет зарегистрировать новую интеграцию со службой доставки, либо изменить конфигурацию уже имеющейся интеграции. Подробнее про данный метод можно узнать в документации.

Параметры

ПараметрТипФорматОписание
configurationobject (ConfigurationApiV4)
configuration[description]string Описание подключения
configuration[actions][]array of strings Относительные пути от базового URL до конкретных методов (массив "Код метода": "Путь", допустимые методы: calculate, save, get, delete, print, shipmentPointList, tariffList)
configuration[payerType][]array{choice of [receiver|sender]} Допустимые типы плательщиков за доставку (receiver - покупатель сам расплачивается напрямую со службой доставки; sender - магазин может брать деньги с покупателя за доставку и потом расплачивается со службой доставки)
configuration[platePrintLimit]integer Максимальное количество заказов при печати документов
configuration[rateDeliveryCost]boolean Рассчитывает ли интеграция со службой доставки стоимость самой доставки
configuration[allowPackages]boolean Разрешить использование упаковок
configuration[codAvailable]boolean Доставка наложенным платежом доступна/не доступна
configuration[selfShipmentAvailable]boolean Возможен самопривоз на терминал.
configuration[duplicateOrderProductSupported]boolean Возможность работы с заказом, содержащим несколько позиций с одинаковым торговым предложением
configuration[allowTrackNumber]boolean Передавать дополнительно трек номер помимо идентификатора доставки
configuration[availableCountries][]array Список ISO кодов стран (ISO 3166-1 alpha-2) с которыми работает доставка. Если массив пустой, то нет ограничения на страны
configuration[requiredFields][]array Список обязательных полей заказа
configuration[statusList][]array of objects (Status) Статусы службы доставки
configuration[statusList][][code]string Код статуса доставки
configuration[statusList][][name]string Наименование статуса
configuration[statusList][][isEditable]boolean Статус ("isEditable": true) допускает редактирование данных доставки
configuration[statusList][][isError]boolean Статус ("isError": true) сигнализирует о наличии проблем в процессе доставки. При попадании в этот статус менеджеру будет отправлено оповещение
configuration[statusList][][isPreprocessing]boolean Статус ("isPreprocessing": true) указывает, что доставка находится в процессе оформления и любые изменения с заказом не желательны. Данный флаг может быть необходим для интеграций, где оформление доставки выполняется в асинхронном режиме
configuration[plateList][]array of objects (Plate) Печатные формы, предоставляемых службой
configuration[plateList][][type]string Тип сущности для печатной формы (order - печатная форма для заказа (по умолчанию), shipment - печатная форма для отгрузки)
configuration[plateList][][code]string Код печатной формы
configuration[plateList][][label]string Наименование печатной формы
configuration[deliveryDataFieldList][]array of objects (DeliveryDataField) Дополнительные поля, необходимые для оформления доставки
configuration[deliveryDataFieldList][][code]string Код поля
configuration[deliveryDataFieldList][][label]string Имя поля
configuration[deliveryDataFieldList][][hint]string Пояснение к полю
configuration[deliveryDataFieldList][][type]string Тип поля. Возможны варианты (integer - числовое поле, text - текстовое поле, autocomplete - автокомплит поле, checkbox, choice - выпадающий список, date - поле с датой)
configuration[deliveryDataFieldList][][multiple]boolean Указывается для типа поля choice. Означает что можно выбирать несколько вариантов
configuration[deliveryDataFieldList][][choices]array Указывается для типа поля choice. Список возможных вариантов в выпадающем списке (массив объеков {"value": "value", "label": "label"}). Обязателен если тип поля choice
configuration[deliveryDataFieldList][][autocompleteUrl]string Указывается для типа поля autocomplete. Адрес, по окторому можно получить данные для автокомплит поля.
configuration[deliveryDataFieldList][][visible]boolean Отображать поле в карточке заказа
configuration[deliveryDataFieldList][][required]boolean Поле обязательно для заполнения
configuration[deliveryDataFieldList][][affectsCost]boolean Поле влияет на стоимость доставки. Если "affectsCost": true - значение поля используется в методе calculate
configuration[deliveryDataFieldList][][editable]boolean Разрешено ли редактировать поле. Если "editable": false - поле информационное - заполняется только данными, полученными напрямую от службы доставки (например стоимость страховки - может заполняться после оформления доставки или при расчете стоимости)
configuration[shipmentDataFieldList][]array of objects (DeliveryDataField) Дополнительные поля, необходимые для оформления доставки
configuration[shipmentDataFieldList][][code]string Код поля
configuration[shipmentDataFieldList][][label]string Имя поля
configuration[shipmentDataFieldList][][hint]string Пояснение к полю
configuration[shipmentDataFieldList][][type]string Тип поля. Возможны варианты (integer - числовое поле, text - текстовое поле, autocomplete - автокомплит поле, checkbox, choice - выпадающий список, date - поле с датой)
configuration[shipmentDataFieldList][][multiple]boolean Указывается для типа поля choice. Означает что можно выбирать несколько вариантов
configuration[shipmentDataFieldList][][choices]array Указывается для типа поля choice. Список возможных вариантов в выпадающем списке (массив объеков {"value": "value", "label": "label"}). Обязателен если тип поля choice
configuration[shipmentDataFieldList][][autocompleteUrl]string Указывается для типа поля autocomplete. Адрес, по окторому можно получить данные для автокомплит поля.
configuration[shipmentDataFieldList][][visible]boolean Отображать поле в карточке заказа
configuration[shipmentDataFieldList][][required]boolean Поле обязательно для заполнения
configuration[shipmentDataFieldList][][affectsCost]boolean Поле влияет на стоимость доставки. Если "affectsCost": true - значение поля используется в методе calculate
configuration[shipmentDataFieldList][][editable]boolean Разрешено ли редактировать поле. Если "editable": false - поле информационное - заполняется только данными, полученными напрямую от службы доставки (например стоимость страховки - может заполняться после оформления доставки или при расчете стоимости)
configuration[settings]object (Settings) Настройки модуля
configuration[settings][defaultPayerType]string Плательщик за доставку по умолчанию
configuration[settings][costCalculateBy]string Стоимость доставки по умолчанию (Возможные значения auto|manual)
configuration[settings][nullDeclaredValue]boolean Нулевая объявленная стоимость по умолчанию
configuration[settings][lockedByDefault]boolean По умолчанию не синхронизировать со службой доставки
configuration[settings][paymentTypes][]array of objects (PaymentType) Способы оплаты (Справочник объектов)
configuration[settings][paymentTypes][][code]string Код типа платежа в системе
configuration[settings][paymentTypes][][active]boolean Возможность использования типа оплаты
configuration[settings][paymentTypes][][cod]boolean Оплата наложенным платежом
configuration[settings][shipmentPoints][]array of objects (ShipmentPoint) Склады (Справочник объектов)
configuration[settings][shipmentPoints][][code]string Код склада в системе
configuration[settings][shipmentPoints][][shipmentPointId]string Идентификатор терминала по умолчанию
configuration[settings][shipmentPoints][][shipmentPointLabel]string Название терминала по умолчанию
configuration[settings][statuses][]array of objects (Status) Соответствие статусов (Справочник объектов)
configuration[settings][statuses][][code]string Код статуса в системе
configuration[settings][statuses][][trackingStatusCode]string Код статуса в службе доставки
configuration[settings][deliveryExtraData]array Дополнительные значения полей доставки по умолчанию (deliveryDataField.code => значение)
configuration[settings][shipmentExtraData]array Дополнительные значения полей отгрузки по умолчанию (shipmentDataField.code => значение)
configuration[name]string Наименование службы доставки
configuration[code]string Код СД
configuration[logo]string Ссылка на svg логотип СД
configuration[baseUrl]string Базовый URL, на который делает запросы system
configuration[availableShipmentCountries][]array Список ISO кодов стран (ISO 3166-1 alpha-2) из которых можно отправить посылку. Если массив пустой, то нет ограничения на страны
configuration[deliveryConfigurationUrl]string URL настроек интеграции со стороны службы доставки

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
code string Код интеграции

POST /api/v4/delivery/generic/{subcode}/tracking Обновление статусов доставки

Обновление статусов доставки

Метод позволяет передавать статусы отдельно для каждого заказа в момент смены статуса или передавать историю изменений по группе заказов через определенные промежутки на усмотрение службы доставки.

Важно: За один запрос можно обновить статусы не более чем для 100 заказов. При передаче большего числа заказов метод вернет сообщение об ошибке.

Параметры

ПараметрТипФорматОписание
statusUpdate[]array of objects (RequestStatusUpdateItem) JSON с данными по статусам заказов
statusUpdate[][deliveryId]string Идентификатор доставки в СД
statusUpdate[][trackNumber]string Трек номер (если установлена опция configuration[allowTrackNumber])
statusUpdate[][cost]double Стоимость доставки
statusUpdate[][history][]array of objects (StatusInfo) История смены статусов доставки
statusUpdate[][history][][code]string Код статуса доставки
statusUpdate[][history][][updatedAt]DateTimeY-m-d\TH:i:sP Дата обновления статуса доставки
statusUpdate[][history][][comment]string Комментарий к статусу
statusUpdate[][extraData][]array of strings Массив дополнительных данных доставки (deliveryDataField.code => значение)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

CallbackGET {integrationModule["baseUrl"]}/{configuration["actions"]["autocomplete"]} Запрос на получение данных для автокомплит поля

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

При работе с autocomplete-полями, заданными в конфигурации integrationModule[integrations][delivery]["deliveryDataFieldList"], система будет инициализировать запрос к службе доставки используя GET запрос метода указанного в autocompleteUrl конфигурации соответствующего поля.

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
termstring Строка запроса

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
result[] array of objects (ResponseAutocompleteItem) Массив значений
result[][value] string Значение
result[][label] string Наименование
result[][description] string Не обязательное поле. Подсказка для опции - выводится мелким шрифтом под именем опции

CallbackPOST {integrationModule["baseUrl"]}/{configuration["actions"]["calculate"]} Расчет стоимости доставки

Расчет стоимости доставки

Для расчета стоимости доставки система инициирует вызов POST метода указанного в integrationModule[integrations][delivery]["actions"]["calculate"] конфигурации.

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
calculateobject (RequestCalculate) JSON с данными для расчета стоимости доставки
calculate[shipmentAddress]object (DeliveryAddress) Адрес отгрузки
calculate[shipmentAddress][index]string Индекс
calculate[shipmentAddress][countryIso]string ISO код страны (ISO 3166-1 alpha-2)
calculate[shipmentAddress][region]string Регион
calculate[shipmentAddress][regionId]integer Идентификатор региона в Geohelper
calculate[shipmentAddress][city]string Город
calculate[shipmentAddress][cityId]integer Идентификатор города в Geohelper
calculate[shipmentAddress][cityType]string Тип населенного пункта
calculate[shipmentAddress][street]string Улица
calculate[shipmentAddress][streetId]integer Идентификатор улицы в Geohelper
calculate[shipmentAddress][streetType]string Тип улицы
calculate[shipmentAddress][building]string Дом
calculate[shipmentAddress][flat]string Номер квартиры/офиса
calculate[shipmentAddress][floor]integer Этаж
calculate[shipmentAddress][block]integer Подъезд
calculate[shipmentAddress][house]string Строение
calculate[shipmentAddress][housing]string Корпус
calculate[shipmentAddress][metro]string Метро
calculate[shipmentAddress][notes]string Примечания к адресу
calculate[shipmentAddress][text]string Адрес в текстовом виде
calculate[shipmentAddress][terminal]string Код терминала отгрузки/доставки
calculate[store]object (Store) Склад отгрузки
calculate[store][code]string Символьный код
calculate[store][name]string Название
calculate[deliveryAddress]object (DeliveryAddress) Адрес доставки
calculate[deliveryAddress][index]string Индекс
calculate[deliveryAddress][countryIso]string ISO код страны (ISO 3166-1 alpha-2)
calculate[deliveryAddress][region]string Регион
calculate[deliveryAddress][regionId]integer Идентификатор региона в Geohelper
calculate[deliveryAddress][city]string Город
calculate[deliveryAddress][cityId]integer Идентификатор города в Geohelper
calculate[deliveryAddress][cityType]string Тип населенного пункта
calculate[deliveryAddress][street]string Улица
calculate[deliveryAddress][streetId]integer Идентификатор улицы в Geohelper
calculate[deliveryAddress][streetType]string Тип улицы
calculate[deliveryAddress][building]string Дом
calculate[deliveryAddress][flat]string Номер квартиры/офиса
calculate[deliveryAddress][floor]integer Этаж
calculate[deliveryAddress][block]integer Подъезд
calculate[deliveryAddress][house]string Строение
calculate[deliveryAddress][housing]string Корпус
calculate[deliveryAddress][metro]string Метро
calculate[deliveryAddress][notes]string Примечания к адресу
calculate[deliveryAddress][text]string Адрес в текстовом виде
calculate[deliveryAddress][terminal]string Код терминала отгрузки/доставки
calculate[packages][]array of objects (Package) Набор упаковок
calculate[packages][][packageId]string Идентификатор упаковки
calculate[packages][][weight]float Вес г.
calculate[packages][][width]integer Ширина мм.
calculate[packages][][length]integer Длина мм.
calculate[packages][][height]integer Высота мм.
calculate[packages][][items][]array of objects (PackageItem) Содержимое упаковки
calculate[packages][][items][][offerId]string Идентификатор оффера в системе
calculate[packages][][items][][externalId]string Идентификатор торгового предложения в магазине
calculate[packages][][items][][xmlId]string Идентификатор торгового предложения в складской системе
calculate[packages][][items][][name]string Наименование товара
calculate[packages][][items][][declaredValue]float Объявленная стоимость за единицу товара
calculate[packages][][items][][cod]float Наложенный платеж за единицу товара
calculate[packages][][items][][vatRate]string Ставка НДС ("none" - НДС не облагается)
calculate[packages][][items][][quantity]float Количество товара в упаковке
calculate[packages][][items][][unit]object (Unit) Единица измерения товара
calculate[packages][][items][][unit][code]string Символьный код
calculate[packages][][items][][unit][name]string Название
calculate[packages][][items][][unit][sym]string Краткое обозначение
calculate[packages][][items][][cost]float Стоимость товара (с учетом скидок)
calculate[packages][][items][][markingCodes][]array of strings Коды маркировки (формат кода маркировки)
calculate[packages][][items][][properties][]array of arrays Свойства товара
calculate[packages][][items][][weight]float Вес товара (может быть null для услуг)
calculate[declaredValue]float Объявленная стоимость
calculate[cod]float Сумма наложенного платежа по заказу
calculate[payerType]string Плательщик за доставку (receiver или sender)
calculate[shipmentDate]DateTimeY-m-d Дата отгрузки
calculate[deliveryDate]DateTimeY-m-d Дата доставки
calculate[deliveryTime]object (TimeInterval) Время доставки
calculate[deliveryTime][from]DateTimeH:i Время "с"
calculate[deliveryTime][to]DateTimeH:i Время "до"
calculate[deliveryTime][custom]string Временной диапазон в свободной форме
calculate[currency]string Код валюты
calculate[extraData][]array of objects (ExtraDataValue) Дополнительные данные доставки (deliveryDataField.code => значение)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
result[] array of objects (ResponseCalculate) Данные о стоимости доступных доставок
result[][code] string Код тарифа
result[][group] string Группа тарифов
result[][name] string Наименование тарифа
result[][type] string Тип тарифа (courier - курьерская доставка или selfDelivery - самовывоз)
result[][description] string Описание
result[][cost] float Стоимость доставки (Если не передана, то тариф будет выводиться, но не будет доступен для выбора) (в валюте объекта)
result[][minTerm] integer Минимальный срок доставки
result[][maxTerm] integer Максимальный срок доставки
result[][extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
result[][extraDataAvailable] array Массив кодов полей, которые должны отображаться в карточке заказа. Если не передан будут отображаться все поля с дополнительными данными доставки.
result[][pickuppointList][] array of objects (Terminal) Терминал отгрузки/получения
result[][pickuppointList][][code] string Код терминала
result[][pickuppointList][][cost] float Стоимость доставки до терминала (указывается в случае если она отличается от стандартной стоимости по тарифу)
result[][pickuppointList][][name] string Наименование терминала
result[][pickuppointList][][description] string Описание терминала
result[][pickuppointList][][address] string Адрес
result[][pickuppointList][][schedule] string Режим работы
result[][pickuppointList][][phone] string Телефон
result[][pickuppointList][][extraData] array Дополнительные данные (deliveryDataField.code => значение)
result[][pickuppointList][][coordinates] object (Coordinates) Координаты
result[][pickuppointList][][coordinates][latitude] string Широта
result[][pickuppointList][][coordinates][longitude] string Долгота

CallbackPOST {integrationModule["baseUrl"]}/{configuration["actions"]["delete"]} Удаление заявки на доставку

Удаление заявки на доставку

Для удаления доставки система инициирует POST вызов метода указанного в integrationModule[integrations][delivery]["actions"]["delete"] кофигурации.

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
deleteobject (RequestDelete) JSON с идентификатором доставки
delete[deliveryId]string Идентификатор доставки в службе доставки

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

CallbackGET {integrationModule["baseUrl"]}/{configuration["actions"]["get"]} Получение данных доставки

Получение данных доставки

Для получения данных для доставки система инициирует GET запрос метода указанного в integrationModule[integrations][delivery]["actions"]["get"]

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
deliveryIdstring Идентификатор доставки в службе доставки

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
result object (ResponseLoadDeliveryData) Данные доставки
result[trackNumber] string Трек номер (если установлена опция configuration[allowTrackNumber])
result[cost] float Стоимость доставки
result[shipmentDate] DateTime Дата отгрузки
result[deliveryDate] DateTime Дата доставки
result[deliveryTime] object (TimeInterval) Время доставки
result[deliveryTime][from] DateTime Время "с"
result[deliveryTime][to] DateTime Время "до"
result[deliveryTime][custom] string Временной диапазон в свободной форме
result[tariff] string Код тарифа
result[tariffName] string Наименование тарифа
result[payerType] string Плательщик за доставку (receiver или sender)
result[status] object (StatusInfo) Статус доставки
result[status][code] string Код статуса доставки
result[status][updatedAt] DateTime Дата обновления статуса доставки
result[status][comment] string Комментарий к статусу
result[extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
result[shipmentAddress] object (DeliveryAddress) Адрес отгрузки
result[shipmentAddress][index] string Индекс
result[shipmentAddress][countryIso] string ISO код страны (ISO 3166-1 alpha-2)
result[shipmentAddress][region] string Регион
result[shipmentAddress][regionId] integer Идентификатор региона в Geohelper
result[shipmentAddress][city] string Город
result[shipmentAddress][cityId] integer Идентификатор города в Geohelper
result[shipmentAddress][cityType] string Тип населенного пункта
result[shipmentAddress][street] string Улица
result[shipmentAddress][streetId] integer Идентификатор улицы в Geohelper
result[shipmentAddress][streetType] string Тип улицы
result[shipmentAddress][building] string Дом
result[shipmentAddress][flat] string Номер квартиры/офиса
result[shipmentAddress][floor] integer Этаж
result[shipmentAddress][block] integer Подъезд
result[shipmentAddress][house] string Строение
result[shipmentAddress][housing] string Корпус
result[shipmentAddress][metro] string Метро
result[shipmentAddress][notes] string Примечания к адресу
result[shipmentAddress][text] string Адрес в текстовом виде
result[shipmentAddress][terminal] string Код терминала отгрузки/доставки
result[shipmentAddress][terminalData] object (Terminal) Данные терминала
result[shipmentAddress][terminalData][code] string Код терминала
result[shipmentAddress][terminalData][cost] float Стоимость доставки до терминала (указывается в случае если она отличается от стандартной стоимости по тарифу)
result[shipmentAddress][terminalData][name] string Наименование терминала
result[shipmentAddress][terminalData][description] string Описание терминала
result[shipmentAddress][terminalData][address] string Адрес
result[shipmentAddress][terminalData][schedule] string Режим работы
result[shipmentAddress][terminalData][phone] string Телефон
result[shipmentAddress][terminalData][extraData] array Дополнительные данные (deliveryDataField.code => значение)
result[shipmentAddress][terminalData][coordinates] object (Coordinates) Координаты
result[shipmentAddress][terminalData][coordinates][latitude] string Широта
result[shipmentAddress][terminalData][coordinates][longitude] string Долгота
result[deliveryAddress] object (DeliveryAddress) Адрес доставки
result[deliveryAddress][index] string Индекс
result[deliveryAddress][countryIso] string ISO код страны (ISO 3166-1 alpha-2)
result[deliveryAddress][region] string Регион
result[deliveryAddress][regionId] integer Идентификатор региона в Geohelper
result[deliveryAddress][city] string Город
result[deliveryAddress][cityId] integer Идентификатор города в Geohelper
result[deliveryAddress][cityType] string Тип населенного пункта
result[deliveryAddress][street] string Улица
result[deliveryAddress][streetId] integer Идентификатор улицы в Geohelper
result[deliveryAddress][streetType] string Тип улицы
result[deliveryAddress][building] string Дом
result[deliveryAddress][flat] string Номер квартиры/офиса
result[deliveryAddress][floor] integer Этаж
result[deliveryAddress][block] integer Подъезд
result[deliveryAddress][house] string Строение
result[deliveryAddress][housing] string Корпус
result[deliveryAddress][metro] string Метро
result[deliveryAddress][notes] string Примечания к адресу
result[deliveryAddress][text] string Адрес в текстовом виде
result[deliveryAddress][terminal] string Код терминала отгрузки/доставки
result[deliveryAddress][terminalData] object (Terminal) Данные терминала
result[deliveryAddress][terminalData][code] string Код терминала
result[deliveryAddress][terminalData][cost] float Стоимость доставки до терминала (указывается в случае если она отличается от стандартной стоимости по тарифу)
result[deliveryAddress][terminalData][name] string Наименование терминала
result[deliveryAddress][terminalData][description] string Описание терминала
result[deliveryAddress][terminalData][address] string Адрес
result[deliveryAddress][terminalData][schedule] string Режим работы
result[deliveryAddress][terminalData][phone] string Телефон
result[deliveryAddress][terminalData][extraData] array Дополнительные данные (deliveryDataField.code => значение)
result[deliveryAddress][terminalData][coordinates] object (Coordinates) Координаты
result[deliveryAddress][terminalData][coordinates][latitude] string Широта
result[deliveryAddress][terminalData][coordinates][longitude] string Долгота

CallbackPOST {integrationModule["baseUrl"]}/{configuration["actions"]["print"]} Печатные формы службы доставки

Печатные формы службы доставки

Для печати форм указанных при конфигурации в integrationModule[integrations][delivery]["plateList"] система инициирует POST запрос метода указанного в integrationModule[integrations][delivery]["actions"]["print"].

Служба доставки должна сформировать pdf-файл печатной формы и вернуть его в виде байтового массива

Если требуется показать пользователю сообщение об ошибке, то нужно вернуть ответ с кодом 400. Содержимое ответа должно быть стандартным ответом с сообщением об ошибке.

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
printobject (RequestPrint) JSON со списком заказов для печати
print[entityType]string Тип сущности для печатной формы (order - печатная форма для заказа (по умолчанию), shipment - печатная форма для отгрузки. Значение совпадает со значением integrationModule[integrations][delivery][plateList][][type] выбранной печатной формы)
print[type]string Код типа печатной формы
print[deliveryIds]array Массив идентификаторов доставок в службе доставки ([["56376", "798645"]])

CallbackPOST {integrationModule["baseUrl"]}/{configuration["actions"]["save"]} Создание и редактирование доставки

Создание и редактирование доставки

Для создания новой доставки система инициирует POST вызов метода указанного в integrationModule[integrations][delivery]["actions"]["save"] кофигурации. Запрос на редактирование доставки аналогичен запросу на создание, но необходимо передавать идентификатор заказа в службе доставки save["deliveryId"].

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
saveobject (RequestSave) JSON с данными для создания доставки
save[deliveryId]string Идентификатор доставки в службе доставки. Передается если требуется отредактировать уже оформленную доставку
save[order]string Внутренний ID заказа
save[orderNumber]string Номер заказа
save[site]string Код магазина
save[siteName]string Наименование магазина
save[store]object (Store) Склад отгрузки
save[store][code]string Символьный код
save[store][name]string Название
save[store][address]object (StoreAddress) Адрес склада
save[store][address][index]string Индекс
save[store][address][countryIso]string ISO код страны
save[store][address][region]string Регион
save[store][address][regionId]integer Идентификатор региона в Geohelper
save[store][address][city]string Город
save[store][address][cityId]integer Идентификатор города в Geohelper
save[store][address][cityType]string Тип населенного пункта
save[store][address][street]string Улица
save[store][address][streetId]integer Идентификатор улицы в Geohelper
save[store][address][streetType]string Тип улицы
save[store][address][building]string Дом
save[store][address][flat]string Номер квартиры/офиса
save[store][address][floor]integer Этаж
save[store][address][block]integer Подъезд
save[store][address][house]string Строение
save[store][address][housing]string Корпус
save[store][address][metro]string Метро
save[store][address][notes]string Примечания к адресу
save[store][address][text]string Адрес в текстовом виде
save[store][workTime]object (SerializedStoreWeekOpeningHours) Время работы склада
save[store][workTime][mo][]array of objects (StoreWorkTime) Время работы склада в понедельник
save[store][workTime][mo][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][mo][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][mo][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][mo][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[store][workTime][tu][]array of objects (StoreWorkTime) Время работы склада во вторник
save[store][workTime][tu][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][tu][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][tu][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][tu][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[store][workTime][we][]array of objects (StoreWorkTime) Время работы склада в среду
save[store][workTime][we][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][we][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][we][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][we][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[store][workTime][th][]array of objects (StoreWorkTime) Время работы склада в четверг
save[store][workTime][th][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][th][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][th][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][th][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[store][workTime][fr][]array of objects (StoreWorkTime) Время работы склада в пятницу
save[store][workTime][fr][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][fr][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][fr][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][fr][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[store][workTime][sa][]array of objects (StoreWorkTime) Время работы склада в субботу
save[store][workTime][sa][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][sa][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][sa][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][sa][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[store][workTime][su][]array of objects (StoreWorkTime) Время работы склада в воскресенье
save[store][workTime][su][][startTime]string Время начала работы склада (в формате H:i)
save[store][workTime][su][][endTime]string Время окончания работы склада (в формате H:i)
save[store][workTime][su][][lunchStartTime]string Время начала перерыва (в формате H:i)
save[store][workTime][su][][lunchEndTime]string Время окончания перерыва (в формате H:i)
save[legalEntity]string Наименование юридического лица продавца
save[customer]object (Customer) Покупатель
save[customer][id]integer Идентификатор покупателя
save[customer][lastName]string Фамилия
save[customer][firstName]string Имя
save[customer][patronymic]string Отчество
save[customer][phones][]array of strings Телефоны
save[customer][email]string E-mail
save[customer][contragent]object (Contragent) Данные контрагента
save[customer][contragent][type]string Тип контрагента
save[customer][contragent][legalName]string Полное наименование
save[customer][contragent][legalAddress]string Адрес регистрации
save[customer][contragent][INN]string ИНН
save[customer][contragent][OKPO]string ОКПО
save[customer][contragent][KPP]string КПП
save[customer][contragent][OGRN]string ОГРН
save[customer][contragent][OGRNIP]string ОГРНИП
save[manager]object (Manager) Менеджер, работающий с покупателем
save[manager][id]integer Идентификатор менеджера
save[manager][lastName]string Фамилия
save[manager][firstName]string Имя
save[manager][patronymic]string Отчество
save[manager][phone]string Телефон
save[manager][email]string E-mail
save[packages][]array of objects (Package) Набор упаковок
save[packages][][packageId]string Идентификатор упаковки
save[packages][][weight]float Вес г.
save[packages][][width]integer Ширина мм.
save[packages][][length]integer Длина мм.
save[packages][][height]integer Высота мм.
save[packages][][items][]array of objects (PackageItem) Содержимое упаковки
save[packages][][items][][offerId]string Идентификатор оффера в системе
save[packages][][items][][externalId]string Идентификатор торгового предложения в магазине
save[packages][][items][][xmlId]string Идентификатор торгового предложения в складской системе
save[packages][][items][][name]string Наименование товара
save[packages][][items][][declaredValue]float Объявленная стоимость за единицу товара
save[packages][][items][][cod]float Наложенный платеж за единицу товара
save[packages][][items][][vatRate]string Ставка НДС ("none" - НДС не облагается)
save[packages][][items][][quantity]float Количество товара в упаковке
save[packages][][items][][unit]object (Unit) Единица измерения товара
save[packages][][items][][unit][code]string Символьный код
save[packages][][items][][unit][name]string Название
save[packages][][items][][unit][sym]string Краткое обозначение
save[packages][][items][][cost]float Стоимость товара (с учетом скидок)
save[packages][][items][][markingCodes][]array of strings Коды маркировки (формат кода маркировки)
save[packages][][items][][properties][]array of arrays Свойства товара
save[packages][][items][][weight]float Вес товара (может быть null для услуг)
save[delivery]object (SaveDeliveryData) Данные доставки
save[delivery][shipmentAddress]object (DeliveryAddress) Адрес отгрузки
save[delivery][shipmentAddress][index]string Индекс
save[delivery][shipmentAddress][countryIso]string ISO код страны (ISO 3166-1 alpha-2)
save[delivery][shipmentAddress][region]string Регион
save[delivery][shipmentAddress][regionId]integer Идентификатор региона в Geohelper
save[delivery][shipmentAddress][city]string Город
save[delivery][shipmentAddress][cityId]integer Идентификатор города в Geohelper
save[delivery][shipmentAddress][cityType]string Тип населенного пункта
save[delivery][shipmentAddress][street]string Улица
save[delivery][shipmentAddress][streetId]integer Идентификатор улицы в Geohelper
save[delivery][shipmentAddress][streetType]string Тип улицы
save[delivery][shipmentAddress][building]string Дом
save[delivery][shipmentAddress][flat]string Номер квартиры/офиса
save[delivery][shipmentAddress][floor]integer Этаж
save[delivery][shipmentAddress][block]integer Подъезд
save[delivery][shipmentAddress][house]string Строение
save[delivery][shipmentAddress][housing]string Корпус
save[delivery][shipmentAddress][metro]string Метро
save[delivery][shipmentAddress][notes]string Примечания к адресу
save[delivery][shipmentAddress][text]string Адрес в текстовом виде
save[delivery][shipmentAddress][terminal]string Код терминала отгрузки/доставки
save[delivery][deliveryAddress]object (DeliveryAddress) Адрес доставки
save[delivery][deliveryAddress][index]string Индекс
save[delivery][deliveryAddress][countryIso]string ISO код страны (ISO 3166-1 alpha-2)
save[delivery][deliveryAddress][region]string Регион
save[delivery][deliveryAddress][regionId]integer Идентификатор региона в Geohelper
save[delivery][deliveryAddress][city]string Город
save[delivery][deliveryAddress][cityId]integer Идентификатор города в Geohelper
save[delivery][deliveryAddress][cityType]string Тип населенного пункта
save[delivery][deliveryAddress][street]string Улица
save[delivery][deliveryAddress][streetId]integer Идентификатор улицы в Geohelper
save[delivery][deliveryAddress][streetType]string Тип улицы
save[delivery][deliveryAddress][building]string Дом
save[delivery][deliveryAddress][flat]string Номер квартиры/офиса
save[delivery][deliveryAddress][floor]integer Этаж
save[delivery][deliveryAddress][block]integer Подъезд
save[delivery][deliveryAddress][house]string Строение
save[delivery][deliveryAddress][housing]string Корпус
save[delivery][deliveryAddress][metro]string Метро
save[delivery][deliveryAddress][notes]string Примечания к адресу
save[delivery][deliveryAddress][text]string Адрес в текстовом виде
save[delivery][deliveryAddress][terminal]string Код терминала отгрузки/доставки
save[delivery][codPaymentType]object (PaymentType) Тип оплаты для наложенного платежа
save[delivery][codPaymentType][code]string Символьный код
save[delivery][codPaymentType][name]string Название
save[delivery][withCod]boolean Доставка наложенным платежом
save[delivery][cod]float Величина наложенного платежа за услуги доставки
save[delivery][cost]float Стоимость доставки (указывается в накладной в случае предоплаты)
save[delivery][vatRate]string Ставка НДС на услугу доставки ("none" - НДС не облагается)
save[delivery][tariff]string Код тарифа
save[delivery][payerType]string Плательщик за услуги доставки (receiver или sender)
save[delivery][shipmentDate]DateTimeY-m-d Дата отгрузки
save[delivery][deliveryDate]DateTimeY-m-d Дата доставки
save[delivery][deliveryTime]object (TimeInterval) Время доставки ("custom" не ипользуется)
save[delivery][deliveryTime][from]DateTimeH:i Время "с"
save[delivery][deliveryTime][to]DateTimeH:i Время "до"
save[delivery][deliveryTime][custom]string Временной диапазон в свободной форме
save[delivery][extraData][]array of objects (ExtraDataValue) Дополнительные данные доставки (deliveryDataField.code => значение)
save[currency]string Код валюты

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
result object (ResponseSave) Результат оформления доставки
result[deliveryId] string Идентификатор доставки в службе доставки
result[trackNumber] string Трек номер (если установлена опция configuration[allowTrackNumber])
result[cost] float Стоимость доставки
result[status] string Код статуса доставки
result[extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)

CallbackGET {integrationModule["baseUrl"]}/{configuration["actions"]["shipmentPointList"]} Список терминалов приема посылок

Список терминалов приема посылок

Для работы с терминалами система инициирует GET запрос метода указанного в integrationModule[integrations][delivery]["actions"]["shipmentPointList"].

Параметры

ПараметрТипФорматОписание
clientIdstring Идентификатор клиента во внешнем сервисе
countrystring ISO код страны (ISO 3166-1 alpha-2)
regionstring Регион
regionIdinteger Идентификатор региона в Geohelper
citystring Город
cityIdinteger Идентификатор города в Geohelper
codestring Код склада отгрузки

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
result[] array of objects (Terminal) Терминал отгрузки/получения
result[][code] string Код терминала
result[][cost] float Стоимость доставки до терминала (указывается в случае если она отличается от стандартной стоимости по тарифу)
result[][name] string Наименование терминала
result[][description] string Описание терминала
result[][address] string Адрес
result[][schedule] string Режим работы
result[][phone] string Телефон
result[][extraData] array Дополнительные данные (deliveryDataField.code => значение)
result[][coordinates] object (Coordinates) Координаты
result[][coordinates][latitude] string Широта
result[][coordinates][longitude] string Долгота

Заказы

GET /api/v4/orders Получение списка заказов, удовлетворяющих заданному фильтру

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

Для доступа к методу необходимо разрешение order_read.

Результат возвращается постранично. В поле pagination содержится информация о постраничной разбивке.

В фильтрах filter[managers][], filter[couriers][] указывается массив внутренних ID элементов в системе.

В фильтрах filter[orderTypes][], filter[paymentStatuses][], filter[paymentTypes][], filter[deliveryTypes][], filter[orderMethods][], filter[managerGroups][] указывается массив символьных кодов элементов.

В фильтрах filter[sourceName], filter[mediumName], filter[campaignName], filter[keywordName], filter[adContentName] указывается название элементов.

В фильтре filter[numbers] производится точное сравнение с элементами заданного массива строк.

В фильтрах filter[ids][] и filter[externalIds][] передается массив внутренних и внешних идентификаторов соответственно.

В фильтре filter[extendedStatus][] можно указывать один или несколько статусов или групп статусов заказа. Для фильтрации по статусу передается символьный код статуса. Для фильтрации по группе статусов передается символьный код группы статусов плюс постфикс -group. Пример: filter[extendedStatus][]=new&filter[extendedStatus][]=approval-group.

С помощью фильтра filter[customFields][] можно производить поиск по значениям пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» и «Дата-время» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Для пользовательских полей типа Целое число, Число, Дата и Дата-время фильтрация осуществляется по диапазону, для остальных типов полей — по точному значению. Имя фильтра соответствует символьному коду поля. Пример: для поля типа Дата с символьным кодом birth_date доступны фильтры filter[customFields][birth_date][min] и filter[customFields][birth_date][max]. Для поля типа Справочник с символьным кодом quality доступен множественный фильтр filter[customFields][quality][].

В фильтре filter[attachments] можно указать одно из трех значений:

В фильтре filter[tasksCounts] можно указать одно из трех значений:

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

Пустые поля без значений не возвращаются.

В полях orderType, orderMethod, paymentType, paymentStatus, status, site, delivery[code] возвращается символьный код элемента.

В полях managerId, sourceId возвращается внутренний ID сущности в системе.

В поле customFields возвращается массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Если адрес доставки указывался в строковом виде, то он будет возвращен в delivery[address][text]. Если адрес указывался в детальном виде, то будут возвращены все заполненные поля доставки, а в delivery[address][text] будет находиться автоматически сформированное текстовое представление адреса.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (OrderFilterData)
filter[ids][]array of integers Массив ID заказов
filter[externalIds][]array of strings Массив externalID заказов
filter[numbers][]array of strings Массив номеров заказов (не более 100 номеров в одном запросе)
filter[customerId]integer{range: {>=0, <=100000000000}} Внутренний ID клиента
filter[customerExternalId]string{length: {max: 255}} Внешний ID клиента
filter[customer]string{length: {max: 255}} Клиент (ФИО или телефон)
filter[customerType]string[customer|customer_corporate] Тип клиента
filter[email]string{length: {max: 255}} E-mail
filter[managers][]array of integers Менеджеры
filter[managerGroups][]array of strings Группы менеджеров
filter[paymentStatuses][]array of strings Статусы оплаты
filter[orderTypes][]array of strings Типы заказа
filter[orderMethods][]array of strings Способы оформления
filter[product]string{length: {max: 255}} Товар (название или артикул)
filter[productSearchType]string
filter[extendedStatus][]array of strings Статус заказа
filter[statusComment]string{length: {max: 255}}
filter[sites][]array of strings Магазины
filter[vip]boolean Важный клиент
filter[bad]boolean Плохой клиент
filter[expired]boolean Заказ просрочен
filter[call]boolean Требуется позвонить
filter[online]boolean Клиент на сайте
filter[paymentTypes][]array of strings Типы оплаты
filter[deliveryStates][]array of strings{choice of [cancel|cancel_force|error|none|processing|success]} Статусы оформления
filter[deliveryTypes][]array of strings Типы доставки
filter[deliveryServices][]array of strings Службы доставки
filter[countries][]array of strings Страны
filter[region]string{length: {max: 255}} Регион
filter[city]string{length: {max: 255}} Город
filter[index]string Почтовый индекс
filter[metro]string{length: {max: 255}} Метро
filter[sourceName]string{length: {max: 255}} Источник
filter[mediumName]string{length: {max: 255}} Канал
filter[campaignName]string{length: {max: 255}} Кампания
filter[keywordName]string Ключевое слово
filter[adContentName]string Содержание кампании
filter[managerComment]string{length: {max: 255}} Комментарий менеджера
filter[customerComment]string{length: {max: 255}} Комментарий клиента
filter[trackNumber]string{length: {max: 255}} Номер отправления в службе доставки
filter[deliveryExternalId]string Идентификатор в службе доставки
filter[couriers][]array of integers Курьеры
filter[contragentName]string{length: {max: 255}} Полное наименование
filter[contragentTypes][]array of strings{choice of [enterpreneur|individual|legal-entity]} Типы контрагента
filter[contragentInn]string{match: /\d+/} ИНН
filter[contragentKpp]string{match: /\d+/} КПП
filter[contragentBik]string{match: /\d+/} БИК банка
filter[contragentCorrAccount]string{match: /\d+/} Корр. счет банка
filter[contragentBankAccount]string{match: /\d+/} Расчетный счет
filter[companyName]string{length: {max: 255}} Компания (название)
filter[deliveryAddressNotes]string{length: {max: 255}} Примечания к адресу доставки
filter[productGroups][]array of integers
filter[shipmentStores][]array of strings Склады отгрузки
filter[shipped]boolean Отгружен
filter[attachments]integer[1|2|3] Прикрепленные объекты (вложения)
filter[receiptFiscalDocumentAttribute]string{length: {max: 255}} Фискальный признак документа
filter[receiptStatus]string[done|fail|wait] Статус фискализации
filter[receiptOperation]string[sell|sell_refund] Операция фискализации
filter[receiptOrderStatus]string[done|fail|wait] Статус полной фискализации
filter[mgChannels][]array of integers Каналы чатов
filter[tasksCounts]integer[1|2|3] Задачи
filter[tags][]array of strings
filter[attachedTags][]array of strings
filter[createdAtFrom]DateTimeY-m-d Дата оформления заказа (от)
filter[createdAtTo]DateTimeY-m-d Дата оформления заказа (до)
filter[fullPaidAtFrom]DateTimeY-m-d Дата полной оплаты (от)
filter[fullPaidAtTo]DateTimeY-m-d Дата полной оплаты (до)
filter[deliveryDateFrom]DateTimeY-m-d Дата доставки (от)
filter[deliveryDateTo]DateTimeY-m-d Дата доставки (до)
filter[statusUpdatedAtFrom]DateTimeY-m-d Дата последнего изменения статуса (от)
filter[statusUpdatedAtTo]DateTimeY-m-d Дата последнего изменения статуса (до)
filter[shipmentDateFrom]DateTimeY-m-d Дата отгрузки (от)
filter[shipmentDateTo]DateTimeY-m-d Дата отгрузки (до)
filter[firstWebVisitFrom]DateTimeY-m-d Первое посещение (от)
filter[firstWebVisitTo]DateTimeY-m-d Первое посещение (до)
filter[lastWebVisitFrom]DateTimeY-m-d Последнее посещение (от)
filter[lastWebVisitTo]DateTimeY-m-d Последнее посещение (до)
filter[firstOrderFrom]DateTimeY-m-d Первый заказ (от)
filter[firstOrderTo]DateTimeY-m-d Первый заказ (до)
filter[lastOrderFrom]DateTimeY-m-d Последний заказ (от)
filter[lastOrderTo]DateTimeY-m-d Последний заказ (до)
filter[paidAtFrom]DateTimeY-m-d Дата оплаты (от)
filter[paidAtTo]DateTimeY-m-d Дата оплаты (до)
filter[deliveryTimeFrom]DateTimeHH:MM:SS Время доставки (с)
filter[deliveryTimeTo]DateTimeHH:MM:SS Время доставки (до)
filter[minPrice]integer Стоимость заказа (от)
filter[maxPrice]integer Стоимость заказа (до)
filter[minCostSumm]integer Сумма расходов (от)
filter[maxCostSumm]integer Сумма расходов (до)
filter[minPrepaySumm]integer Оплачено (от)
filter[maxPrepaySumm]integer Оплачено (до)
filter[minDeliveryCost]integer Стоимость доставки (от)
filter[maxDeliveryCost]integer Стоимость доставки (до)
filter[minDeliveryNetCost]integer Себестоимость доставки (от)
filter[maxDeliveryNetCost]integer Себестоимость доставки (до)
filter[minMarginSumm]integer Валовая прибыль заказа (от)
filter[maxMarginSumm]integer Валовая прибыль заказа (до)
filter[minPurchaseSumm]integer Закупочная стоимость заказа (от)
filter[maxPurchaseSumm]integer Закупочная стоимость заказа (до)
filter[customFields]array Фильтр по пользовательским полям

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
orders[] array of objects (Order) Заказ
orders[][paymentType] string deprecated Тип оплаты
orders[][paymentStatus] string deprecated Статус оплаты
orders[][slug] custom handler result for (int) deprecated Символьный код
orders[][discount] float Денежная скидка на весь заказ
orders[][discountPercent] float Процентная скидка на весь заказ
orders[][paymentDetail] string deprecated Детали платежа
orders[][currency] string Валюта
orders[][id] integer ID заказа
orders[][number] string Номер заказа
orders[][externalId] string Внешний ID заказа
orders[][orderType] string Тип заказа
orders[][orderMethod] string Способ оформления
orders[][countryIso] string ISO код страны
orders[][createdAt] DateTime Дата оформления заказа
orders[][statusUpdatedAt] DateTime Дата последнего изменения статуса
orders[][totalSumm] double Общая сумма с учетом скидки (в валюте объекта)
orders[][prepaySum] double Оплаченная сумма (в валюте объекта)
orders[][purchaseSumm] double Общая стоимость закупки (в базовой валюте)
orders[][mark] integer Оценка заказа
orders[][markDatetime] DateTime Дата и время получение оценки от покупателя
orders[][lastName] string Фамилия
orders[][firstName] string Имя
orders[][patronymic] string Отчество
orders[][phone] string Телефон
orders[][additionalPhone] string Дополнительный телефон
orders[][email] string E-mail
orders[][call] boolean Требуется позвонить
orders[][expired] boolean Просрочен
orders[][customerComment] string Комментарий клиента
orders[][managerComment] string Комментарий оператора
orders[][managerId] integer Менеджер, прикрепленный к заказу
orders[][customer]КлиентКорпоративный клиент
orders[][customer][id] integer ID клиентаID корпоративного клиента
orders[][customer][externalId] string Внешний ID клиентаВнешний ID корпоративного клиента
orders[][customer][isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
orders[][customer][createdAt] DateTime СозданСоздан
orders[][customer][managerId] integer Менеджер клиентаМенеджер корпоративного клиента
orders[][customer][vip] boolean Важный клиентВажный клиент
orders[][customer][bad] boolean Плохой клиентПлохой клиент
orders[][customer][site] string Магазин, с которого пришел клиентМагазин, с которого пришел клиент
orders[][customer][contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
orders[][customer][contragent][contragentType] string Тип контрагента
orders[][customer][contragent][legalName] string Полное наименование
orders[][customer][contragent][legalAddress] string Адрес регистрации
orders[][customer][contragent][INN] string ИНН
orders[][customer][contragent][OKPO] string ОКПО
orders[][customer][contragent][KPP] string КПП
orders[][customer][contragent][OGRN] string ОГРН
orders[][customer][contragent][OGRNIP] string ОГРНИП
orders[][customer][contragent][certificateNumber] string Номер свидетельства
orders[][customer][contragent][certificateDate] DateTime Дата свидетельства
orders[][customer][contragent][BIK] string БИК
orders[][customer][contragent][bank] string Банк
orders[][customer][contragent][bankAddress] string Адрес банка
orders[][customer][contragent][corrAccount] string Корр. счёт
orders[][customer][contragent][bankAccount] string Расчётный счёт
orders[][customer][firstClientId] string Первая метка клиента Google AnalyticsПервая метка клиента Google Analytics
orders[][customer][lastClientId] string Последняя метка клиента Google AnalyticsПоследняя метка клиента Google Analytics
orders[][customer][customFields] array Ассоциативный массив пользовательских полейАссоциативный массив пользовательских полей
orders[][customer][personalDiscount] double Персональная скидкаПерсональная скидка
orders[][customer][cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
orders[][customer][discountCardNumber] string Номер дисконтной картыНомер дисконтной карты
orders[][customer][avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте)
orders[][customer][marginSumm] float LTV (в базовой валюте)LTV (в базовой валюте)
orders[][customer][totalSumm] float Общая сумма заказов (в базовой валюте)Общая сумма заказов (в базовой валюте)
orders[][customer][averageSumm] float Средняя сумма заказа (в базовой валюте)Средняя сумма заказа (в базовой валюте)
orders[][customer][ordersCount] integer Количество заказовКоличество заказов
orders[][customer][address] object (CustomerAddress) Адрес клиента
orders[][customer][address][id] integer ID адреса
orders[][customer][address][index] string Индекс
orders[][customer][address][countryIso] string ISO код страны
orders[][customer][address][region] string Регион
orders[][customer][address][regionId] integer Идентификатор региона в Geohelper
orders[][customer][address][city] string Город
orders[][customer][address][cityId] integer Идентификатор города в Geohelper
orders[][customer][address][cityType] string Тип населенного пункта
orders[][customer][address][street] string Улица
orders[][customer][address][streetId] integer Идентификатор улицы в Geohelper
orders[][customer][address][streetType] string Тип улицы
orders[][customer][address][building] string Дом
orders[][customer][address][flat] string Номер квартиры/офиса
orders[][customer][address][floor] integer Этаж
orders[][customer][address][block] integer Подъезд
orders[][customer][address][house] string Строение
orders[][customer][address][housing] string Корпус
orders[][customer][address][metro] string Метро
orders[][customer][address][notes] string Примечания к адресу
orders[][customer][address][text] string Адрес в текстовом виде
orders[][customer][maturationTime] integer Время «созревания», в секундах
orders[][customer][firstName] string Имя
orders[][customer][lastName] string Фамилия
orders[][customer][patronymic] string Отчество
orders[][customer][email] string E-mail
orders[][customer][emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
orders[][customer][customerSubscriptions][] array of objects (CustomerSubscription) Подписки
orders[][customer][customerSubscriptions][][subscription] object (Subscription) Категория подписки
orders[][customer][customerSubscriptions][][subscription][id] integer ID категории подписки
orders[][customer][customerSubscriptions][][subscription][channel] string Канал
orders[][customer][customerSubscriptions][][subscription][name] string Название
orders[][customer][customerSubscriptions][][subscription][code] string Символьный код
orders[][customer][customerSubscriptions][][subscription][active] boolean Статус активности
orders[][customer][customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
orders[][customer][customerSubscriptions][][subscription][ordering] integer
orders[][customer][customerSubscriptions][][subscribed] boolean Активность подписки
orders[][customer][customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
orders[][customer][phones][] array of objects (CustomerPhone) Телефоны
orders[][customer][phones][][number] string Номер телефона
orders[][customer][birthday] DateTime День рождения
orders[][customer][source] object (SerializedSource) Источник клиента
orders[][customer][source][source] string Источник
orders[][customer][source][medium] string Канал
orders[][customer][source][campaign] string Кампания
orders[][customer][source][keyword] string Ключевое слово
orders[][customer][source][content] string Содержание кампании
orders[][customer][mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
orders[][customer][mgCustomers][][id] integer ID клиента
orders[][customer][mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
orders[][customer][mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
orders[][customer][mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
orders[][customer][commentary] string deprecated Комментарий
orders[][customer][photoUrl] string URL фотографии
orders[][customer][nickName] string Наименование
orders[][contragent] object (OrderContragent) Реквизиты
orders[][contragent][contragentType] string Тип контрагента
orders[][contragent][legalName] string Полное наименование
orders[][contragent][legalAddress] string Адрес регистрации
orders[][contragent][INN] string ИНН
orders[][contragent][OKPO] string ОКПО
orders[][contragent][KPP] string КПП
orders[][contragent][OGRN] string ОГРН
orders[][contragent][OGRNIP] string ОГРНИП
orders[][contragent][certificateNumber] string Номер свидетельства
orders[][contragent][certificateDate] DateTime Дата свидетельства
orders[][contragent][BIK] string БИК
orders[][contragent][bank] string Банк
orders[][contragent][bankAddress] string Адрес банка
orders[][contragent][corrAccount] string Корр. счёт
orders[][contragent][bankAccount] string Расчётный счёт
orders[][delivery] object (SerializedOrderDelivery) Данные о доставке
orders[][delivery][code] string Код типа доставки
orders[][delivery][integrationCode] string Интеграционный код типа доставки
orders[][delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
orders[][delivery][data][externalId] string Идентификатор в службе доставкиdeprecated Номер отправления (Используйте trackNumber)
orders[][delivery][data][trackNumber] string Номер отправления (поле deprecated на запись)Номер отправленияНомер отправленияНомер отправления
orders[][delivery][data][status] string Код статуса доставкиКод статуса доставкиКод статуса доставкиКод статуса доставки
orders[][delivery][data][locked] boolean Не синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
orders[][delivery][data][pickuppointAddress] string Адрес пункта самовывоза
orders[][delivery][data][days] string Ориентировочный срок доставкиОриентировочный срок доставкиОриентировочный срок доставки
orders[][delivery][data][statusText] string Наименование статуса доставкиНаименование статуса доставкиНаименование статуса доставки
orders[][delivery][data][statusDate] DateTime Дата статуса доставкиДата последнего изменения статуса доставки
orders[][delivery][data][tariff] string Код тарифа
orders[][delivery][data][tariffName] string Наименование тарифа
orders[][delivery][data][pickuppointId] string Идентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
orders[][delivery][data][pickuppointSchedule] string Режим работы пункта самовывозаРасписание работы пункта самовывоза
orders[][delivery][data][pickuppointPhone] string Телефон пункта самовывоза
orders[][delivery][data][payerType] string Плательщик за доставкуТип плательщика
orders[][delivery][data][statusComment] string Комментарий к статусу доставки
orders[][delivery][data][cost] float Стоимость доставки, полученная из службы доставки (в валюте объекта)Стоимость доставки, полученная из службы доставки (в валюте объекта)
orders[][delivery][data][minTerm] integer Минимальный срок доставки
orders[][delivery][data][maxTerm] integer Максимальный срок доставки
orders[][delivery][data][shipmentpointId] string Идентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
orders[][delivery][data][shipmentpointName] string Наименование терминала отгрузки
orders[][delivery][data][shipmentpointAddress] string Адрес терминала отгрузки
orders[][delivery][data][shipmentpointSchedule] string Режим работы терминала отгрузки
orders[][delivery][data][shipmentpointPhone] string Телефон терминала отгрузки
orders[][delivery][data][shipmentpointCoordinateLatitude] string Координаты терминала отгрузки, широта
orders[][delivery][data][shipmentpointCoordinateLongitude] string Координаты терминала отгрузки, долгота
orders[][delivery][data][pickuppointName] string Наименование пункта самовывоза
orders[][delivery][data][pickuppointCoordinateLatitude] string Координаты ПВЗ, широта
orders[][delivery][data][pickuppointCoordinateLongitude] string Координаты ПВЗ, долгота
orders[][delivery][data][extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
orders[][delivery][data][id] integer Идентификатор курьера
orders[][delivery][data][firstName] string Имя
orders[][delivery][data][email] string E-mail
orders[][delivery][data][phone] object (CourierPhone) Телефон курьера
orders[][delivery][data][phone][number] string Номер телефона
orders[][delivery][data][courierId] integer Идентификатор курьера
orders[][delivery][data][statusCode] string deprecated Код статуса доставки+
orders[][delivery][data][serviceType] string Технология доставки
orders[][delivery][data][pickuppoint] string Пункт самовывозаНазвание пункта самовывоза
orders[][delivery][data][statusName] string Наименование статуса доставки
orders[][delivery][data][price] float Стоимость доставки, полученная из службы доставки
orders[][delivery][data][receiverCity] string Название города доставкиГород доставки
orders[][delivery][data][receiverCityRef] string Идентификатор города доставки в NewPostИдентификатор города доставки
orders[][delivery][data][receiverStreet] string Название улицы доставки
orders[][delivery][data][receiverStreetRef] string Идентификатор улицы доставки в NewPost
orders[][delivery][data][seatsAmount] integer Количество мест отправления
orders[][delivery][data][cargoDescription] string Описание груза
orders[][delivery][data][paymentForm] string Форма оплаты за доставку
orders[][delivery][data][packageNumber] string Номер упаковки
orders[][delivery][data][deliveryDate] string Дата когда получатель забрал товар
orders[][delivery][data][denieReason] string Причина отказа
orders[][delivery][data][declaredValue] float Объявленная стоимость (в валюте объекта)
orders[][delivery][data][sendDate] DateTime Дата отправки
orders[][delivery][data][deliveryType] string Идентификатор способа доставки
orders[][delivery][data][deliveryName] string Название службы доставки
orders[][delivery][data][pickupType] integer Тип забора
orders[][delivery][data][pickuppointDescription] string Описание пункта самовывоза
orders[][delivery][data][placesCount] integer Количество мест
orders[][delivery][data][services][] array of strings Дополнительные услуги доставки
orders[][delivery][data][comment] string Комментарий к заказу
orders[][delivery][service] object (SerializedDeliveryService)
orders[][delivery][service][name] string Название
orders[][delivery][service][code] string Символьный код
orders[][delivery][service][active] boolean Статус активности
orders[][delivery][cost] double Стоимость доставки
orders[][delivery][netCost] double Себестоимость доставки
orders[][delivery][date] DateTime Дата доставки
orders[][delivery][time] object (TimeInterval) Информация о временном диапазоне
orders[][delivery][time][from] DateTime Время "с"
orders[][delivery][time][to] DateTime Время "до"
orders[][delivery][time][custom] string Временной диапазон в свободной форме
orders[][delivery][address] object (OrderDeliveryAddress) Адрес доставки
orders[][delivery][address][index] string Индекс
orders[][delivery][address][countryIso] string ISO код страны
orders[][delivery][address][region] string Регион
orders[][delivery][address][regionId] integer Идентификатор региона в Geohelper
orders[][delivery][address][city] string Город
orders[][delivery][address][cityId] integer Идентификатор города в Geohelper
orders[][delivery][address][cityType] string Тип населенного пункта
orders[][delivery][address][street] string Улица
orders[][delivery][address][streetId] integer Идентификатор улицы в Geohelper
orders[][delivery][address][streetType] string Тип улицы
orders[][delivery][address][building] string Дом
orders[][delivery][address][flat] string Номер квартиры/офиса
orders[][delivery][address][floor] integer Этаж
orders[][delivery][address][block] integer Подъезд
orders[][delivery][address][house] string Строение
orders[][delivery][address][housing] string Корпус
orders[][delivery][address][metro] string Метро
orders[][delivery][address][notes] string Примечания к адресу
orders[][delivery][address][text] string Адрес в текстовом виде
orders[][delivery][vatRate] string Ставка НДС
orders[][site] string Магазин
orders[][status] string Статус заказа
orders[][statusComment] string Комментарий к последнему изменению статуса
orders[][source] object (SerializedSource) Источник заказа
orders[][source][source] string Источник
orders[][source][medium] string Канал
orders[][source][campaign] string Кампания
orders[][source][keyword] string Ключевое слово
orders[][source][content] string Содержание кампании
orders[][items][] array of objects (OrderProduct) Позиция в заказе
orders[][items][][discount] float deprecated Денежная скидка на единицу товара
orders[][items][][discountPercent] float deprecated Процентная скидка на единицу товара
orders[][items][][markingCodes][] array of strings Коды маркировки
orders[][items][][id] integer ID позиции в заказе
orders[][items][][priceType] object (PriceType) Тип цены
orders[][items][][priceType][code] string Код типа цены
orders[][items][][initialPrice] double Цена товара/SKU (в валюте объекта)
orders[][items][][prices][] array of objects (OrderProductPriceItem) Набор итоговых цен реализации с указанием количества
orders[][items][][prices][][price] float Итоговая цена c учетом всех скидок на товар и заказ (в валюте объекта)
orders[][items][][prices][][quantity] float Количество товара по заданной цене
orders[][items][][vatRate] string Ставка НДС
orders[][items][][createdAt] DateTime Дата создания позиции в системе
orders[][items][][quantity] float Количество
orders[][items][][status] string Статус позиции в заказе
orders[][items][][comment] string Комментарий к позиции в заказе
orders[][items][][offer] object (Offer) Торговое предложение
orders[][items][][offer][displayName] string Название SKU
orders[][items][][offer][id] integer ID торгового предложения
orders[][items][][offer][externalId] string ID торгового предложения в магазине
orders[][items][][offer][xmlId] string ID торгового предложения в складской системе
orders[][items][][offer][name] string Название
orders[][items][][offer][article] string Артикул
orders[][items][][offer][vatRate] string Ставка НДС
orders[][items][][offer][properties][] array Свойства SKU
orders[][items][][isCanceled] boolean Данная позиция в заказе является отменной
orders[][items][][properties][] array [массив] Дополнительные свойства позиции в заказе
orders[][items][][properties][][code] string Код свойства (не обязательное поле, код может передаваться в ключе свойства)
orders[][items][][properties][][name] string Имя свойства
orders[][items][][properties][][value] string Значение свойства
orders[][items][][purchasePrice] double Закупочная цена (в базовой валюте)
orders[][items][][ordering] integer Порядок
orders[][fullPaidAt] DateTime Дата полной оплаты
orders[][fromApi] boolean Заказ поступил через API
orders[][shipmentStore] string Склад отгрузки
orders[][shipmentDate] DateTime Дата отгрузки
orders[][shipped] boolean Заказ отгружен
orders[][customFields] array Ассоциативный массив пользовательских полей
orders[][clientId] string Метка клиента Google Analytics

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/orders/create Создание заказа

Создание заказа

Для доступа к методу необходимо разрешение order_write.

Метод создает заказ и возвращает внутренний ID созданного заказа.

Если не указывать order[createdAt], то будет использовано текущее время в качестве даты/времени оформления заказа.

Если требуется привязать заказ к существующему клиенту, то необходимо передать внешний ID клиента в поле order[customer][externalId], внутренний ID клиента в поле order[customer][id] либо идентификатор клиента в Daemon Collector в поле order[customer][browserId]. Поиск клиента будет осуществляться в рамках магазинов, к которым есть доступ у используемого API-ключа. Если не указывать order[customer], то клиент будет автоматически создан на основе данных из заказа.

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

В полях order[orderType], order[orderMethod], order[paymentType], order[paymentStatus], order[status], order[shipmentStore], order[delivery][code], order[items][][status] указывается символьный код элемента.

В полях order[managerId], order[sourceId] указывается внутренний ID сущности в системе.

Нельзя изменять комментарий order[statusComment] без изменения статуса заказа order[status].

Товары заказа указываются в поле order[items][]. Не переданные в запросе на редактирование товары удаляются из заказа. Если товар присутствует в каталоге, то необходимо установить значение одного из следующих полей:

Если установлено значение нескольких полей, они будут обрабатываться в указанном выше порядке.

В случае, если ни один из идентификаторов товара не передан либо товар не найден, то товар будет автоматически создан на основе данных полей order[items][][initialPrice], order[items][][purchasePrice], order[items][][productName], при этом данная позиция товара в заказе не привязывается к товару в каталоге.

Адрес доставки order[delivery][address] можно указывать либо в строковом виде в поле order[delivery][address][text], либо в подробном виде, заполняя все поля кроме order[delivery][address][text].

В поле order[customFields] можно передавать массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Для работы с типами цен необходимо, чтобы в справочнике было активно более одного типа цен. Для передачи типа цены для товарной позиции в заказе необходимо передать код нужного типа цен в поле order[items][][priceType][code]. Рекомендуется вместе с типом цены передавать актуальное значение цены товара через order[items][][initialPrice]. Если передать тип цены order[items][][priceType][code] без значения цены order[items][][initialPrice], то в качестве цены товарной позиции возьмется текущее значения данного типа цен для данного товара. Для новой товарной позиции рекомендуется всегда передавать цену order[items][][initialPrice] явно, на случай если актуальная цена еще не была загружена в систему. Если для товара не передать тип цены order[items][][priceType][code], то в карточке заказа для товарной позиции в типе цены будет указанно Без типа. В случае, если в системе используется только базовый тип цен, то параметр order[items][][priceType][code] следует опустить.

Порядок позиций заказа order[items][] сохраняется в ответе.

Параметры

ПараметрТипФорматОписание
sitestring Символьный код магазина
orderobject (SerializedOrder)
order[paymentType]stringdeprecated Тип оплаты
order[paymentStatus]stringdeprecated Статус оплаты
order[paymentDetail]stringdeprecated Детали платежа
order[number]string Номер заказа
order[externalId]string Внешний ID заказа
order[countryIso]string ISO код страны
order[createdAt]DateTimeY-m-d H:i:s Дата оформления заказа
order[statusUpdatedAt]DateTimeY-m-d H:i:s Дата последнего изменения статуса
order[mark]integer Оценка заказа
order[markDatetime]DateTimeY-m-d H:i:s Дата и время получение оценки от покупателя
order[lastName]string Фамилия
order[firstName]string Имя
order[patronymic]string Отчество
order[phone]string Телефон
order[additionalPhone]string Дополнительный телефон
order[email]string E-mail
order[call]boolean Требуется позвонить
order[expired]boolean Просрочен
order[customerComment]string Комментарий клиента
order[managerComment]string Комментарий оператора
order[contragent]object (OrderContragent) Реквизиты
order[contragent][contragentType]string Тип контрагента
order[contragent][legalName]string Полное наименование
order[contragent][legalAddress]string Адрес регистрации
order[contragent][INN]string ИНН
order[contragent][OKPO]string ОКПО
order[contragent][KPP]string КПП
order[contragent][OGRN]string ОГРН
order[contragent][OGRNIP]string ОГРНИП
order[contragent][certificateNumber]string Номер свидетельства
order[contragent][certificateDate]DateTimeY-m-d Дата свидетельства
order[contragent][BIK]string БИК
order[contragent][bank]string Банк
order[contragent][bankAddress]string Адрес банка
order[contragent][corrAccount]string Корр. счёт
order[contragent][bankAccount]string Расчётный счёт
order[statusComment]string Комментарий к последнему изменению статуса
order[shipmentDate]DateTimeY-m-d Дата отгрузки
order[shipped]boolean Заказ отгружен
order[customFields]array Ассоциативный массив пользовательских полей
order[orderType]string Тип заказа
order[orderMethod]string Способ оформления
order[customer]object (SerializedRelationCustomer) Клиент
order[customer][id]integer Внутренний ID клиента
order[customer][externalId]string Внешний ID клиента
order[customer][browserId]string Идентификатор устройства в Collector
order[customer][site]string Код магазина, необходим при передаче externalId
order[managerId]integer Менеджер, прикрепленный к заказу
order[status]string Статус заказа
order[items][]array of objects (SerializedOrderProduct)
order[items][][markingCodes][]array of strings Коды маркировки
order[items][][initialPrice]double Цена товара/SKU (в валюте объекта)
order[items][][vatRate]string Ставка НДС
order[items][][createdAt]DateTimeY-m-d H:i:s Дата создания позиции в системе
order[items][][quantity]float Количество
order[items][][comment]string Комментарий к позиции в заказе
order[items][][properties][]array [массив] Дополнительные свойства позиции в заказе
order[items][][properties][][code]string{not blank}{match: /^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D}} Код свойства (не обязательное поле, код может передаваться в ключе свойства)
order[items][][properties][][name]string{not blank} Имя свойства
order[items][][properties][][value]string{not blank} Значение свойства
order[items][][purchasePrice]double Закупочная цена (в базовой валюте)
order[items][][ordering]integer Порядок
order[items][][offer]object (SerializedOrderProductOffer) Торговое предложение
order[items][][offer][id]integer ID торгового предложения
order[items][][offer][externalId]string Внешний ID торгового предложения
order[items][][offer][xmlId]string ID торгового предложения в складской системе
order[items][][productName]string Название товара
order[items][][status]string Статус позиции в заказе
order[items][][discount]stringdeprecated Денежная скидка на единицу товара
order[items][][discountPercent]stringdeprecated Процентная скидка на единицу товара
order[items][][priceType]object (PriceType) Тип цены
order[items][][priceType][code]string Код типа цены
order[delivery]object (SerializedOrderDelivery) Данные о доставке
order[delivery][code]string Код типа доставки
order[delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
order[delivery][data][externalId]string Идентификатор в службе доставки
order[delivery][data][trackNumber]stringНомер отправления (поле deprecated на запись)Номер отправленияНомер отправления
order[delivery][data][locked]booleanНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
order[delivery][data][tariff]string Код тарифа
order[delivery][data][pickuppointId]stringИдентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
order[delivery][data][payerType]stringПлательщик за доставкуТип плательщика
order[delivery][data][shipmentpointId]stringИдентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
order[delivery][data][extraData]array Дополнительные данные доставки (deliveryDataField.code => значение)
order[delivery][data][courierId]integer Идентификатор курьера
order[delivery][data][serviceType]string Технология доставки
order[delivery][data][pickuppoint]string Пункт самовывоза
order[delivery][data][receiverCity]stringНазвание города доставкиГород доставки
order[delivery][data][receiverCityRef]stringИдентификатор города доставки в NewPostИдентификатор города доставки
order[delivery][data][receiverStreet]string Название улицы доставки
order[delivery][data][receiverStreetRef]string Идентификатор улицы доставки в NewPost
order[delivery][data][seatsAmount]integer Количество мест отправления
order[delivery][data][cargoDescription]string Описание груза
order[delivery][data][paymentForm]string Форма оплаты за доставку
order[delivery][data][packageNumber]string Номер упаковки
order[delivery][data][declaredValue]float Объявленная стоимость (в валюте объекта)
order[delivery][data][sendDate]DateTimeY-m-d Дата отправки
order[delivery][data][deliveryType]string Идентификатор способа доставки
order[delivery][data][pickupType]integer Тип забора
order[delivery][data][placesCount]integer Количество мест
order[delivery][data][services][]array of strings Дополнительные услуги доставки
order[delivery][data][comment]string Комментарий к заказу
order[delivery][service]object (SerializedDeliveryService)
order[delivery][service][name]string Название
order[delivery][service][code]string Символьный код
order[delivery][service][active]boolean Статус активности
order[delivery][service][deliveryType]string Тип доставки
order[delivery][cost]double Стоимость доставки
order[delivery][netCost]double Себестоимость доставки
order[delivery][date]DateTimeY-m-d Дата доставки
order[delivery][time]object (TimeInterval) Информация о временном диапазоне
order[delivery][time][from]DateTimeH:i Время "с"
order[delivery][time][to]DateTimeH:i Время "до"
order[delivery][time][custom]string Временной диапазон в свободной форме
order[delivery][address]object (OrderDeliveryAddress) Адрес доставки
order[delivery][address][index]string Индекс
order[delivery][address][countryIso]string ISO код страны
order[delivery][address][region]string Регион
order[delivery][address][regionId]integer Идентификатор региона в Geohelper
order[delivery][address][city]string Город
order[delivery][address][cityId]integer Идентификатор города в Geohelper
order[delivery][address][cityType]string Тип населенного пункта
order[delivery][address][street]string Улица
order[delivery][address][streetId]integer Идентификатор улицы в Geohelper
order[delivery][address][streetType]string Тип улицы
order[delivery][address][building]string Дом
order[delivery][address][flat]string Номер квартиры/офиса
order[delivery][address][floor]integer Этаж
order[delivery][address][block]integer Подъезд
order[delivery][address][house]string Строение
order[delivery][address][housing]string Корпус
order[delivery][address][metro]string Метро
order[delivery][address][notes]string Примечания к адресу
order[delivery][address][text]string Адрес в текстовом виде
order[delivery][vatRate]string Ставка НДС
order[source]object (SerializedSource) Источник заказа
order[source][source]string Источник
order[source][medium]string Канал
order[source][campaign]string Кампания
order[source][keyword]string Ключевое слово
order[source][content]string Содержание кампании
order[shipmentStore]string Склад отгрузки
order[discount]string Денежная скидка на весь заказ
order[discountPercent]string Процентная скидка на весь заказ

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
id integer Внутренний ID созданного заказа
order object (CreateOrder)
order[paymentType] string deprecated Тип оплаты
order[paymentStatus] string deprecated Статус оплаты
order[slug] custom handler result for (int) deprecated Символьный код
order[discount] float Денежная скидка на весь заказ
order[discountPercent] float Процентная скидка на весь заказ
order[paymentDetail] string deprecated Детали платежа
order[currency] string Валюта
order[id] integer ID заказа
order[number] string Номер заказа
order[externalId] string Внешний ID заказа
order[orderType] string Тип заказа
order[orderMethod] string Способ оформления
order[countryIso] string ISO код страны
order[createdAt] DateTime Дата оформления заказа
order[statusUpdatedAt] DateTime Дата последнего изменения статуса
order[totalSumm] double Общая сумма с учетом скидки (в валюте объекта)
order[prepaySum] double Оплаченная сумма (в валюте объекта)
order[purchaseSumm] double Общая стоимость закупки (в базовой валюте)
order[mark] integer Оценка заказа
order[markDatetime] DateTime Дата и время получение оценки от покупателя
order[lastName] string Фамилия
order[firstName] string Имя
order[patronymic] string Отчество
order[phone] string Телефон
order[additionalPhone] string Дополнительный телефон
order[email] string E-mail
order[call] boolean Требуется позвонить
order[expired] boolean Просрочен
order[customerComment] string Комментарий клиента
order[managerComment] string Комментарий оператора
order[managerId] integer Менеджер, прикрепленный к заказу
order[customer]КлиентКорпоративный клиент
order[customer][id] integer ID клиентаID корпоративного клиента
order[customer][externalId] string Внешний ID клиентаВнешний ID корпоративного клиента
order[customer][isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
order[customer][createdAt] DateTime СозданСоздан
order[customer][managerId] integer Менеджер клиентаМенеджер корпоративного клиента
order[customer][vip] boolean Важный клиентВажный клиент
order[customer][bad] boolean Плохой клиентПлохой клиент
order[customer][site] string Магазин, с которого пришел клиентМагазин, с которого пришел клиент
order[customer][contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
order[customer][contragent][contragentType] string Тип контрагента
order[customer][contragent][legalName] string Полное наименование
order[customer][contragent][legalAddress] string Адрес регистрации
order[customer][contragent][INN] string ИНН
order[customer][contragent][OKPO] string ОКПО
order[customer][contragent][KPP] string КПП
order[customer][contragent][OGRN] string ОГРН
order[customer][contragent][OGRNIP] string ОГРНИП
order[customer][contragent][certificateNumber] string Номер свидетельства
order[customer][contragent][certificateDate] DateTime Дата свидетельства
order[customer][contragent][BIK] string БИК
order[customer][contragent][bank] string Банк
order[customer][contragent][bankAddress] string Адрес банка
order[customer][contragent][corrAccount] string Корр. счёт
order[customer][contragent][bankAccount] string Расчётный счёт
order[customer][firstClientId] string Первая метка клиента Google AnalyticsПервая метка клиента Google Analytics
order[customer][lastClientId] string Последняя метка клиента Google AnalyticsПоследняя метка клиента Google Analytics
order[customer][customFields] array Ассоциативный массив пользовательских полейАссоциативный массив пользовательских полей
order[customer][personalDiscount] double Персональная скидкаПерсональная скидка
order[customer][cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
order[customer][discountCardNumber] string Номер дисконтной картыНомер дисконтной карты
order[customer][avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте)
order[customer][marginSumm] float LTV (в базовой валюте)LTV (в базовой валюте)
order[customer][totalSumm] float Общая сумма заказов (в базовой валюте)Общая сумма заказов (в базовой валюте)
order[customer][averageSumm] float Средняя сумма заказа (в базовой валюте)Средняя сумма заказа (в базовой валюте)
order[customer][ordersCount] integer Количество заказовКоличество заказов
order[customer][address] object (CustomerAddress) Адрес клиента
order[customer][address][id] integer ID адреса
order[customer][address][index] string Индекс
order[customer][address][countryIso] string ISO код страны
order[customer][address][region] string Регион
order[customer][address][regionId] integer Идентификатор региона в Geohelper
order[customer][address][city] string Город
order[customer][address][cityId] integer Идентификатор города в Geohelper
order[customer][address][cityType] string Тип населенного пункта
order[customer][address][street] string Улица
order[customer][address][streetId] integer Идентификатор улицы в Geohelper
order[customer][address][streetType] string Тип улицы
order[customer][address][building] string Дом
order[customer][address][flat] string Номер квартиры/офиса
order[customer][address][floor] integer Этаж
order[customer][address][block] integer Подъезд
order[customer][address][house] string Строение
order[customer][address][housing] string Корпус
order[customer][address][metro] string Метро
order[customer][address][notes] string Примечания к адресу
order[customer][address][text] string Адрес в текстовом виде
order[customer][maturationTime] integer Время «созревания», в секундах
order[customer][firstName] string Имя
order[customer][lastName] string Фамилия
order[customer][patronymic] string Отчество
order[customer][email] string E-mail
order[customer][emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
order[customer][customerSubscriptions][] array of objects (CustomerSubscription) Подписки
order[customer][customerSubscriptions][][subscription] object (Subscription) Категория подписки
order[customer][customerSubscriptions][][subscription][id] integer ID категории подписки
order[customer][customerSubscriptions][][subscription][channel] string Канал
order[customer][customerSubscriptions][][subscription][name] string Название
order[customer][customerSubscriptions][][subscription][code] string Символьный код
order[customer][customerSubscriptions][][subscription][active] boolean Статус активности
order[customer][customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
order[customer][customerSubscriptions][][subscription][ordering] integer
order[customer][customerSubscriptions][][subscribed] boolean Активность подписки
order[customer][customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
order[customer][phones][] array of objects (CustomerPhone) Телефоны
order[customer][phones][][number] string Номер телефона
order[customer][birthday] DateTime День рождения
order[customer][source] object (SerializedSource) Источник клиента
order[customer][source][source] string Источник
order[customer][source][medium] string Канал
order[customer][source][campaign] string Кампания
order[customer][source][keyword] string Ключевое слово
order[customer][source][content] string Содержание кампании
order[customer][mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
order[customer][mgCustomers][][id] integer ID клиента
order[customer][mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
order[customer][mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
order[customer][mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
order[customer][commentary] string deprecated Комментарий
order[customer][photoUrl] string URL фотографии
order[customer][nickName] string Наименование
order[contragent] object (OrderContragent) Реквизиты
order[contragent][contragentType] string Тип контрагента
order[contragent][legalName] string Полное наименование
order[contragent][legalAddress] string Адрес регистрации
order[contragent][INN] string ИНН
order[contragent][OKPO] string ОКПО
order[contragent][KPP] string КПП
order[contragent][OGRN] string ОГРН
order[contragent][OGRNIP] string ОГРНИП
order[contragent][certificateNumber] string Номер свидетельства
order[contragent][certificateDate] DateTime Дата свидетельства
order[contragent][BIK] string БИК
order[contragent][bank] string Банк
order[contragent][bankAddress] string Адрес банка
order[contragent][corrAccount] string Корр. счёт
order[contragent][bankAccount] string Расчётный счёт
order[delivery] object (SerializedOrderDelivery) Данные о доставке
order[delivery][code] string Код типа доставки
order[delivery][integrationCode] string Интеграционный код типа доставки
order[delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
order[delivery][data][externalId] string Идентификатор в службе доставкиdeprecated Номер отправления (Используйте trackNumber)
order[delivery][data][trackNumber] string Номер отправления (поле deprecated на запись)Номер отправленияНомер отправленияНомер отправления
order[delivery][data][status] string Код статуса доставкиКод статуса доставкиКод статуса доставкиКод статуса доставки
order[delivery][data][locked] boolean Не синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
order[delivery][data][pickuppointAddress] string Адрес пункта самовывоза
order[delivery][data][days] string Ориентировочный срок доставкиОриентировочный срок доставкиОриентировочный срок доставки
order[delivery][data][statusText] string Наименование статуса доставкиНаименование статуса доставкиНаименование статуса доставки
order[delivery][data][statusDate] DateTime Дата статуса доставкиДата последнего изменения статуса доставки
order[delivery][data][tariff] string Код тарифа
order[delivery][data][tariffName] string Наименование тарифа
order[delivery][data][pickuppointId] string Идентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
order[delivery][data][pickuppointSchedule] string Режим работы пункта самовывозаРасписание работы пункта самовывоза
order[delivery][data][pickuppointPhone] string Телефон пункта самовывоза
order[delivery][data][payerType] string Плательщик за доставкуТип плательщика
order[delivery][data][statusComment] string Комментарий к статусу доставки
order[delivery][data][cost] float Стоимость доставки, полученная из службы доставки (в валюте объекта)Стоимость доставки, полученная из службы доставки (в валюте объекта)
order[delivery][data][minTerm] integer Минимальный срок доставки
order[delivery][data][maxTerm] integer Максимальный срок доставки
order[delivery][data][shipmentpointId] string Идентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
order[delivery][data][shipmentpointName] string Наименование терминала отгрузки
order[delivery][data][shipmentpointAddress] string Адрес терминала отгрузки
order[delivery][data][shipmentpointSchedule] string Режим работы терминала отгрузки
order[delivery][data][shipmentpointPhone] string Телефон терминала отгрузки
order[delivery][data][shipmentpointCoordinateLatitude] string Координаты терминала отгрузки, широта
order[delivery][data][shipmentpointCoordinateLongitude] string Координаты терминала отгрузки, долгота
order[delivery][data][pickuppointName] string Наименование пункта самовывоза
order[delivery][data][pickuppointCoordinateLatitude] string Координаты ПВЗ, широта
order[delivery][data][pickuppointCoordinateLongitude] string Координаты ПВЗ, долгота
order[delivery][data][extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
order[delivery][data][id] integer Идентификатор курьера
order[delivery][data][firstName] string Имя
order[delivery][data][email] string E-mail
order[delivery][data][phone] object (CourierPhone) Телефон курьера
order[delivery][data][phone][number] string Номер телефона
order[delivery][data][courierId] integer Идентификатор курьера
order[delivery][data][statusCode] string deprecated Код статуса доставки+
order[delivery][data][serviceType] string Технология доставки
order[delivery][data][pickuppoint] string Пункт самовывозаНазвание пункта самовывоза
order[delivery][data][statusName] string Наименование статуса доставки
order[delivery][data][price] float Стоимость доставки, полученная из службы доставки
order[delivery][data][receiverCity] string Название города доставкиГород доставки
order[delivery][data][receiverCityRef] string Идентификатор города доставки в NewPostИдентификатор города доставки
order[delivery][data][receiverStreet] string Название улицы доставки
order[delivery][data][receiverStreetRef] string Идентификатор улицы доставки в NewPost
order[delivery][data][seatsAmount] integer Количество мест отправления
order[delivery][data][cargoDescription] string Описание груза
order[delivery][data][paymentForm] string Форма оплаты за доставку
order[delivery][data][packageNumber] string Номер упаковки
order[delivery][data][deliveryDate] string Дата когда получатель забрал товар
order[delivery][data][denieReason] string Причина отказа
order[delivery][data][declaredValue] float Объявленная стоимость (в валюте объекта)
order[delivery][data][sendDate] DateTime Дата отправки
order[delivery][data][deliveryType] string Идентификатор способа доставки
order[delivery][data][deliveryName] string Название службы доставки
order[delivery][data][pickupType] integer Тип забора
order[delivery][data][pickuppointDescription] string Описание пункта самовывоза
order[delivery][data][placesCount] integer Количество мест
order[delivery][data][services][] array of strings Дополнительные услуги доставки
order[delivery][data][comment] string Комментарий к заказу
order[delivery][service] object (SerializedDeliveryService)
order[delivery][service][name] string Название
order[delivery][service][code] string Символьный код
order[delivery][service][active] boolean Статус активности
order[delivery][cost] double Стоимость доставки
order[delivery][netCost] double Себестоимость доставки
order[delivery][date] DateTime Дата доставки
order[delivery][time] object (TimeInterval) Информация о временном диапазоне
order[delivery][time][from] DateTime Время "с"
order[delivery][time][to] DateTime Время "до"
order[delivery][time][custom] string Временной диапазон в свободной форме
order[delivery][address] object (OrderDeliveryAddress) Адрес доставки
order[delivery][address][index] string Индекс
order[delivery][address][countryIso] string ISO код страны
order[delivery][address][region] string Регион
order[delivery][address][regionId] integer Идентификатор региона в Geohelper
order[delivery][address][city] string Город
order[delivery][address][cityId] integer Идентификатор города в Geohelper
order[delivery][address][cityType] string Тип населенного пункта
order[delivery][address][street] string Улица
order[delivery][address][streetId] integer Идентификатор улицы в Geohelper
order[delivery][address][streetType] string Тип улицы
order[delivery][address][building] string Дом
order[delivery][address][flat] string Номер квартиры/офиса
order[delivery][address][floor] integer Этаж
order[delivery][address][block] integer Подъезд
order[delivery][address][house] string Строение
order[delivery][address][housing] string Корпус
order[delivery][address][metro] string Метро
order[delivery][address][notes] string Примечания к адресу
order[delivery][address][text] string Адрес в текстовом виде
order[delivery][vatRate] string Ставка НДС
order[site] string Магазин
order[status] string Статус заказа
order[statusComment] string Комментарий к последнему изменению статуса
order[source] object (SerializedSource) Источник заказа
order[source][source] string Источник
order[source][medium] string Канал
order[source][campaign] string Кампания
order[source][keyword] string Ключевое слово
order[source][content] string Содержание кампании
order[items][] array of objects (OrderProduct) Позиция в заказе
order[items][][discount] float deprecated Денежная скидка на единицу товара
order[items][][discountPercent] float deprecated Процентная скидка на единицу товара
order[items][][markingCodes][] array of strings Коды маркировки
order[items][][id] integer ID позиции в заказе
order[items][][priceType] object (PriceType) Тип цены
order[items][][priceType][code] string Код типа цены
order[items][][initialPrice] double Цена товара/SKU (в валюте объекта)
order[items][][prices][] array of objects (OrderProductPriceItem) Набор итоговых цен реализации с указанием количества
order[items][][prices][][price] float Итоговая цена c учетом всех скидок на товар и заказ (в валюте объекта)
order[items][][prices][][quantity] float Количество товара по заданной цене
order[items][][vatRate] string Ставка НДС
order[items][][createdAt] DateTime Дата создания позиции в системе
order[items][][quantity] float Количество
order[items][][status] string Статус позиции в заказе
order[items][][comment] string Комментарий к позиции в заказе
order[items][][offer] object (Offer) Торговое предложение
order[items][][offer][displayName] string Название SKU
order[items][][offer][id] integer ID торгового предложения
order[items][][offer][externalId] string ID торгового предложения в магазине
order[items][][offer][xmlId] string ID торгового предложения в складской системе
order[items][][offer][name] string Название
order[items][][offer][article] string Артикул
order[items][][offer][vatRate] string Ставка НДС
order[items][][offer][properties] array Свойства SKU
order[items][][isCanceled] boolean Данная позиция в заказе является отменной
order[items][][properties] array [массив] Дополнительные свойства позиции в заказе
order[items][][purchasePrice] double Закупочная цена (в базовой валюте)
order[items][][ordering] integer Порядок
order[fullPaidAt] DateTime Дата полной оплаты
order[fromApi] boolean Заказ поступил через API
order[shipmentStore] string Склад отгрузки
order[shipmentDate] DateTime Дата отгрузки
order[shipped] boolean Заказ отгружен
order[customFields] array Ассоциативный массив пользовательских полей
order[clientId] string Метка клиента Google Analytics

Статусы ответа

Код статуса ответаОписание
201
  • Заказ создан
400
  • Ошибка при создании заказа

POST /api/v4/orders/fix-external-ids Массовая запись внешних ID заказов

Массовая запись внешних ID заказов

Для доступа к методу необходимо разрешение order_write.

Данный метод полезен в случае обратной синхронизации заказов, которые исходно оформлены в системе.

Рекомендуется реализовывать следующей сценарий обратной синхронизации заказов между интернет-магазином и системой. Интернет-магазин периодически опрашивает метод /api/v*/orders/history. На основе получаемых данных магазин применяет изменения к существующим заказам, а также создает новые заказы, исходно оформленные в системе. При создании заказов в магазине формируются собственные ID заказов (externalId заказов в нотации системы). Сразу после создания заказов интернет-магазин вызывает метод /api/v*/orders/fix-external-ids, сохраняя в системе собственные ID заказов.

Параметры

ПараметрТипФорматОписание
orders[]array of objects (FixExternalRow) Идентификаторы загруженных объектов
orders[][id]digit{not blank}{range: {>=1, <=2147483647}}} Внутренний ID
orders[][externalId]string{not blank} Внешний ID

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/orders/history Получение истории изменений заказов

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

Для доступа к методу необходимо разрешение order_read.

Возвращает изменения в заказах, произведенные в указанный диапазон дат (используя фильтры filter[startDate] и filter[endDate]), либо инкрементальные изменения (используя filter[sinceId]).

При реализации постоянной трансляции изменений во внешнюю систему ​рекомендуется​ использовать подход с забором инкрементальных изменений через filter[sinceId] передавая id последней полученной записи истории.

Для записей создания и удаления заказа и товара в заказе возвращается полный набор полей в соответствующих ключах order или item.

Добавление товара в заказ отражается записью истории с fieldName равным order_product, при этом полная информация о товаре в заказе доступна в контексте item, а в newValue указываются только поля-идентификаторы.

Результат возвращается постранично. В поле pagination содержится информация о постраничной разбивке. Для постраничного перебора записей истории ​необходимо​ использовать filter[sinceId]. Параметр page использовать не рекомендуется.

Более подробно о работе с историей вы можете ознакомиться в отдельной статье документации, а значения fieldName указаны в Справочнике объектов.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (OrderHistoryFilterV4Type)
filter[orderId]integer{range: {>=0, <=4294967295}}{not blank}} ID заказа
filter[sinceId]integer{range: {>=0, <=4294967295}}{not blank}} Начиная с ID истории заказов
filter[orderExternalId]string{length: {max: 255}} Внешний ID заказа
filter[startDate]DateTimeY-m-d H:i:s Дата/время изменения (от)
filter[endDate]DateTimeY-m-d H:i:s Дата/время изменения (до)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
generatedAt DateTime Время формирования ответа
history[] array of objects (OrderHistory)
history[][id] integer Внутренний идентификатор записи в истории
history[][createdAt] DateTime Дата внесения изменения
history[][created] boolean Признак создания сущности
history[][deleted] boolean Признак удаления сущности
history[][source] string Источник изменения
history[][user] object (User) Пользователь
history[][user][id] integer ID пользователя
history[][field] string Имя изменившегося поля
history[][oldValue] custom handler result for (mixed) Старое значение свойства
history[][newValue] custom handler result for (mixed) Новое значение свойства
history[][apiKey] object (ApiKey) Информация о ключе api, использовавшемся для этого изменения
history[][apiKey][current] boolean Изменение было сделано с помощью ключа, используемого в данный момент
history[][order] object (Order) Заказ
history[][order][id] integer ID заказа
history[][order][externalId] string Внешний ID заказа
history[][order][managerId] integer Менеджер, прикрепленный к заказу
history[][order][site] string Магазин
history[][order][status] string Статус заказа
history[][ancestor] object (Order) Информация о заказе из которого был создан текущий заказ
history[][item] object (OrderProduct) Позиция в заказе
history[][item][id] integer ID позиции в заказе
history[][item][offer] object (Offer) Торговое предложение
history[][item][offer][id] integer ID торгового предложения
history[][item][offer][externalId] string ID торгового предложения в магазине
history[][item][offer][xmlId] string ID торгового предложения в складской системе
history[][item][offer][properties][] array of strings Свойства SKU
history[][item][ordering] integer Порядок
history[][item][properties][] array of strings [массив] Дополнительные свойства позиции в заказе
history[][item][properties][][code] string Код свойства (не обязательное поле, код может передаваться в ключе свойства)
history[][item][properties][][name] string Имя свойства
history[][item][properties][][value] string Значение свойства
history[][combinedTo] object (Order) Информация о заказе который получился после объединения с текущим заказом
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/orders/statuses Получение списка статусов заказов

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

Для доступа к методу необходимо разрешение order_read.

Возвращает статусы (и группы статусов) для заказов, id или externalId которых указаны в параметрах запроса ids[] и externalIds[].

Можно указывать суммарно до 500 идентификаторов. Если указаны и ids[], и externalIds[], то производится поиск заказов по всем указанным идентификаторам.

Параметры

ПараметрТипФорматОписание
ids[]array ID (внутренние идентификаторы) заказов
externalIds[]array externalId (внешние идентификаторы) заказов

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
orders[] array of objects (OrderStatusItem) Статусы заказов
orders[][id] integer ID заказа
orders[][externalId] string Внешний ID заказа
orders[][status] string Статус заказа
orders[][group] string Группа статуса заказа
orders[][number] string Номер заказа

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/orders/upload Пакетная загрузка заказов

Пакетная загрузка заказов

Для доступа к методу необходимо разрешение order_write.

Метод позволяет загружать пакетно до 50 заказов.

Подробную информацию по формату данных см. в описании метода /api/v*/orders/create.

Параметры

ПараметрТипФорматОписание
sitestring Символьный код магазина, к которому относятся загружаемые заказы
orders[]array of objects (SerializedOrder)
orders[][paymentType]stringdeprecated Тип оплаты
orders[][paymentStatus]stringdeprecated Статус оплаты
orders[][paymentDetail]stringdeprecated Детали платежа
orders[][number]string Номер заказа
orders[][externalId]string Внешний ID заказа
orders[][countryIso]string ISO код страны
orders[][createdAt]DateTimeY-m-d H:i:s Дата оформления заказа
orders[][statusUpdatedAt]DateTimeY-m-d H:i:s Дата последнего изменения статуса
orders[][mark]integer Оценка заказа
orders[][markDatetime]DateTimeY-m-d H:i:s Дата и время получение оценки от покупателя
orders[][lastName]string Фамилия
orders[][firstName]string Имя
orders[][patronymic]string Отчество
orders[][phone]string Телефон
orders[][additionalPhone]string Дополнительный телефон
orders[][email]string E-mail
orders[][call]boolean Требуется позвонить
orders[][expired]boolean Просрочен
orders[][customerComment]string Комментарий клиента
orders[][managerComment]string Комментарий оператора
orders[][contragent]object (OrderContragent) Реквизиты
orders[][contragent][contragentType]string Тип контрагента
orders[][contragent][legalName]string Полное наименование
orders[][contragent][legalAddress]string Адрес регистрации
orders[][contragent][INN]string ИНН
orders[][contragent][OKPO]string ОКПО
orders[][contragent][KPP]string КПП
orders[][contragent][OGRN]string ОГРН
orders[][contragent][OGRNIP]string ОГРНИП
orders[][contragent][certificateNumber]string Номер свидетельства
orders[][contragent][certificateDate]DateTimeY-m-d Дата свидетельства
orders[][contragent][BIK]string БИК
orders[][contragent][bank]string Банк
orders[][contragent][bankAddress]string Адрес банка
orders[][contragent][corrAccount]string Корр. счёт
orders[][contragent][bankAccount]string Расчётный счёт
orders[][statusComment]string Комментарий к последнему изменению статуса
orders[][shipmentDate]DateTimeY-m-d Дата отгрузки
orders[][shipped]boolean Заказ отгружен
orders[][customFields]array Ассоциативный массив пользовательских полей
orders[][orderType]string Тип заказа
orders[][orderMethod]string Способ оформления
orders[][customer]object (SerializedRelationCustomer) Клиент
orders[][customer][id]integer Внутренний ID клиента
orders[][customer][externalId]string Внешний ID клиента
orders[][customer][browserId]string Идентификатор устройства в Collector
orders[][customer][site]string Код магазина, необходим при передаче externalId
orders[][managerId]integer Менеджер, прикрепленный к заказу
orders[][status]string Статус заказа
orders[][items][]array of objects (SerializedOrderProduct)
orders[][items][][markingCodes][]array of strings Коды маркировки
orders[][items][][initialPrice]double Цена товара/SKU (в валюте объекта)
orders[][items][][vatRate]string Ставка НДС
orders[][items][][createdAt]DateTimeY-m-d H:i:s Дата создания позиции в системе
orders[][items][][quantity]float Количество
orders[][items][][comment]string Комментарий к позиции в заказе
orders[][items][][properties][]array [массив] Дополнительные свойства позиции в заказе
orders[][items][][properties][][code]string{not blank}{match: /^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D}} Код свойства (не обязательное поле, код может передаваться в ключе свойства)
orders[][items][][properties][][name]string{not blank} Имя свойства
orders[][items][][properties][][value]string{not blank} Значение свойства
orders[][items][][purchasePrice]double Закупочная цена (в базовой валюте)
orders[][items][][ordering]integer Порядок
orders[][items][][offer]object (SerializedOrderProductOffer) Торговое предложение
orders[][items][][offer][id]integer ID торгового предложения
orders[][items][][offer][externalId]string Внешний ID торгового предложения
orders[][items][][offer][xmlId]string ID торгового предложения в складской системе
orders[][items][][productName]string Название товара
orders[][items][][status]string Статус позиции в заказе
orders[][items][][discount]stringdeprecated Денежная скидка на единицу товара
orders[][items][][discountPercent]stringdeprecated Процентная скидка на единицу товара
orders[][items][][priceType]object (PriceType) Тип цены
orders[][items][][priceType][code]string Код типа цены
orders[][delivery]object (SerializedOrderDelivery) Данные о доставке
orders[][delivery][code]string Код типа доставки
orders[][delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
orders[][delivery][data][externalId]string Идентификатор в службе доставки
orders[][delivery][data][trackNumber]stringНомер отправления (поле deprecated на запись)Номер отправленияНомер отправления
orders[][delivery][data][locked]booleanНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
orders[][delivery][data][tariff]string Код тарифа
orders[][delivery][data][pickuppointId]stringИдентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
orders[][delivery][data][payerType]stringПлательщик за доставкуТип плательщика
orders[][delivery][data][shipmentpointId]stringИдентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
orders[][delivery][data][extraData]array Дополнительные данные доставки (deliveryDataField.code => значение)
orders[][delivery][data][courierId]integer Идентификатор курьера
orders[][delivery][data][serviceType]string Технология доставки
orders[][delivery][data][pickuppoint]string Пункт самовывоза
orders[][delivery][data][receiverCity]stringНазвание города доставкиГород доставки
orders[][delivery][data][receiverCityRef]stringИдентификатор города доставки в NewPostИдентификатор города доставки
orders[][delivery][data][receiverStreet]string Название улицы доставки
orders[][delivery][data][receiverStreetRef]string Идентификатор улицы доставки в NewPost
orders[][delivery][data][seatsAmount]integer Количество мест отправления
orders[][delivery][data][cargoDescription]string Описание груза
orders[][delivery][data][paymentForm]string Форма оплаты за доставку
orders[][delivery][data][packageNumber]string Номер упаковки
orders[][delivery][data][declaredValue]float Объявленная стоимость (в валюте объекта)
orders[][delivery][data][sendDate]DateTimeY-m-d Дата отправки
orders[][delivery][data][deliveryType]string Идентификатор способа доставки
orders[][delivery][data][pickupType]integer Тип забора
orders[][delivery][data][placesCount]integer Количество мест
orders[][delivery][data][services][]array of strings Дополнительные услуги доставки
orders[][delivery][data][comment]string Комментарий к заказу
orders[][delivery][service]object (SerializedDeliveryService)
orders[][delivery][service][name]string Название
orders[][delivery][service][code]string Символьный код
orders[][delivery][service][active]boolean Статус активности
orders[][delivery][service][deliveryType]string Тип доставки
orders[][delivery][cost]double Стоимость доставки
orders[][delivery][netCost]double Себестоимость доставки
orders[][delivery][date]DateTimeY-m-d Дата доставки
orders[][delivery][time]object (TimeInterval) Информация о временном диапазоне
orders[][delivery][time][from]DateTimeH:i Время "с"
orders[][delivery][time][to]DateTimeH:i Время "до"
orders[][delivery][time][custom]string Временной диапазон в свободной форме
orders[][delivery][address]object (OrderDeliveryAddress) Адрес доставки
orders[][delivery][address][index]string Индекс
orders[][delivery][address][countryIso]string ISO код страны
orders[][delivery][address][region]string Регион
orders[][delivery][address][regionId]integer Идентификатор региона в Geohelper
orders[][delivery][address][city]string Город
orders[][delivery][address][cityId]integer Идентификатор города в Geohelper
orders[][delivery][address][cityType]string Тип населенного пункта
orders[][delivery][address][street]string Улица
orders[][delivery][address][streetId]integer Идентификатор улицы в Geohelper
orders[][delivery][address][streetType]string Тип улицы
orders[][delivery][address][building]string Дом
orders[][delivery][address][flat]string Номер квартиры/офиса
orders[][delivery][address][floor]integer Этаж
orders[][delivery][address][block]integer Подъезд
orders[][delivery][address][house]string Строение
orders[][delivery][address][housing]string Корпус
orders[][delivery][address][metro]string Метро
orders[][delivery][address][notes]string Примечания к адресу
orders[][delivery][address][text]string Адрес в текстовом виде
orders[][delivery][vatRate]string Ставка НДС
orders[][source]object (SerializedSource) Источник заказа
orders[][source][source]string Источник
orders[][source][medium]string Канал
orders[][source][campaign]string Кампания
orders[][source][keyword]string Ключевое слово
orders[][source][content]string Содержание кампании
orders[][shipmentStore]string Склад отгрузки
orders[][discount]string Денежная скидка на весь заказ
orders[][discountPercent]string Процентная скидка на весь заказ

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
uploadedOrders[] array of objects (FixExternalRow) Идентификаторы загруженных объектов
uploadedOrders[][id] integer Внутренний ID
uploadedOrders[][externalId] string Внешний ID
failedOrders[] array of objects (EntityWithExternalId) Идентификаторы незагруженных объектов
failedOrders[][externalId] string Внешний ID (при наличии)
orders[] array of objects (Order) Заказ
orders[][paymentType] string deprecated Тип оплаты
orders[][paymentStatus] string deprecated Статус оплаты
orders[][slug] custom handler result for (int) deprecated Символьный код
orders[][discount] float Денежная скидка на весь заказ
orders[][discountPercent] float Процентная скидка на весь заказ
orders[][paymentDetail] string deprecated Детали платежа
orders[][currency] string Валюта
orders[][id] integer ID заказа
orders[][number] string Номер заказа
orders[][externalId] string Внешний ID заказа
orders[][orderType] string Тип заказа
orders[][orderMethod] string Способ оформления
orders[][countryIso] string ISO код страны
orders[][createdAt] DateTime Дата оформления заказа
orders[][statusUpdatedAt] DateTime Дата последнего изменения статуса
orders[][totalSumm] double Общая сумма с учетом скидки (в валюте объекта)
orders[][prepaySum] double Оплаченная сумма (в валюте объекта)
orders[][purchaseSumm] double Общая стоимость закупки (в базовой валюте)
orders[][mark] integer Оценка заказа
orders[][markDatetime] DateTime Дата и время получение оценки от покупателя
orders[][lastName] string Фамилия
orders[][firstName] string Имя
orders[][patronymic] string Отчество
orders[][phone] string Телефон
orders[][additionalPhone] string Дополнительный телефон
orders[][email] string E-mail
orders[][call] boolean Требуется позвонить
orders[][expired] boolean Просрочен
orders[][customerComment] string Комментарий клиента
orders[][managerComment] string Комментарий оператора
orders[][managerId] integer Менеджер, прикрепленный к заказу
orders[][customer]КлиентКорпоративный клиент
orders[][customer][id] integer ID клиентаID корпоративного клиента
orders[][customer][externalId] string Внешний ID клиентаВнешний ID корпоративного клиента
orders[][customer][isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
orders[][customer][createdAt] DateTime СозданСоздан
orders[][customer][managerId] integer Менеджер клиентаМенеджер корпоративного клиента
orders[][customer][vip] boolean Важный клиентВажный клиент
orders[][customer][bad] boolean Плохой клиентПлохой клиент
orders[][customer][site] string Магазин, с которого пришел клиентМагазин, с которого пришел клиент
orders[][customer][contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
orders[][customer][contragent][contragentType] string Тип контрагента
orders[][customer][contragent][legalName] string Полное наименование
orders[][customer][contragent][legalAddress] string Адрес регистрации
orders[][customer][contragent][INN] string ИНН
orders[][customer][contragent][OKPO] string ОКПО
orders[][customer][contragent][KPP] string КПП
orders[][customer][contragent][OGRN] string ОГРН
orders[][customer][contragent][OGRNIP] string ОГРНИП
orders[][customer][contragent][certificateNumber] string Номер свидетельства
orders[][customer][contragent][certificateDate] DateTime Дата свидетельства
orders[][customer][contragent][BIK] string БИК
orders[][customer][contragent][bank] string Банк
orders[][customer][contragent][bankAddress] string Адрес банка
orders[][customer][contragent][corrAccount] string Корр. счёт
orders[][customer][contragent][bankAccount] string Расчётный счёт
orders[][customer][firstClientId] string Первая метка клиента Google AnalyticsПервая метка клиента Google Analytics
orders[][customer][lastClientId] string Последняя метка клиента Google AnalyticsПоследняя метка клиента Google Analytics
orders[][customer][customFields] array Ассоциативный массив пользовательских полейАссоциативный массив пользовательских полей
orders[][customer][personalDiscount] double Персональная скидкаПерсональная скидка
orders[][customer][cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
orders[][customer][discountCardNumber] string Номер дисконтной картыНомер дисконтной карты
orders[][customer][avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте)
orders[][customer][marginSumm] float LTV (в базовой валюте)LTV (в базовой валюте)
orders[][customer][totalSumm] float Общая сумма заказов (в базовой валюте)Общая сумма заказов (в базовой валюте)
orders[][customer][averageSumm] float Средняя сумма заказа (в базовой валюте)Средняя сумма заказа (в базовой валюте)
orders[][customer][ordersCount] integer Количество заказовКоличество заказов
orders[][customer][address] object (CustomerAddress) Адрес клиента
orders[][customer][address][id] integer ID адреса
orders[][customer][address][index] string Индекс
orders[][customer][address][countryIso] string ISO код страны
orders[][customer][address][region] string Регион
orders[][customer][address][regionId] integer Идентификатор региона в Geohelper
orders[][customer][address][city] string Город
orders[][customer][address][cityId] integer Идентификатор города в Geohelper
orders[][customer][address][cityType] string Тип населенного пункта
orders[][customer][address][street] string Улица
orders[][customer][address][streetId] integer Идентификатор улицы в Geohelper
orders[][customer][address][streetType] string Тип улицы
orders[][customer][address][building] string Дом
orders[][customer][address][flat] string Номер квартиры/офиса
orders[][customer][address][floor] integer Этаж
orders[][customer][address][block] integer Подъезд
orders[][customer][address][house] string Строение
orders[][customer][address][housing] string Корпус
orders[][customer][address][metro] string Метро
orders[][customer][address][notes] string Примечания к адресу
orders[][customer][address][text] string Адрес в текстовом виде
orders[][customer][maturationTime] integer Время «созревания», в секундах
orders[][customer][firstName] string Имя
orders[][customer][lastName] string Фамилия
orders[][customer][patronymic] string Отчество
orders[][customer][email] string E-mail
orders[][customer][emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
orders[][customer][customerSubscriptions][] array of objects (CustomerSubscription) Подписки
orders[][customer][customerSubscriptions][][subscription] object (Subscription) Категория подписки
orders[][customer][customerSubscriptions][][subscription][id] integer ID категории подписки
orders[][customer][customerSubscriptions][][subscription][channel] string Канал
orders[][customer][customerSubscriptions][][subscription][name] string Название
orders[][customer][customerSubscriptions][][subscription][code] string Символьный код
orders[][customer][customerSubscriptions][][subscription][active] boolean Статус активности
orders[][customer][customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
orders[][customer][customerSubscriptions][][subscription][ordering] integer
orders[][customer][customerSubscriptions][][subscribed] boolean Активность подписки
orders[][customer][customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
orders[][customer][phones][] array of objects (CustomerPhone) Телефоны
orders[][customer][phones][][number] string Номер телефона
orders[][customer][birthday] DateTime День рождения
orders[][customer][source] object (SerializedSource) Источник клиента
orders[][customer][source][source] string Источник
orders[][customer][source][medium] string Канал
orders[][customer][source][campaign] string Кампания
orders[][customer][source][keyword] string Ключевое слово
orders[][customer][source][content] string Содержание кампании
orders[][customer][mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
orders[][customer][mgCustomers][][id] integer ID клиента
orders[][customer][mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
orders[][customer][mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
orders[][customer][mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
orders[][customer][commentary] string deprecated Комментарий
orders[][customer][photoUrl] string URL фотографии
orders[][customer][nickName] string Наименование
orders[][contragent] object (OrderContragent) Реквизиты
orders[][contragent][contragentType] string Тип контрагента
orders[][contragent][legalName] string Полное наименование
orders[][contragent][legalAddress] string Адрес регистрации
orders[][contragent][INN] string ИНН
orders[][contragent][OKPO] string ОКПО
orders[][contragent][KPP] string КПП
orders[][contragent][OGRN] string ОГРН
orders[][contragent][OGRNIP] string ОГРНИП
orders[][contragent][certificateNumber] string Номер свидетельства
orders[][contragent][certificateDate] DateTime Дата свидетельства
orders[][contragent][BIK] string БИК
orders[][contragent][bank] string Банк
orders[][contragent][bankAddress] string Адрес банка
orders[][contragent][corrAccount] string Корр. счёт
orders[][contragent][bankAccount] string Расчётный счёт
orders[][delivery] object (SerializedOrderDelivery) Данные о доставке
orders[][delivery][code] string Код типа доставки
orders[][delivery][integrationCode] string Интеграционный код типа доставки
orders[][delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
orders[][delivery][data][externalId] string Идентификатор в службе доставкиdeprecated Номер отправления (Используйте trackNumber)
orders[][delivery][data][trackNumber] string Номер отправления (поле deprecated на запись)Номер отправленияНомер отправленияНомер отправления
orders[][delivery][data][status] string Код статуса доставкиКод статуса доставкиКод статуса доставкиКод статуса доставки
orders[][delivery][data][locked] boolean Не синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
orders[][delivery][data][pickuppointAddress] string Адрес пункта самовывоза
orders[][delivery][data][days] string Ориентировочный срок доставкиОриентировочный срок доставкиОриентировочный срок доставки
orders[][delivery][data][statusText] string Наименование статуса доставкиНаименование статуса доставкиНаименование статуса доставки
orders[][delivery][data][statusDate] DateTime Дата статуса доставкиДата последнего изменения статуса доставки
orders[][delivery][data][tariff] string Код тарифа
orders[][delivery][data][tariffName] string Наименование тарифа
orders[][delivery][data][pickuppointId] string Идентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
orders[][delivery][data][pickuppointSchedule] string Режим работы пункта самовывозаРасписание работы пункта самовывоза
orders[][delivery][data][pickuppointPhone] string Телефон пункта самовывоза
orders[][delivery][data][payerType] string Плательщик за доставкуТип плательщика
orders[][delivery][data][statusComment] string Комментарий к статусу доставки
orders[][delivery][data][cost] float Стоимость доставки, полученная из службы доставки (в валюте объекта)Стоимость доставки, полученная из службы доставки (в валюте объекта)
orders[][delivery][data][minTerm] integer Минимальный срок доставки
orders[][delivery][data][maxTerm] integer Максимальный срок доставки
orders[][delivery][data][shipmentpointId] string Идентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
orders[][delivery][data][shipmentpointName] string Наименование терминала отгрузки
orders[][delivery][data][shipmentpointAddress] string Адрес терминала отгрузки
orders[][delivery][data][shipmentpointSchedule] string Режим работы терминала отгрузки
orders[][delivery][data][shipmentpointPhone] string Телефон терминала отгрузки
orders[][delivery][data][shipmentpointCoordinateLatitude] string Координаты терминала отгрузки, широта
orders[][delivery][data][shipmentpointCoordinateLongitude] string Координаты терминала отгрузки, долгота
orders[][delivery][data][pickuppointName] string Наименование пункта самовывоза
orders[][delivery][data][pickuppointCoordinateLatitude] string Координаты ПВЗ, широта
orders[][delivery][data][pickuppointCoordinateLongitude] string Координаты ПВЗ, долгота
orders[][delivery][data][extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
orders[][delivery][data][id] integer Идентификатор курьера
orders[][delivery][data][firstName] string Имя
orders[][delivery][data][email] string E-mail
orders[][delivery][data][phone] object (CourierPhone) Телефон курьера
orders[][delivery][data][phone][number] string Номер телефона
orders[][delivery][data][courierId] integer Идентификатор курьера
orders[][delivery][data][statusCode] string deprecated Код статуса доставки+
orders[][delivery][data][serviceType] string Технология доставки
orders[][delivery][data][pickuppoint] string Пункт самовывозаНазвание пункта самовывоза
orders[][delivery][data][statusName] string Наименование статуса доставки
orders[][delivery][data][price] float Стоимость доставки, полученная из службы доставки
orders[][delivery][data][receiverCity] string Название города доставкиГород доставки
orders[][delivery][data][receiverCityRef] string Идентификатор города доставки в NewPostИдентификатор города доставки
orders[][delivery][data][receiverStreet] string Название улицы доставки
orders[][delivery][data][receiverStreetRef] string Идентификатор улицы доставки в NewPost
orders[][delivery][data][seatsAmount] integer Количество мест отправления
orders[][delivery][data][cargoDescription] string Описание груза
orders[][delivery][data][paymentForm] string Форма оплаты за доставку
orders[][delivery][data][packageNumber] string Номер упаковки
orders[][delivery][data][deliveryDate] string Дата когда получатель забрал товар
orders[][delivery][data][denieReason] string Причина отказа
orders[][delivery][data][declaredValue] float Объявленная стоимость (в валюте объекта)
orders[][delivery][data][sendDate] DateTime Дата отправки
orders[][delivery][data][deliveryType] string Идентификатор способа доставки
orders[][delivery][data][deliveryName] string Название службы доставки
orders[][delivery][data][pickupType] integer Тип забора
orders[][delivery][data][pickuppointDescription] string Описание пункта самовывоза
orders[][delivery][data][placesCount] integer Количество мест
orders[][delivery][data][services][] array of strings Дополнительные услуги доставки
orders[][delivery][data][comment] string Комментарий к заказу
orders[][delivery][service] object (SerializedDeliveryService)
orders[][delivery][service][name] string Название
orders[][delivery][service][code] string Символьный код
orders[][delivery][service][active] boolean Статус активности
orders[][delivery][cost] double Стоимость доставки
orders[][delivery][netCost] double Себестоимость доставки
orders[][delivery][date] DateTime Дата доставки
orders[][delivery][time] object (TimeInterval) Информация о временном диапазоне
orders[][delivery][time][from] DateTime Время "с"
orders[][delivery][time][to] DateTime Время "до"
orders[][delivery][time][custom] string Временной диапазон в свободной форме
orders[][delivery][address] object (OrderDeliveryAddress) Адрес доставки
orders[][delivery][address][index] string Индекс
orders[][delivery][address][countryIso] string ISO код страны
orders[][delivery][address][region] string Регион
orders[][delivery][address][regionId] integer Идентификатор региона в Geohelper
orders[][delivery][address][city] string Город
orders[][delivery][address][cityId] integer Идентификатор города в Geohelper
orders[][delivery][address][cityType] string Тип населенного пункта
orders[][delivery][address][street] string Улица
orders[][delivery][address][streetId] integer Идентификатор улицы в Geohelper
orders[][delivery][address][streetType] string Тип улицы
orders[][delivery][address][building] string Дом
orders[][delivery][address][flat] string Номер квартиры/офиса
orders[][delivery][address][floor] integer Этаж
orders[][delivery][address][block] integer Подъезд
orders[][delivery][address][house] string Строение
orders[][delivery][address][housing] string Корпус
orders[][delivery][address][metro] string Метро
orders[][delivery][address][notes] string Примечания к адресу
orders[][delivery][address][text] string Адрес в текстовом виде
orders[][delivery][vatRate] string Ставка НДС
orders[][site] string Магазин
orders[][status] string Статус заказа
orders[][statusComment] string Комментарий к последнему изменению статуса
orders[][source] object (SerializedSource) Источник заказа
orders[][source][source] string Источник
orders[][source][medium] string Канал
orders[][source][campaign] string Кампания
orders[][source][keyword] string Ключевое слово
orders[][source][content] string Содержание кампании
orders[][items][] array of objects (OrderProduct) Позиция в заказе
orders[][items][][discount] float deprecated Денежная скидка на единицу товара
orders[][items][][discountPercent] float deprecated Процентная скидка на единицу товара
orders[][items][][markingCodes][] array of strings Коды маркировки
orders[][items][][id] integer ID позиции в заказе
orders[][items][][priceType] object (PriceType) Тип цены
orders[][items][][priceType][code] string Код типа цены
orders[][items][][initialPrice] double Цена товара/SKU (в валюте объекта)
orders[][items][][prices][] array of objects (OrderProductPriceItem) Набор итоговых цен реализации с указанием количества
orders[][items][][prices][][price] float Итоговая цена c учетом всех скидок на товар и заказ (в валюте объекта)
orders[][items][][prices][][quantity] float Количество товара по заданной цене
orders[][items][][vatRate] string Ставка НДС
orders[][items][][createdAt] DateTime Дата создания позиции в системе
orders[][items][][quantity] float Количество
orders[][items][][status] string Статус позиции в заказе
orders[][items][][comment] string Комментарий к позиции в заказе
orders[][items][][offer] object (Offer) Торговое предложение
orders[][items][][offer][displayName] string Название SKU
orders[][items][][offer][id] integer ID торгового предложения
orders[][items][][offer][externalId] string ID торгового предложения в магазине
orders[][items][][offer][xmlId] string ID торгового предложения в складской системе
orders[][items][][offer][name] string Название
orders[][items][][offer][article] string Артикул
orders[][items][][offer][vatRate] string Ставка НДС
orders[][items][][offer][properties] array Свойства SKU
orders[][items][][isCanceled] boolean Данная позиция в заказе является отменной
orders[][items][][properties] array [массив] Дополнительные свойства позиции в заказе
orders[][items][][purchasePrice] double Закупочная цена (в базовой валюте)
orders[][items][][ordering] integer Порядок
orders[][fullPaidAt] DateTime Дата полной оплаты
orders[][fromApi] boolean Заказ поступил через API
orders[][shipmentStore] string Склад отгрузки
orders[][shipmentDate] DateTime Дата отгрузки
orders[][shipped] boolean Заказ отгружен
orders[][customFields] array Ассоциативный массив пользовательских полей
orders[][clientId] string Метка клиента Google Analytics

Статусы ответа

Код статуса ответаОписание
201
  • Все заказы успешно загружены
400
  • Не передан массив заказов, либо массив слишком большой
460
  • Во время загрузки возникли ошибки. Часть заказов не загружена (в ответе также присутствует массив ошибок "errors")

GET /api/v4/orders/{externalId} Получение информации о заказе

Получение информации о заказе

Для доступа к методу необходимо разрешение order_read.

Метод возвращает полную информацию по заказу. Можно обращаться к заказу как по внешнему ID заказа (by=externalId), так и по внутреннему ID (by=id).

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

Пустые поля без значений не возвращаются.

В полях orderType, orderMethod, paymentType, paymentStatus, status, site, delivery[code] возвращается символьный код элемента.

В полях managerId, sourceId возвращается внутренний ID сущности в системе.

В поле customFields возвращается массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Если адрес доставки указывался в строковом виде, то он будет возвращен в delivery[address][text]. Если адрес указывался в детальном виде, то будут возвращены все заполненные поля доставки, а в delivery[address][text] будет находиться автоматически сформированное текстовое представление адреса.

Параметры

ПараметрТипФорматОписание
externalIdstring ID заказа

Параметры для фильтрации

ПараметрОписание
by
Шаблонid|externalId
Значение по умолчаниюexternalId
ОписаниеУказывается, что передается в параметре externalId: внутренний (by=id) или внешний (by=externalId) ID заказа. По умолчанию externalId.
site
ОписаниеСимвольный код магазина

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
order object (Order) Заказ
order[paymentType] string deprecated Тип оплаты
order[paymentStatus] string deprecated Статус оплаты
order[slug] custom handler result for (int) deprecated Символьный код
order[discount] float Денежная скидка на весь заказ
order[discountPercent] float Процентная скидка на весь заказ
order[paymentDetail] string deprecated Детали платежа
order[currency] string Валюта
order[id] integer ID заказа
order[number] string Номер заказа
order[externalId] string Внешний ID заказа
order[orderType] string Тип заказа
order[orderMethod] string Способ оформления
order[countryIso] string ISO код страны
order[createdAt] DateTime Дата оформления заказа
order[statusUpdatedAt] DateTime Дата последнего изменения статуса
order[totalSumm] double Общая сумма с учетом скидки (в валюте объекта)
order[prepaySum] double Оплаченная сумма (в валюте объекта)
order[purchaseSumm] double Общая стоимость закупки (в базовой валюте)
order[mark] integer Оценка заказа
order[markDatetime] DateTime Дата и время получение оценки от покупателя
order[lastName] string Фамилия
order[firstName] string Имя
order[patronymic] string Отчество
order[phone] string Телефон
order[additionalPhone] string Дополнительный телефон
order[email] string E-mail
order[call] boolean Требуется позвонить
order[expired] boolean Просрочен
order[customerComment] string Комментарий клиента
order[managerComment] string Комментарий оператора
order[managerId] integer Менеджер, прикрепленный к заказу
order[customer]КлиентКорпоративный клиент
order[customer][id] integer ID клиентаID корпоративного клиента
order[customer][externalId] string Внешний ID клиентаВнешний ID корпоративного клиента
order[customer][isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
order[customer][createdAt] DateTime СозданСоздан
order[customer][managerId] integer Менеджер клиентаМенеджер корпоративного клиента
order[customer][vip] boolean Важный клиентВажный клиент
order[customer][bad] boolean Плохой клиентПлохой клиент
order[customer][site] string Магазин, с которого пришел клиентМагазин, с которого пришел клиент
order[customer][contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
order[customer][contragent][contragentType] string Тип контрагента
order[customer][contragent][legalName] string Полное наименование
order[customer][contragent][legalAddress] string Адрес регистрации
order[customer][contragent][INN] string ИНН
order[customer][contragent][OKPO] string ОКПО
order[customer][contragent][KPP] string КПП
order[customer][contragent][OGRN] string ОГРН
order[customer][contragent][OGRNIP] string ОГРНИП
order[customer][contragent][certificateNumber] string Номер свидетельства
order[customer][contragent][certificateDate] DateTime Дата свидетельства
order[customer][contragent][BIK] string БИК
order[customer][contragent][bank] string Банк
order[customer][contragent][bankAddress] string Адрес банка
order[customer][contragent][corrAccount] string Корр. счёт
order[customer][contragent][bankAccount] string Расчётный счёт
order[customer][firstClientId] string Первая метка клиента Google AnalyticsПервая метка клиента Google Analytics
order[customer][lastClientId] string Последняя метка клиента Google AnalyticsПоследняя метка клиента Google Analytics
order[customer][customFields] array Ассоциативный массив пользовательских полейАссоциативный массив пользовательских полей
order[customer][personalDiscount] double Персональная скидкаПерсональная скидка
order[customer][cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
order[customer][discountCardNumber] string Номер дисконтной картыНомер дисконтной карты
order[customer][avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте)
order[customer][marginSumm] float LTV (в базовой валюте)LTV (в базовой валюте)
order[customer][totalSumm] float Общая сумма заказов (в базовой валюте)Общая сумма заказов (в базовой валюте)
order[customer][averageSumm] float Средняя сумма заказа (в базовой валюте)Средняя сумма заказа (в базовой валюте)
order[customer][ordersCount] integer Количество заказовКоличество заказов
order[customer][address] object (CustomerAddress) Адрес клиента
order[customer][address][id] integer ID адреса
order[customer][address][index] string Индекс
order[customer][address][countryIso] string ISO код страны
order[customer][address][region] string Регион
order[customer][address][regionId] integer Идентификатор региона в Geohelper
order[customer][address][city] string Город
order[customer][address][cityId] integer Идентификатор города в Geohelper
order[customer][address][cityType] string Тип населенного пункта
order[customer][address][street] string Улица
order[customer][address][streetId] integer Идентификатор улицы в Geohelper
order[customer][address][streetType] string Тип улицы
order[customer][address][building] string Дом
order[customer][address][flat] string Номер квартиры/офиса
order[customer][address][floor] integer Этаж
order[customer][address][block] integer Подъезд
order[customer][address][house] string Строение
order[customer][address][housing] string Корпус
order[customer][address][metro] string Метро
order[customer][address][notes] string Примечания к адресу
order[customer][address][text] string Адрес в текстовом виде
order[customer][maturationTime] integer Время «созревания», в секундах
order[customer][firstName] string Имя
order[customer][lastName] string Фамилия
order[customer][patronymic] string Отчество
order[customer][email] string E-mail
order[customer][emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
order[customer][customerSubscriptions][] array of objects (CustomerSubscription) Подписки
order[customer][customerSubscriptions][][subscription] object (Subscription) Категория подписки
order[customer][customerSubscriptions][][subscription][id] integer ID категории подписки
order[customer][customerSubscriptions][][subscription][channel] string Канал
order[customer][customerSubscriptions][][subscription][name] string Название
order[customer][customerSubscriptions][][subscription][code] string Символьный код
order[customer][customerSubscriptions][][subscription][active] boolean Статус активности
order[customer][customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
order[customer][customerSubscriptions][][subscription][ordering] integer
order[customer][customerSubscriptions][][subscribed] boolean Активность подписки
order[customer][customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
order[customer][phones][] array of objects (CustomerPhone) Телефоны
order[customer][phones][][number] string Номер телефона
order[customer][birthday] DateTime День рождения
order[customer][source] object (SerializedSource) Источник клиента
order[customer][source][source] string Источник
order[customer][source][medium] string Канал
order[customer][source][campaign] string Кампания
order[customer][source][keyword] string Ключевое слово
order[customer][source][content] string Содержание кампании
order[customer][mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
order[customer][mgCustomers][][id] integer ID клиента
order[customer][mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
order[customer][mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
order[customer][mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
order[customer][commentary] string deprecated Комментарий
order[customer][photoUrl] string URL фотографии
order[customer][nickName] string Наименование
order[contragent] object (OrderContragent) Реквизиты
order[contragent][contragentType] string Тип контрагента
order[contragent][legalName] string Полное наименование
order[contragent][legalAddress] string Адрес регистрации
order[contragent][INN] string ИНН
order[contragent][OKPO] string ОКПО
order[contragent][KPP] string КПП
order[contragent][OGRN] string ОГРН
order[contragent][OGRNIP] string ОГРНИП
order[contragent][certificateNumber] string Номер свидетельства
order[contragent][certificateDate] DateTime Дата свидетельства
order[contragent][BIK] string БИК
order[contragent][bank] string Банк
order[contragent][bankAddress] string Адрес банка
order[contragent][corrAccount] string Корр. счёт
order[contragent][bankAccount] string Расчётный счёт
order[delivery] object (SerializedOrderDelivery) Данные о доставке
order[delivery][code] string Код типа доставки
order[delivery][integrationCode] string Интеграционный код типа доставки
order[delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
order[delivery][data][externalId] string Идентификатор в службе доставкиdeprecated Номер отправления (Используйте trackNumber)
order[delivery][data][trackNumber] string Номер отправления (поле deprecated на запись)Номер отправленияНомер отправленияНомер отправления
order[delivery][data][status] string Код статуса доставкиКод статуса доставкиКод статуса доставкиКод статуса доставки
order[delivery][data][locked] boolean Не синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
order[delivery][data][pickuppointAddress] string Адрес пункта самовывоза
order[delivery][data][days] string Ориентировочный срок доставкиОриентировочный срок доставкиОриентировочный срок доставки
order[delivery][data][statusText] string Наименование статуса доставкиНаименование статуса доставкиНаименование статуса доставки
order[delivery][data][statusDate] DateTime Дата статуса доставкиДата последнего изменения статуса доставки
order[delivery][data][tariff] string Код тарифа
order[delivery][data][tariffName] string Наименование тарифа
order[delivery][data][pickuppointId] string Идентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
order[delivery][data][pickuppointSchedule] string Режим работы пункта самовывозаРасписание работы пункта самовывоза
order[delivery][data][pickuppointPhone] string Телефон пункта самовывоза
order[delivery][data][payerType] string Плательщик за доставкуТип плательщика
order[delivery][data][statusComment] string Комментарий к статусу доставки
order[delivery][data][cost] float Стоимость доставки, полученная из службы доставки (в валюте объекта)Стоимость доставки, полученная из службы доставки (в валюте объекта)
order[delivery][data][minTerm] integer Минимальный срок доставки
order[delivery][data][maxTerm] integer Максимальный срок доставки
order[delivery][data][shipmentpointId] string Идентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
order[delivery][data][shipmentpointName] string Наименование терминала отгрузки
order[delivery][data][shipmentpointAddress] string Адрес терминала отгрузки
order[delivery][data][shipmentpointSchedule] string Режим работы терминала отгрузки
order[delivery][data][shipmentpointPhone] string Телефон терминала отгрузки
order[delivery][data][shipmentpointCoordinateLatitude] string Координаты терминала отгрузки, широта
order[delivery][data][shipmentpointCoordinateLongitude] string Координаты терминала отгрузки, долгота
order[delivery][data][pickuppointName] string Наименование пункта самовывоза
order[delivery][data][pickuppointCoordinateLatitude] string Координаты ПВЗ, широта
order[delivery][data][pickuppointCoordinateLongitude] string Координаты ПВЗ, долгота
order[delivery][data][extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
order[delivery][data][id] integer Идентификатор курьера
order[delivery][data][firstName] string Имя
order[delivery][data][email] string E-mail
order[delivery][data][phone] object (CourierPhone) Телефон курьера
order[delivery][data][phone][number] string Номер телефона
order[delivery][data][courierId] integer Идентификатор курьера
order[delivery][data][statusCode] string deprecated Код статуса доставки+
order[delivery][data][serviceType] string Технология доставки
order[delivery][data][pickuppoint] string Пункт самовывозаНазвание пункта самовывоза
order[delivery][data][statusName] string Наименование статуса доставки
order[delivery][data][price] float Стоимость доставки, полученная из службы доставки
order[delivery][data][receiverCity] string Название города доставкиГород доставки
order[delivery][data][receiverCityRef] string Идентификатор города доставки в NewPostИдентификатор города доставки
order[delivery][data][receiverStreet] string Название улицы доставки
order[delivery][data][receiverStreetRef] string Идентификатор улицы доставки в NewPost
order[delivery][data][seatsAmount] integer Количество мест отправления
order[delivery][data][cargoDescription] string Описание груза
order[delivery][data][paymentForm] string Форма оплаты за доставку
order[delivery][data][packageNumber] string Номер упаковки
order[delivery][data][deliveryDate] string Дата когда получатель забрал товар
order[delivery][data][denieReason] string Причина отказа
order[delivery][data][declaredValue] float Объявленная стоимость (в валюте объекта)
order[delivery][data][sendDate] DateTime Дата отправки
order[delivery][data][deliveryType] string Идентификатор способа доставки
order[delivery][data][deliveryName] string Название службы доставки
order[delivery][data][pickupType] integer Тип забора
order[delivery][data][pickuppointDescription] string Описание пункта самовывоза
order[delivery][data][placesCount] integer Количество мест
order[delivery][data][services][] array of strings Дополнительные услуги доставки
order[delivery][data][comment] string Комментарий к заказу
order[delivery][service] object (SerializedDeliveryService)
order[delivery][service][name] string Название
order[delivery][service][code] string Символьный код
order[delivery][service][active] boolean Статус активности
order[delivery][cost] double Стоимость доставки
order[delivery][netCost] double Себестоимость доставки
order[delivery][date] DateTime Дата доставки
order[delivery][time] object (TimeInterval) Информация о временном диапазоне
order[delivery][time][from] DateTime Время "с"
order[delivery][time][to] DateTime Время "до"
order[delivery][time][custom] string Временной диапазон в свободной форме
order[delivery][address] object (OrderDeliveryAddress) Адрес доставки
order[delivery][address][index] string Индекс
order[delivery][address][countryIso] string ISO код страны
order[delivery][address][region] string Регион
order[delivery][address][regionId] integer Идентификатор региона в Geohelper
order[delivery][address][city] string Город
order[delivery][address][cityId] integer Идентификатор города в Geohelper
order[delivery][address][cityType] string Тип населенного пункта
order[delivery][address][street] string Улица
order[delivery][address][streetId] integer Идентификатор улицы в Geohelper
order[delivery][address][streetType] string Тип улицы
order[delivery][address][building] string Дом
order[delivery][address][flat] string Номер квартиры/офиса
order[delivery][address][floor] integer Этаж
order[delivery][address][block] integer Подъезд
order[delivery][address][house] string Строение
order[delivery][address][housing] string Корпус
order[delivery][address][metro] string Метро
order[delivery][address][notes] string Примечания к адресу
order[delivery][address][text] string Адрес в текстовом виде
order[delivery][vatRate] string Ставка НДС
order[site] string Магазин
order[status] string Статус заказа
order[statusComment] string Комментарий к последнему изменению статуса
order[source] object (SerializedSource) Источник заказа
order[source][source] string Источник
order[source][medium] string Канал
order[source][campaign] string Кампания
order[source][keyword] string Ключевое слово
order[source][content] string Содержание кампании
order[items][] array of objects (OrderProduct) Позиция в заказе
order[items][][discount] float deprecated Денежная скидка на единицу товара
order[items][][discountPercent] float deprecated Процентная скидка на единицу товара
order[items][][markingCodes][] array of strings Коды маркировки
order[items][][id] integer ID позиции в заказе
order[items][][priceType] object (PriceType) Тип цены
order[items][][priceType][code] string Код типа цены
order[items][][initialPrice] double Цена товара/SKU (в валюте объекта)
order[items][][prices][] array of objects (OrderProductPriceItem) Набор итоговых цен реализации с указанием количества
order[items][][prices][][price] float Итоговая цена c учетом всех скидок на товар и заказ (в валюте объекта)
order[items][][prices][][quantity] float Количество товара по заданной цене
order[items][][vatRate] string Ставка НДС
order[items][][createdAt] DateTime Дата создания позиции в системе
order[items][][quantity] float Количество
order[items][][status] string Статус позиции в заказе
order[items][][comment] string Комментарий к позиции в заказе
order[items][][offer] object (Offer) Торговое предложение
order[items][][offer][displayName] string Название SKU
order[items][][offer][id] integer ID торгового предложения
order[items][][offer][externalId] string ID торгового предложения в магазине
order[items][][offer][xmlId] string ID торгового предложения в складской системе
order[items][][offer][name] string Название
order[items][][offer][article] string Артикул
order[items][][offer][vatRate] string Ставка НДС
order[items][][offer][properties][] array Свойства SKU
order[items][][offer][quantity] float Доступное количество
order[items][][isCanceled] boolean Данная позиция в заказе является отменной
order[items][][properties][] array [массив] Дополнительные свойства позиции в заказе
order[items][][properties][][code] string Код свойства (не обязательное поле, код может передаваться в ключе свойства)
order[items][][properties][][name] string Имя свойства
order[items][][properties][][value] string Значение свойства
order[items][][purchasePrice] double Закупочная цена (в базовой валюте)
order[items][][ordering] integer Порядок
order[fullPaidAt] DateTime Дата полной оплаты
order[fromApi] boolean Заказ поступил через API
order[shipmentStore] string Склад отгрузки
order[shipmentDate] DateTime Дата отгрузки
order[shipped] boolean Заказ отгружен
order[customFields] array Ассоциативный массив пользовательских полей
order[clientId] string Метка клиента Google Analytics

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
404
  • Заказ не найден

POST /api/v4/orders/{externalId}/edit Редактирование заказа

Редактирование заказа

Для доступа к методу необходимо разрешение order_write.

Метод позволяет вносить изменения в заказ. Можно обращаться к заказу как по внешнему ID заказа (by=externalId), так и по внутреннему ID (by=id).

В случае, если производится попытка отредактировать удаленный заказ, система возвращает в ответе state=removed.

Поле contragent[contragentType] может принимать 3 значения: individual - физическое лицо, legal-entity - юридическое лицо, enterpreneur - индивидуальный предприниматель. Для различных типов юр. лиц доступны различные наборы полей. Для типа individual недоступны все поля, для типа legal-entity недоступны поля contragent[OGRNIP], contragent[certificateNumber], contragent[certificateDate], для типа enterpreneur недоступны поля contragent[OGRN], contragent[KPP].

В полях order[orderType], order[orderMethod], order[paymentType], order[paymentStatus], order[status], order[shipmentStore], order[delivery][code], order[items][][status] указывается символьный код элемента.

В полях order[managerId], order[sourceId] указывается внутренний ID сущности в системе.

Нельзя изменять комментарий order[statusComment] без изменения статуса заказа order[status].

Товары заказа указываются в поле order[items][]. Не переданные в запросе на редактирование товары удаляются из заказа. Если товар присутствует в каталоге, то необходимо установить значение одного из следующих полей:

Если установлено значение нескольких полей, они будут обрабатываться в указанном выше порядке.

В случае, если ни один из идентификаторов товара не передан либо товар не найден, то товар будет автоматически создан на основе данных полей order[items][][initialPrice], order[items][][purchasePrice], order[items][][productName], при этом данная позиция товара в заказе не привязывается к товару в каталоге.

Адрес доставки order[delivery][address] можно указывать либо в строковом виде в поле order[delivery][address][text], либо в подробном виде, заполняя все поля кроме order[delivery][address][text].

В поле order[customFields] можно передавать массив значений пользовательских полей. Для полей типа «Справочник» указывается символьный код значения в справочнике. Для полей типа «Дата» указывается дата в формате Y-m-d. Для других типов полей указывается непосредственно значение.

Для работы с типами цен необходимо, чтобы в справочнике было активно более одного типа цен. Для передачи типа цены для товарной позиции в заказе необходимо передать код нужного типа цен в поле order[items][][priceType][code]. Рекомендуется вместе с типом цены передавать актуальное значение цены товара через order[items][][initialPrice]. Если передать тип цены order[items][][priceType][code] без значения цены order[items][][initialPrice], то в качестве цены товарной позиции возьмется текущее значения данного типа цен для данного товара. Для новой товарной позиции рекомендуется всегда передавать цену order[items][][initialPrice] явно, на случай если актуальная цена еще не была загружена в систему. Если для товара не передать тип цены order[items][][priceType][code], то в карточке заказа для товарной позиции в типе цены будет указанно Без типа. В случае, если в системе используется только базовый тип цен, то параметр order[items][][priceType][code] следует опустить.

Порядок позиций заказа order[items][] сохраняется в ответе.

Параметры

ПараметрТипФорматОписание
bystring Указывается, что передается в параметре externalId: внутренний (by=id) или внешний (by=externalId) ID заказа. По умолчанию externalId.
sitestring Символьный код магазина
orderobject (SerializedOrder)
order[paymentType]stringdeprecated Тип оплаты
order[paymentStatus]stringdeprecated Статус оплаты
order[paymentDetail]stringdeprecated Детали платежа
order[number]string Номер заказа
order[externalId]string Внешний ID заказа
order[countryIso]string ISO код страны
order[createdAt]DateTimeY-m-d H:i:s Дата оформления заказа
order[mark]integer Оценка заказа
order[markDatetime]DateTimeY-m-d H:i:s Дата и время получение оценки от покупателя
order[lastName]string Фамилия
order[firstName]string Имя
order[patronymic]string Отчество
order[phone]string Телефон
order[additionalPhone]string Дополнительный телефон
order[email]string E-mail
order[call]boolean Требуется позвонить
order[expired]boolean Просрочен
order[customerComment]string Комментарий клиента
order[managerComment]string Комментарий оператора
order[contragent]object (OrderContragent) Реквизиты
order[contragent][contragentType]string Тип контрагента
order[contragent][legalName]string Полное наименование
order[contragent][legalAddress]string Адрес регистрации
order[contragent][INN]string ИНН
order[contragent][OKPO]string ОКПО
order[contragent][KPP]string КПП
order[contragent][OGRN]string ОГРН
order[contragent][OGRNIP]string ОГРНИП
order[contragent][certificateNumber]string Номер свидетельства
order[contragent][certificateDate]DateTimeY-m-d Дата свидетельства
order[contragent][BIK]string БИК
order[contragent][bank]string Банк
order[contragent][bankAddress]string Адрес банка
order[contragent][corrAccount]string Корр. счёт
order[contragent][bankAccount]string Расчётный счёт
order[statusComment]string Комментарий к последнему изменению статуса
order[shipmentDate]DateTimeY-m-d Дата отгрузки
order[shipped]boolean Заказ отгружен
order[customFields]array Ассоциативный массив пользовательских полей
order[orderType]string Тип заказа
order[orderMethod]string Способ оформления
order[customer]object (SerializedRelationCustomer) Клиент
order[customer][id]integer Внутренний ID клиента
order[customer][externalId]string Внешний ID клиента
order[customer][browserId]string Идентификатор устройства в Collector
order[customer][site]string Код магазина, необходим при передаче externalId
order[managerId]integer Менеджер, прикрепленный к заказу
order[status]string Статус заказа
order[items][]array of objects (SerializedOrderProduct)
order[items][][markingCodes][]array of strings Коды маркировки
order[items][][id]integer ID позиции в заказе
order[items][][initialPrice]double Цена товара/SKU (в валюте объекта)
order[items][][vatRate]string Ставка НДС
order[items][][createdAt]DateTimeY-m-d H:i:s Дата создания позиции в системе
order[items][][quantity]float Количество
order[items][][comment]string Комментарий к позиции в заказе
order[items][][properties][]array [массив] Дополнительные свойства позиции в заказе
order[items][][properties][][code]string{not blank}{match: /^[a-zA-Z0-9_][a-zA-Z0-9_\-:]*$/D}} Код свойства (не обязательное поле, код может передаваться в ключе свойства)
order[items][][properties][][name]string{not blank} Имя свойства
order[items][][properties][][value]string{not blank} Значение свойства
order[items][][purchasePrice]double Закупочная цена (в базовой валюте)
order[items][][ordering]integer Порядок
order[items][][offer]object (SerializedOrderProductOffer) Торговое предложение
order[items][][offer][id]integer ID торгового предложения
order[items][][offer][externalId]string Внешний ID торгового предложения
order[items][][offer][xmlId]string ID торгового предложения в складской системе
order[items][][productName]string Название товара
order[items][][status]string Статус позиции в заказе
order[items][][discount]stringdeprecated Денежная скидка на единицу товара
order[items][][discountPercent]stringdeprecated Процентная скидка на единицу товара
order[items][][priceType]object (PriceType) Тип цены
order[items][][priceType][code]string Код типа цены
order[delivery]object (SerializedOrderDelivery) Данные о доставке
order[delivery][code]string Код типа доставки
order[delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
order[delivery][data][externalId]string Идентификатор в службе доставки
order[delivery][data][trackNumber]stringНомер отправления (поле deprecated на запись)Номер отправленияНомер отправления
order[delivery][data][locked]booleanНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
order[delivery][data][tariff]string Код тарифа
order[delivery][data][pickuppointId]stringИдентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
order[delivery][data][payerType]stringПлательщик за доставкуТип плательщика
order[delivery][data][shipmentpointId]stringИдентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
order[delivery][data][extraData]array Дополнительные данные доставки (deliveryDataField.code => значение)
order[delivery][data][courierId]integer Идентификатор курьера
order[delivery][data][serviceType]string Технология доставки
order[delivery][data][pickuppoint]string Пункт самовывоза
order[delivery][data][receiverCity]stringНазвание города доставкиГород доставки
order[delivery][data][receiverCityRef]stringИдентификатор города доставки в NewPostИдентификатор города доставки
order[delivery][data][receiverStreet]string Название улицы доставки
order[delivery][data][receiverStreetRef]string Идентификатор улицы доставки в NewPost
order[delivery][data][seatsAmount]integer Количество мест отправления
order[delivery][data][cargoDescription]string Описание груза
order[delivery][data][paymentForm]string Форма оплаты за доставку
order[delivery][data][packageNumber]string Номер упаковки
order[delivery][data][declaredValue]float Объявленная стоимость (в валюте объекта)
order[delivery][data][sendDate]DateTimeY-m-d Дата отправки
order[delivery][data][deliveryType]string Идентификатор способа доставки
order[delivery][data][pickupType]integer Тип забора
order[delivery][data][placesCount]integer Количество мест
order[delivery][data][services][]array of strings Дополнительные услуги доставки
order[delivery][data][comment]string Комментарий к заказу
order[delivery][service]object (SerializedDeliveryService)
order[delivery][service][name]string Название
order[delivery][service][code]string Символьный код
order[delivery][service][active]boolean Статус активности
order[delivery][service][deliveryType]string Тип доставки
order[delivery][cost]double Стоимость доставки
order[delivery][netCost]double Себестоимость доставки
order[delivery][date]DateTimeY-m-d Дата доставки
order[delivery][time]object (TimeInterval) Информация о временном диапазоне
order[delivery][time][from]DateTimeH:i Время "с"
order[delivery][time][to]DateTimeH:i Время "до"
order[delivery][time][custom]string Временной диапазон в свободной форме
order[delivery][address]object (OrderDeliveryAddress) Адрес доставки
order[delivery][address][index]string Индекс
order[delivery][address][countryIso]string ISO код страны
order[delivery][address][region]string Регион
order[delivery][address][regionId]integer Идентификатор региона в Geohelper
order[delivery][address][city]string Город
order[delivery][address][cityId]integer Идентификатор города в Geohelper
order[delivery][address][cityType]string Тип населенного пункта
order[delivery][address][street]string Улица
order[delivery][address][streetId]integer Идентификатор улицы в Geohelper
order[delivery][address][streetType]string Тип улицы
order[delivery][address][building]string Дом
order[delivery][address][flat]string Номер квартиры/офиса
order[delivery][address][floor]integer Этаж
order[delivery][address][block]integer Подъезд
order[delivery][address][house]string Строение
order[delivery][address][housing]string Корпус
order[delivery][address][metro]string Метро
order[delivery][address][notes]string Примечания к адресу
order[delivery][address][text]string Адрес в текстовом виде
order[delivery][vatRate]string Ставка НДС
order[source]object (SerializedSource) Источник заказа
order[source][source]string Источник
order[source][medium]string Канал
order[source][campaign]string Кампания
order[source][keyword]string Ключевое слово
order[source][content]string Содержание кампании
order[shipmentStore]string Склад отгрузки
order[discount]string Денежная скидка на весь заказ
order[discountPercent]string Процентная скидка на весь заказ

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
id integer Внутренний ID заказа
order object (Order) Заказ
order[paymentType] string deprecated Тип оплаты
order[paymentStatus] string deprecated Статус оплаты
order[slug] custom handler result for (int) deprecated Символьный код
order[discount] float Денежная скидка на весь заказ
order[discountPercent] float Процентная скидка на весь заказ
order[paymentDetail] string deprecated Детали платежа
order[currency] string Валюта
order[id] integer ID заказа
order[number] string Номер заказа
order[externalId] string Внешний ID заказа
order[orderType] string Тип заказа
order[orderMethod] string Способ оформления
order[countryIso] string ISO код страны
order[createdAt] DateTime Дата оформления заказа
order[statusUpdatedAt] DateTime Дата последнего изменения статуса
order[totalSumm] double Общая сумма с учетом скидки (в валюте объекта)
order[prepaySum] double Оплаченная сумма (в валюте объекта)
order[purchaseSumm] double Общая стоимость закупки (в базовой валюте)
order[mark] integer Оценка заказа
order[markDatetime] DateTime Дата и время получение оценки от покупателя
order[lastName] string Фамилия
order[firstName] string Имя
order[patronymic] string Отчество
order[phone] string Телефон
order[additionalPhone] string Дополнительный телефон
order[email] string E-mail
order[call] boolean Требуется позвонить
order[expired] boolean Просрочен
order[customerComment] string Комментарий клиента
order[managerComment] string Комментарий оператора
order[managerId] integer Менеджер, прикрепленный к заказу
order[customer]КлиентКорпоративный клиент
order[customer][id] integer ID клиентаID корпоративного клиента
order[customer][externalId] string Внешний ID клиентаВнешний ID корпоративного клиента
order[customer][isContact] boolean Клиент является контактным лицом (создан как контактное лицо и на него нет оформленных заказов)
order[customer][createdAt] DateTime СозданСоздан
order[customer][managerId] integer Менеджер клиентаМенеджер корпоративного клиента
order[customer][vip] boolean Важный клиентВажный клиент
order[customer][bad] boolean Плохой клиентПлохой клиент
order[customer][site] string Магазин, с которого пришел клиентМагазин, с которого пришел клиент
order[customer][contragent] object (CustomerContragent) deprecated Реквизиты (Поля объекта следует использовать только при неактивированной функциональности "Корпоративные клиенты")
order[customer][contragent][contragentType] string Тип контрагента
order[customer][contragent][legalName] string Полное наименование
order[customer][contragent][legalAddress] string Адрес регистрации
order[customer][contragent][INN] string ИНН
order[customer][contragent][OKPO] string ОКПО
order[customer][contragent][KPP] string КПП
order[customer][contragent][OGRN] string ОГРН
order[customer][contragent][OGRNIP] string ОГРНИП
order[customer][contragent][certificateNumber] string Номер свидетельства
order[customer][contragent][certificateDate] DateTime Дата свидетельства
order[customer][contragent][BIK] string БИК
order[customer][contragent][bank] string Банк
order[customer][contragent][bankAddress] string Адрес банка
order[customer][contragent][corrAccount] string Корр. счёт
order[customer][contragent][bankAccount] string Расчётный счёт
order[customer][firstClientId] string Первая метка клиента Google AnalyticsПервая метка клиента Google Analytics
order[customer][lastClientId] string Последняя метка клиента Google AnalyticsПоследняя метка клиента Google Analytics
order[customer][customFields] array Ассоциативный массив пользовательских полейАссоциативный массив пользовательских полей
order[customer][personalDiscount] double Персональная скидкаПерсональная скидка
order[customer][cumulativeDiscount] double deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)deprecated Накопительная скидка (Недоступно, начиная с 8 версии системы)
order[customer][discountCardNumber] string Номер дисконтной картыНомер дисконтной карты
order[customer][avgMarginSumm] float Средняя валовая прибыль по заказам клиента (в базовой валюте)Средняя валовая прибыль по заказам корпоративного клиента (в базовой валюте)
order[customer][marginSumm] float LTV (в базовой валюте)LTV (в базовой валюте)
order[customer][totalSumm] float Общая сумма заказов (в базовой валюте)Общая сумма заказов (в базовой валюте)
order[customer][averageSumm] float Средняя сумма заказа (в базовой валюте)Средняя сумма заказа (в базовой валюте)
order[customer][ordersCount] integer Количество заказовКоличество заказов
order[customer][address] object (CustomerAddress) Адрес клиента
order[customer][address][id] integer ID адреса
order[customer][address][index] string Индекс
order[customer][address][countryIso] string ISO код страны
order[customer][address][region] string Регион
order[customer][address][regionId] integer Идентификатор региона в Geohelper
order[customer][address][city] string Город
order[customer][address][cityId] integer Идентификатор города в Geohelper
order[customer][address][cityType] string Тип населенного пункта
order[customer][address][street] string Улица
order[customer][address][streetId] integer Идентификатор улицы в Geohelper
order[customer][address][streetType] string Тип улицы
order[customer][address][building] string Дом
order[customer][address][flat] string Номер квартиры/офиса
order[customer][address][floor] integer Этаж
order[customer][address][block] integer Подъезд
order[customer][address][house] string Строение
order[customer][address][housing] string Корпус
order[customer][address][metro] string Метро
order[customer][address][notes] string Примечания к адресу
order[customer][address][text] string Адрес в текстовом виде
order[customer][maturationTime] integer Время «созревания», в секундах
order[customer][firstName] string Имя
order[customer][lastName] string Фамилия
order[customer][patronymic] string Отчество
order[customer][email] string E-mail
order[customer][emailMarketingUnsubscribedAt] DateTime deprecated Дата отписки от email рассылок
order[customer][customerSubscriptions][] array of objects (CustomerSubscription) Подписки
order[customer][customerSubscriptions][][subscription] object (Subscription) Категория подписки
order[customer][customerSubscriptions][][subscription][id] integer ID категории подписки
order[customer][customerSubscriptions][][subscription][channel] string Канал
order[customer][customerSubscriptions][][subscription][name] string Название
order[customer][customerSubscriptions][][subscription][code] string Символьный код
order[customer][customerSubscriptions][][subscription][active] boolean Статус активности
order[customer][customerSubscriptions][][subscription][autoSubscribe] boolean Автоматически подписывать новых клиентов
order[customer][customerSubscriptions][][subscription][ordering] integer
order[customer][customerSubscriptions][][subscribed] boolean Активность подписки
order[customer][customerSubscriptions][][changedAt] DateTime Дата изменения флага активности
order[customer][phones][] array of objects (CustomerPhone) Телефоны
order[customer][phones][][number] string Номер телефона
order[customer][birthday] DateTime День рождения
order[customer][source] object (SerializedSource) Источник клиента
order[customer][source][source] string Источник
order[customer][source][medium] string Канал
order[customer][source][campaign] string Кампания
order[customer][source][keyword] string Ключевое слово
order[customer][source][content] string Содержание кампании
order[customer][mgCustomers][] array of objects (MGCustomer) Клиенты MessageGateway
order[customer][mgCustomers][][id] integer ID клиента
order[customer][mgCustomers][][externalId] integer Внешний ID MessageGateway клиента
order[customer][mgCustomers][][mgChannel] object (MGChannel) MessageGateway канал
order[customer][mgCustomers][][mgChannel][allowedSendByPhone] custom handler result for (bool) Можно ли писать первыми в этот канал по номеру телефона
order[customer][commentary] string deprecated Комментарий
order[customer][photoUrl] string URL фотографии
order[customer][nickName] string Наименование
order[contragent] object (OrderContragent) Реквизиты
order[contragent][contragentType] string Тип контрагента
order[contragent][legalName] string Полное наименование
order[contragent][legalAddress] string Адрес регистрации
order[contragent][INN] string ИНН
order[contragent][OKPO] string ОКПО
order[contragent][KPP] string КПП
order[contragent][OGRN] string ОГРН
order[contragent][OGRNIP] string ОГРНИП
order[contragent][certificateNumber] string Номер свидетельства
order[contragent][certificateDate] DateTime Дата свидетельства
order[contragent][BIK] string БИК
order[contragent][bank] string Банк
order[contragent][bankAddress] string Адрес банка
order[contragent][corrAccount] string Корр. счёт
order[contragent][bankAccount] string Расчётный счёт
order[delivery] object (SerializedOrderDelivery) Данные о доставке
order[delivery][code] string Код типа доставки
order[delivery][integrationCode] string Интеграционный код типа доставки
order[delivery][data]Данные службы доставки, подключенной через APIДанные курьерской службы доставкиДанные службы доставки Новая ПочтаДанные службы доставки SafeRouteДанные службы доставки Казпочта
order[delivery][data][externalId] string Идентификатор в службе доставкиdeprecated Номер отправления (Используйте trackNumber)
order[delivery][data][trackNumber] string Номер отправления (поле deprecated на запись)Номер отправленияНомер отправленияНомер отправления
order[delivery][data][status] string Код статуса доставкиКод статуса доставкиКод статуса доставкиКод статуса доставки
order[delivery][data][locked] boolean Не синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставкиНе синхронизировать со службой доставки
order[delivery][data][pickuppointAddress] string Адрес пункта самовывоза
order[delivery][data][days] string Ориентировочный срок доставкиОриентировочный срок доставкиОриентировочный срок доставки
order[delivery][data][statusText] string Наименование статуса доставкиНаименование статуса доставкиНаименование статуса доставки
order[delivery][data][statusDate] DateTime Дата статуса доставкиДата последнего изменения статуса доставки
order[delivery][data][tariff] string Код тарифа
order[delivery][data][tariffName] string Наименование тарифа
order[delivery][data][pickuppointId] string Идентификатор пункта самовывозаИдентификатор пункта самовывозаИдентификатор пункта самовывоза
order[delivery][data][pickuppointSchedule] string Режим работы пункта самовывозаРасписание работы пункта самовывоза
order[delivery][data][pickuppointPhone] string Телефон пункта самовывоза
order[delivery][data][payerType] string Плательщик за доставкуТип плательщика
order[delivery][data][statusComment] string Комментарий к статусу доставки
order[delivery][data][cost] float Стоимость доставки, полученная из службы доставки (в валюте объекта)Стоимость доставки, полученная из службы доставки (в валюте объекта)
order[delivery][data][minTerm] integer Минимальный срок доставки
order[delivery][data][maxTerm] integer Максимальный срок доставки
order[delivery][data][shipmentpointId] string Идентификатор терминала отгрузкиИдентификатор отделения, откуда будет производится отправка
order[delivery][data][shipmentpointName] string Наименование терминала отгрузки
order[delivery][data][shipmentpointAddress] string Адрес терминала отгрузки
order[delivery][data][shipmentpointSchedule] string Режим работы терминала отгрузки
order[delivery][data][shipmentpointPhone] string Телефон терминала отгрузки
order[delivery][data][shipmentpointCoordinateLatitude] string Координаты терминала отгрузки, широта
order[delivery][data][shipmentpointCoordinateLongitude] string Координаты терминала отгрузки, долгота
order[delivery][data][pickuppointName] string Наименование пункта самовывоза
order[delivery][data][pickuppointCoordinateLatitude] string Координаты ПВЗ, широта
order[delivery][data][pickuppointCoordinateLongitude] string Координаты ПВЗ, долгота
order[delivery][data][extraData] array Дополнительные данные доставки (deliveryDataField.code => значение)
order[delivery][data][id] integer Идентификатор курьера
order[delivery][data][firstName] string Имя
order[delivery][data][email] string E-mail
order[delivery][data][phone] object (CourierPhone) Телефон курьера
order[delivery][data][phone][number] string Номер телефона
order[delivery][data][courierId] integer Идентификатор курьера
order[delivery][data][statusCode] string deprecated Код статуса доставки+
order[delivery][data][serviceType] string Технология доставки
order[delivery][data][pickuppoint] string Пункт самовывозаНазвание пункта самовывоза
order[delivery][data][statusName] string Наименование статуса доставки
order[delivery][data][price] float Стоимость доставки, полученная из службы доставки
order[delivery][data][receiverCity] string Название города доставкиГород доставки
order[delivery][data][receiverCityRef] string Идентификатор города доставки в NewPostИдентификатор города доставки
order[delivery][data][receiverStreet] string Название улицы доставки
order[delivery][data][receiverStreetRef] string Идентификатор улицы доставки в NewPost
order[delivery][data][seatsAmount] integer Количество мест отправления
order[delivery][data][cargoDescription] string Описание груза
order[delivery][data][paymentForm] string Форма оплаты за доставку
order[delivery][data][packageNumber] string Номер упаковки
order[delivery][data][deliveryDate] string Дата когда получатель забрал товар
order[delivery][data][denieReason] string Причина отказа
order[delivery][data][declaredValue] float Объявленная стоимость (в валюте объекта)
order[delivery][data][sendDate] DateTime Дата отправки
order[delivery][data][deliveryType] string Идентификатор способа доставки
order[delivery][data][deliveryName] string Название службы доставки
order[delivery][data][pickupType] integer Тип забора
order[delivery][data][pickuppointDescription] string Описание пункта самовывоза
order[delivery][data][placesCount] integer Количество мест
order[delivery][data][services][] array of strings Дополнительные услуги доставки
order[delivery][data][comment] string Комментарий к заказу
order[delivery][service] object (SerializedDeliveryService)
order[delivery][service][name] string Название
order[delivery][service][code] string Символьный код
order[delivery][service][active] boolean Статус активности
order[delivery][cost] double Стоимость доставки
order[delivery][netCost] double Себестоимость доставки
order[delivery][date] DateTime Дата доставки
order[delivery][time] object (TimeInterval) Информация о временном диапазоне
order[delivery][time][from] DateTime Время "с"
order[delivery][time][to] DateTime Время "до"
order[delivery][time][custom] string Временной диапазон в свободной форме
order[delivery][address] object (OrderDeliveryAddress) Адрес доставки
order[delivery][address][index] string Индекс
order[delivery][address][countryIso] string ISO код страны
order[delivery][address][region] string Регион
order[delivery][address][regionId] integer Идентификатор региона в Geohelper
order[delivery][address][city] string Город
order[delivery][address][cityId] integer Идентификатор города в Geohelper
order[delivery][address][cityType] string Тип населенного пункта
order[delivery][address][street] string Улица
order[delivery][address][streetId] integer Идентификатор улицы в Geohelper
order[delivery][address][streetType] string Тип улицы
order[delivery][address][building] string Дом
order[delivery][address][flat] string Номер квартиры/офиса
order[delivery][address][floor] integer Этаж
order[delivery][address][block] integer Подъезд
order[delivery][address][house] string Строение
order[delivery][address][housing] string Корпус
order[delivery][address][metro] string Метро
order[delivery][address][notes] string Примечания к адресу
order[delivery][address][text] string Адрес в текстовом виде
order[delivery][vatRate] string Ставка НДС
order[site] string Магазин
order[status] string Статус заказа
order[statusComment] string Комментарий к последнему изменению статуса
order[source] object (SerializedSource) Источник заказа
order[source][source] string Источник
order[source][medium] string Канал
order[source][campaign] string Кампания
order[source][keyword] string Ключевое слово
order[source][content] string Содержание кампании
order[items][] array of objects (OrderProduct) Позиция в заказе
order[items][][discount] float deprecated Денежная скидка на единицу товара
order[items][][discountPercent] float deprecated Процентная скидка на единицу товара
order[items][][markingCodes][] array of strings Коды маркировки
order[items][][id] integer ID позиции в заказе
order[items][][priceType] object (PriceType) Тип цены
order[items][][priceType][code] string Код типа цены
order[items][][initialPrice] double Цена товара/SKU (в валюте объекта)
order[items][][prices][] array of objects (OrderProductPriceItem) Набор итоговых цен реализации с указанием количества
order[items][][prices][][price] float Итоговая цена c учетом всех скидок на товар и заказ (в валюте объекта)
order[items][][prices][][quantity] float Количество товара по заданной цене
order[items][][vatRate] string Ставка НДС
order[items][][createdAt] DateTime Дата создания позиции в системе
order[items][][quantity] float Количество
order[items][][status] string Статус позиции в заказе
order[items][][comment] string Комментарий к позиции в заказе
order[items][][offer] object (Offer) Торговое предложение
order[items][][offer][displayName] string Название SKU
order[items][][offer][id] integer ID торгового предложения
order[items][][offer][externalId] string ID торгового предложения в магазине
order[items][][offer][xmlId] string ID торгового предложения в складской системе
order[items][][offer][name] string Название
order[items][][offer][article] string Артикул
order[items][][offer][vatRate] string Ставка НДС
order[items][][offer][properties] array Свойства SKU
order[items][][isCanceled] boolean Данная позиция в заказе является отменной
order[items][][properties] array [массив] Дополнительные свойства позиции в заказе
order[items][][purchasePrice] double Закупочная цена (в базовой валюте)
order[items][][ordering] integer Порядок
order[fullPaidAt] DateTime Дата полной оплаты
order[fromApi] boolean Заказ поступил через API
order[shipmentStore] string Склад отгрузки
order[shipmentDate] DateTime Дата отгрузки
order[shipped] boolean Заказ отгружен
order[customFields] array Ассоциативный массив пользовательских полей
order[clientId] string Метка клиента Google Analytics
state string Состояние заказа (по умолчанию не возвращается)

Статусы ответа

Код статуса ответаОписание
200
  • Заказ успешно изменен
400
  • Ошибка при изменении заказа

Комплектация заказов

GET /api/v4/orders/packs Получение списка паков, удовлетворяющих заданному фильтру

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

Для доступа к методу необходимо разрешение order_read.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (OrderProductPackFilter)
filter[ids]array of integers Массив ID комплектаций заказов
filter[stores][]array of strings Склад
filter[itemId]integer{range: {>=0}} ID товара
filter[offerXmlId]string{length: {max: 255}} Xml ID торгового предложения
filter[offerExternalId]string{length: {max: 255}} Внешний ID торгового предложения
filter[orderId]integer{range: {>=0}} ID заказа
filter[orderExternalId]string{length: {max: 255}} Внешний ID заказа
filter[shipmentDateFrom]DateTimeInterface Дата отгрузки от
filter[shipmentDateTo]DateTimeInterface Дата отгрузки до
filter[invoiceNumber]string{length: {max: 255}} Номер счета-фактуры
filter[deliveryNoteNumber]string{length: {max: 255}} Номер накладной

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
packs[] array of objects (OrderProductPack) Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
packs[][id] integer ID
packs[][purchasePrice] float Закупочная цена (в базовой валюте)
packs[][quantity] float Количество товара в упаковке
packs[][store] string Склад
packs[][item] object (OrderProduct) Позиция в заказе
packs[][item][id] integer ID позиции в заказе
packs[][item][order] object (Order) Заказ
packs[][item][order][id] integer ID заказа
packs[][item][offer] object (Offer) Торговое предложение
packs[][item][offer][externalId] string ID торгового предложения в магазине
packs[][item][offer][xmlId] string ID торгового предложения в складской системе
packs[][shipmentDate] DateTime Дата забора пака
packs[][invoiceNumber] string Номер счет-фактуры
packs[][deliveryNoteNumber] string Номер товарной накладной

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/orders/packs/create Создание пака

Создание пака

Для доступа к методу необходимо разрешение order_write.

Метод создает пак и возвращает внутренний ID созданного пака. Создание пака для отменённой товарной позиции и услуги не разрешено. В этом случае будет выведено сообщение об ошибке.

Параметры

ПараметрТипФорматОписание
packobject (SerializedOrderProductPack)
pack[purchasePrice]float Закупочная цена (в базовой валюте)
pack[quantity]float Количество товара в упаковке
pack[store]string Склад
pack[shipmentDate]DateTime Дата забора пака
pack[invoiceNumber]string Номер счет-фактуры
pack[deliveryNoteNumber]string Номер товарной накладной
pack[itemId]integer ID позиции в заказе

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
id integer ID пака

Статусы ответа

Код статуса ответаОписание
201
  • Пак успешно создан
400
  • Ошибка при создании пака

GET /api/v4/orders/packs/history Получение истории комплектации заказа

Получение истории комплектации заказа

Для доступа к методу необходимо разрешение order_read.

Результат возвращается постранично. В поле pagination содержится информация о постраничной разбивке.

Более подробно о работе с историей вы можете ознакомиться в отдельной статье документации.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (OrderProductPackHistoryFilterType)
filter[orderId]integer{range: {>=0}} Внутренний идентификатор заказа
filter[sinceId]integer{range: {>=0}} Нижнее ограничение по идентификатору записи в истории (исключая границу)
filter[orderExternalId]string{length: {max: 255}} Идентификатор заказа из магазина
filter[startDate]DateTimeY-m-d H:i:s Время изменения (с)
filter[endDate]DateTimeY-m-d H:i:s Время изменения (до)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
generatedAt DateTime Время формирования ответа
history[] array of objects (OrderProductPackHistory) Набор изменений в истории комплектации
history[][id] integer Внутренний идентификатор записи в истории
history[][createdAt] DateTime Дата внесения изменения
history[][created] boolean Флаг выводится для создания нового пакета товаров
history[][deleted] boolean Флаг выводится при удалении пакета товаров
history[][field] string Имя изменившегося поля
history[][oldValue] object (HistoryField) Старое значение
history[][newValue] object (HistoryField) Новое значение
history[][pack] object (OrderProductPack) Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
history[][pack][id] integer ID
history[][pack][purchasePrice] float Закупочная цена (в базовой валюте)
history[][pack][quantity] float Количество товара в упаковке
history[][pack][store] object (Store) Склад
history[][pack][store][code] string Символьный код
history[][pack][item] object (OrderProduct) Позиция в заказе
history[][pack][item][id] integer ID позиции в заказе
history[][pack][item][order] object (Order) Заказ
history[][pack][item][order][id] integer ID заказа
history[][pack][item][offer] object (Offer) Торговое предложение
history[][pack][item][offer][externalId] string ID торгового предложения в магазине
history[][pack][item][offer][xmlId] string ID торгового предложения в складской системе
history[][pack][shipmentDate] DateTime Дата забора пака
history[][pack][invoiceNumber] string Номер счет-фактуры
history[][pack][deliveryNoteNumber] string Номер товарной накладной
history[][source] string Источник изменения
history[][user] object (User)
history[][user][id] integer ID пользователя
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/orders/packs/{id} Получение информации о паке

Получение информации о паке

Для доступа к методу необходимо разрешение order_read.

Параметры

ПараметрТипФорматОписание
idinteger ID пака

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pack object (OrderProductPack) Пак - упаковка товаров, в рамках одной товарной позиции, с одного склада
pack[id] integer ID
pack[purchasePrice] float Закупочная цена (в базовой валюте)
pack[quantity] float Количество товара в упаковке
pack[store] string Склад
pack[item] object (OrderProduct) Позиция в заказе
pack[item][id] integer ID позиции в заказе
pack[item][order] object (Order) Заказ
pack[item][order][id] integer ID заказа
pack[item][offer] object (Offer) Торговое предложение
pack[item][offer][externalId] string ID торгового предложения в магазине
pack[item][offer][xmlId] string ID торгового предложения в складской системе
pack[shipmentDate] DateTime Дата забора пака
pack[invoiceNumber] string Номер счет-фактуры
pack[deliveryNoteNumber] string Номер товарной накладной

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
404
  • Пак не найден

POST /api/v4/orders/packs/{id}/delete Удаление пака

Удаление пака

Для доступа к методу необходимо разрешение order_write.

Удаление пака для отгруженного заказ недоступно.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Пак успешно удалён
400
  • Ошибка при удалении пака

POST /api/v4/orders/packs/{id}/edit Редактирование пака

Редактирование пака

Для доступа к методу необходимо разрешение order_write.

Для отгруженного заказа:

Параметры

ПараметрТипФорматОписание
packobject (SerializedOrderProductPack)
pack[purchasePrice]float Закупочная цена (в базовой валюте)
pack[quantity]float Количество товара в упаковке
pack[shipmentDate]DateTime Дата забора пака
pack[invoiceNumber]string Номер счет-фактуры
pack[deliveryNoteNumber]string Номер товарной накладной

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
id integer ID пака

Статусы ответа

Код статуса ответаОписание
200
  • Пак успешно изменён
400
  • Ошибка при изменении пака

Справочники

GET /api/v4/reference/countries Получение списка кодов доступных стран

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

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
countriesIso[] array of strings Список ISO 3166-1 alpha-2 кодов активных стран

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/delivery-services Получение списка служб доставки

Получение списка служб доставки

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
deliveryServices[] array of objects (DeliveryService) Служба доставки
deliveryServices[][name] string Название
deliveryServices[][code] string Символьный код
deliveryServices[][active] boolean Статус активности

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/delivery-services/{code}/edit Создание/редактирование службы доставки

Создание/редактирование службы доставки

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
deliveryServiceobject (SerializedDeliveryService)
deliveryService[code]string{not blank} Символьный код
deliveryService[name]string{not blank} Название
deliveryService[deliveryType]string Тип доставки
deliveryService[active]boolean Статус активности

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Служба доставки успешно изменена
201
  • Новая служба доставки успешно создана
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/delivery-types Получение списка типов доставки

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

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
deliveryTypes[] array of objects (DeliveryType) Тип доставки
deliveryTypes[][paymentTypes] array deprecated Разрешенные типы оплат. Используйте deliveryPaymentTypes
deliveryTypes[][isDynamicCostCalculation] boolean Динамический тип расчета стоимости доставки
deliveryTypes[][isAutoCostCalculation] boolean Стоимости доставки расчитывается автоматически службой доставки
deliveryTypes[][isAutoNetCostCalculation] boolean Себестоимости доставки расчитывается автоматически службой доставки
deliveryTypes[][isCostDependsOnRegionAndWeightAndSum] boolean Стоимость доставки зависит от региона, веса и суммы заказа
deliveryTypes[][isCostDependsOnDateTime] boolean Стоимость доставки зависит от времени и дня недели
deliveryTypes[][currency] string Валюта
deliveryTypes[][name] string Название
deliveryTypes[][code] string Символьный код
deliveryTypes[][active] boolean Статус активности
deliveryTypes[][defaultCost] double Стоимость по умолчанию (в валюте объекта)
deliveryTypes[][defaultNetCost] double Себестоимость по умолчанию (в валюте объекта)
deliveryTypes[][description] string Комментарий
deliveryTypes[][deliveryPaymentTypes][] array of objects (DeliveryTypePaymentType) Разрешенные типы оплат
deliveryTypes[][deliveryPaymentTypes][][code] string Символьный код
deliveryTypes[][deliveryPaymentTypes][][cod] boolean Оплата наложенным платежом
deliveryTypes[][integrationCode] string Код интеграционного модуля
deliveryTypes[][deliveryServices] array Службы доставок, которые входят в данный тип доставки
deliveryTypes[][defaultForCrm] boolean Устанавливается по умолчанию для заказов, создаваемых в системе
deliveryTypes[][vatRate] string Ставка НДС
deliveryTypes[][sites] array Магазины, в которых доступен данный тип доставки. Если пустой массив, то доступен во всех

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/delivery-types/{code}/edit Создание/редактирование типа доставки

Создание/редактирование типа доставки

Для доступа к методу необходимо разрешение reference_write.

Для нового типа доставки необходимо указать название name и символьный код code. Символьный код должен быть уникальным.

В поле integrationCode можно указывать код только той интеграционной службы доставки, которая активирована в системе. В противном случае будет выдано сообщение об ошибке.

Параметры

ПараметрТипФорматОписание
deliveryTypeobject (SerializedDeliveryType)
deliveryType[name]string{not blank}{length: {max: 255}}} Название
deliveryType[code]string{length: {max: 255}} Символьный код
deliveryType[defaultCost]double{not blank}{range: {>=0}}} Стоимость по умолчанию (в валюте объекта)
deliveryType[defaultNetCost]double{not blank}{range: {>=0}}} Себестоимость по умолчанию (в валюте объекта)
deliveryType[sites]array Массив символьных кодов магазинов, в которых доступен тип доставки
deliveryType[integrationModule]string
deliveryType[regionWeightCostConditions]string
deliveryType[vatRate]string Ставка НДС
deliveryType[defaultTariffName]string Название тарифа по умолчанию
deliveryType[paymentTypes]arraydeprecated Разрешенные типы оплат. Используйте deliveryPaymentTypes
deliveryType[active]boolean Статус активности
deliveryType[description]string Комментарий
deliveryType[defaultForCrm]boolean Устанавливается по умолчанию для заказов, создаваемых в системе
deliveryType[integrationCode]string Код интеграционного модуля
deliveryType[deliveryServices]array Службы доставок, которые входят в данный тип доставки

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Тип доставки успешно изменен
201
  • Новый тип доставки успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/order-methods Получение списка способов оформления заказов

Получение списка способов оформления заказов

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
orderMethods[] array of objects (OrderMethod) Способ оформления заказа
orderMethods[][name] string Название
orderMethods[][code] string Символьный код
orderMethods[][active] boolean Статус активности
orderMethods[][defaultForCrm] boolean Устанавливается по умолчанию для заказов, создаваемых в системе
orderMethods[][defaultForApi] boolean Устанавливается по умолчанию для заказов, создаваемых через API

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/order-methods/{code}/edit Создание/редактирование способа оформления заказа

Создание/редактирование способа оформления заказа

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
orderMethodobject (SerializedOrderMethod)
orderMethod[name]string{not blank}{length: {max: 255}}} Название
orderMethod[code]string{length: {max: 255}} Символьный код
orderMethod[active]boolean Статус активности
orderMethod[defaultForCrm]boolean Устанавливается по умолчанию для заказов, создаваемых в системе
orderMethod[defaultForApi]boolean Устанавливается по умолчанию для заказов, создаваемых через API

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Способ оформления заказа успешно изменен
201
  • Новый способ оформления заказа успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/order-types Получение списка типов заказов

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

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
orderTypes[] array of objects (OrderType) Тип заказа
orderTypes[][name] string Название
orderTypes[][code] string Символьный код
orderTypes[][active] boolean Статус активности
orderTypes[][defaultForCrm] boolean Устанавливается по умолчанию для заказов, создаваемых в системе
orderTypes[][defaultForApi] boolean Устанавливается по умолчанию для заказов, создаваемых через API
orderTypes[][ordering] integer Порядок

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/order-types/{code}/edit Создание/редактирование типа заказа

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

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
orderTypeobject (SerializedOrderType)
orderType[name]string{not blank}{length: {max: 255}}} Название
orderType[code]string{length: {max: 255}} Символьный код
orderType[ordering]integer{not blank}{range: {>=0}}} Порядок
orderType[active]boolean Статус активности
orderType[defaultForCrm]boolean Устанавливается по умолчанию для заказов, создаваемых в системе
orderType[defaultForApi]boolean Устанавливается по умолчанию для заказов, создаваемых через API

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Тип заказа успешно изменен
201
  • Новый тип заказа успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/payment-statuses Получение списка статусов оплаты

Получение списка статусов оплаты

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
paymentStatuses[] array of objects (PaymentStatus) Статус оплаты
paymentStatuses[][name] string Название
paymentStatuses[][code] string Символьный код
paymentStatuses[][active] boolean Статус активности
paymentStatuses[][defaultForCrm] boolean Устанавливается по умолчанию для заказов, создаваемых в системе
paymentStatuses[][defaultForApi] boolean Устанавливается по умолчанию для заказов, создаваемых через API
paymentStatuses[][paymentComplete] boolean Признак того, что заказ оплачен
paymentStatuses[][ordering] integer Порядок
paymentStatuses[][description] string Комментарий
paymentStatuses[][paymentTypes] array Типы оплаты, где используется данный статус оплаты

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/payment-statuses/{code}/edit Создание/редактирование статусов оплаты

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

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
paymentStatusobject (SerializedPaymentStatus)
paymentStatus[name]string{not blank}{length: {max: 255}}} Название
paymentStatus[code]string{length: {max: 255}} Символьный код
paymentStatus[ordering]integer{not blank}{range: {>=0}}} Порядок
paymentStatus[active]boolean Статус активности
paymentStatus[defaultForCrm]boolean Устанавливается по умолчанию для заказов, создаваемых в системе
paymentStatus[defaultForApi]boolean Устанавливается по умолчанию для заказов, создаваемых через API
paymentStatus[paymentComplete]boolean Признак того, что заказ оплачен
paymentStatus[description]string Комментарий

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Статус оплаты успешно изменен
201
  • Новый статус оплаты успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/payment-types Получение списка типов оплаты

Получение списка типов оплаты

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
paymentTypes[] array of objects (PaymentType) Тип оплаты
paymentTypes[][name] string Название
paymentTypes[][code] string Символьный код
paymentTypes[][active] boolean Статус активности
paymentTypes[][defaultForCrm] boolean Устанавливается по умолчанию для заказов, создаваемых в системе
paymentTypes[][defaultForApi] boolean Устанавливается по умолчанию для заказов, создаваемых через API
paymentTypes[][description] string Комментарий
paymentTypes[][deliveryTypes] array Совместимые типы доставки
paymentTypes[][paymentStatuses] array Массив идентификаторов совместимых статусов оплаты
paymentTypes[][sites] array Магазины, в которых доступен данный тип оплаты. Если пустой массив, то доступен во всех

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/payment-types/{code}/edit Создание/редактирование типа оплаты

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

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
paymentTypeobject (SerializedPaymentType)
paymentType[name]string{not blank}{length: {max: 255}}} Название
paymentType[code]string{length: {max: 255}} Символьный код
paymentType[sites]array Массив символьных кодов магазинов, в которых доступен тип оплаты
paymentType[active]boolean Статус активности
paymentType[defaultForCrm]boolean Устанавливается по умолчанию для заказов, создаваемых в системе
paymentType[defaultForApi]boolean Устанавливается по умолчанию для заказов, создаваемых через API
paymentType[description]string Комментарий
paymentType[paymentStatuses]array Массив идентификаторов совместимых статусов оплаты

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Тип оплаты успешно изменен
201
  • Новый тип оплаты успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/price-types Получение списка типов цен

Получение списка типов цен

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
priceTypes[] array of objects (PriceType) Тип цены
priceTypes[][id] integer ID типа цены
priceTypes[][code] string Символьный код
priceTypes[][name] string Название
priceTypes[][active] boolean Активность
priceTypes[][promo] boolean Акционная цена
priceTypes[][default] boolean Флаг базового типа цен
priceTypes[][description] string Описание
priceTypes[][filterExpression] string Фильтр
priceTypes[][geo][] array of objects (GeoHierarchyRow) Региональные ограничения
priceTypes[][geo][][country] string Код страны ISO
priceTypes[][geo][][regionId] string Идентификатор региона в Geohelper
priceTypes[][geo][][region] string Наименование региона
priceTypes[][geo][][cityId] string Идентификатор города в Geohelper
priceTypes[][geo][][city] string Наименование города
priceTypes[][groups] array Группы пользователей
priceTypes[][ordering] integer Порядок
priceTypes[][currency] string Валюта

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/price-types/{code}/edit Создание/редактирование типа цены

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

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
priceTypeobject (SerializedPriceType)
priceType[code]string Символьный код
priceType[name]string Название
priceType[active]boolean Активность
priceType[promo]boolean Акционная цена
priceType[description]string Описание
priceType[filterExpression]string Фильтр
priceType[ordering]integer Порядок
priceType[geo][]array of objects (GeoHierarchyRow) Региональные ограничения
priceType[geo][][country]string Код страны ISO
priceType[geo][][regionId]string Идентификатор региона в Geohelper
priceType[geo][][cityId]string Идентификатор города в Geohelper
priceType[groups]array Группы пользователей
priceType[currency]string Валюта

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Данные склада успешно изменены
201
  • Новый склад успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/product-statuses Получение списка статусов товаров в заказе

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

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
productStatuses[] array of objects (OrderProductStatus) Статус товара в заказе
productStatuses[][code] string Символьный код
productStatuses[][ordering] integer Порядок
productStatuses[][active] boolean Статус активности
productStatuses[][createdAt] DateTime Дата создания
productStatuses[][orderStatusByProductStatus] string Статус заказа, который выставляется, если у всех товаров данный статус товара
productStatuses[][orderStatusForProductStatus] string Статус заказа, при котором статус товаров меняется на данный статус товара
productStatuses[][cancelStatus] boolean Является статусом отмены
productStatuses[][name] string Название

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/product-statuses/{code}/edit Создание/редактирование статуса товара в заказе

Создание/редактирование статуса товара в заказе

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
productStatusobject (SerializedOrderProductStatus)
productStatus[name]string{not blank}{length: {max: 255}}} Название
productStatus[code]string Символьный код
productStatus[type]choice[product-status-type-cancel] Тип
productStatus[ordering]integer Порядок
productStatus[active]boolean Статус активности
productStatus[cancelStatus]boolean Является статусом отмены
productStatus[orderStatusByProductStatus]string Статус заказа, который выставляется, если у всех товаров данный статус товара
productStatus[orderStatusForProductStatus]string Статус заказа, при котором статус товаров меняется на данный статус товара

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Статус товара успешно изменен
201
  • Новый статус товара успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/sites Получение списка магазинов

Получение списка магазинов

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
sites[] array of objects (Site) Магазин
sites[][catalogId] string ID каталога
sites[][isCatalogMainSite] boolean Основной магазин каталога
sites[][name] string Название
sites[][url] string URL магазина
sites[][code] string Символьный код магазина
sites[][description] string Комментарий
sites[][phones] string Телефоны магазина
sites[][address] string Адрес магазина
sites[][zip] string Почтовый индекс
sites[][defaultForCrm] boolean Устанавливается по умолчанию для заказов, создаваемых в системе
sites[][ymlUrl] string Адрес расположения YML
sites[][loadFromYml] boolean Загружать ли каталог данного магазина из YML/ICML или нет
sites[][catalogUpdatedAt] DateTime Дата/время последней успешной загрузки YML/ICML
sites[][catalogLoadingAt] DateTime Дата/время последней загрузки YML/ICML
sites[][contragent] object (LegalEntity) Юридическое лицо
sites[][contragent][contragentType] string Тип юридического лица
sites[][contragent][legalName] string Полное наименование
sites[][contragent][legalAddress] string Адрес регистрации
sites[][contragent][INN] string ИНН
sites[][contragent][OKPO] string ОКПО
sites[][contragent][KPP] string КПП
sites[][contragent][OGRN] string ОГРН
sites[][contragent][OGRNIP] string ОГРНИП
sites[][contragent][certificateNumber] string Номер свидетельства
sites[][contragent][certificateDate] DateTime Дата свидетельства
sites[][contragent][BIK] string БИК
sites[][contragent][bank] string Банк
sites[][contragent][bankAddress] string Адрес банка
sites[][contragent][corrAccount] string Корр. счёт
sites[][contragent][bankAccount] string Расчётный счёт
sites[][contragent][code] string Символьный код
sites[][contragent][countryIso] string Страна
sites[][contragent][vatRate] string Ставка НДС
sites[][countryIso] string ISO код страны

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/sites/{code}/edit Создание/редактирование магазина

Создание/редактирование магазина

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
siteobject (SerializedSite)
site[name]string{not blank}{length: {max: 255}}} Название
site[url]string{url}{length: {max: 255}}} URL магазина
site[code]string{length: {max: 255}} Символьный код магазина
site[description]string{length: {max: 3000}} Комментарий
site[phones]string{length: {max: 255}} Телефоны магазина
site[address]string{length: {max: 255}} Адрес магазина
site[zip]string{length: {max: 255}} Почтовый индекс
site[ymlUrl]string{length: {max: 1000}} Адрес расположения YML
site[defaultForCrm]boolean Устанавливается по умолчанию для заказов, создаваемых в системе
site[loadFromYml]boolean Загружать ли каталог данного магазина из YML/ICML или нет
site[countryIso]string ISO код страны

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Магазин успешно изменен
201
  • Новый магазин успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/status-groups Получение списка групп статусов заказа

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

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
statusGroups[] array of objects (StatusGroup) Группа статусов
statusGroups[][name] string Название
statusGroups[][code] string Символьный код
statusGroups[][active] boolean Статус активности
statusGroups[][ordering] integer Порядок
statusGroups[][process] boolean Является или нет процессным состоянием заказа
statusGroups[][statuses] array Статусы заказов, которые входят в данную группу

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/statuses Получение списка статусов заказа

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

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
statuses[] array of objects (Status) Статус заказа
statuses[][name] string Название
statuses[][code] string Символьный код
statuses[][active] boolean Статус активности
statuses[][ordering] integer Порядок
statuses[][group] string Группа статусов, к которой относится статус

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/statuses/{code}/edit Создание/редактирование статуса заказа

Создание/редактирование статуса заказа

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
statusobject (SerializedStatus)
status[name]string{not blank}{length: {max: 255}}} Название
status[code]string{length: {max: 255}} Символьный код
status[ordering]integer{not blank}{range: {>=0}}} Порядок
status[group]string{not blank} Группа статусов, к которой относится статус
status[active]boolean Статус активности

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Статус заказа успешно изменен
201
  • Новый статус заказа успешно создан
400
  • Ошибка при выполнении запроса

GET /api/v4/reference/stores Получение списка складов

Получение списка складов

Для доступа к методу необходимо разрешение reference_read.

Ответ

ПараметрТипОписание
stores[] array of objects (Store) Склад
stores[][externalId] string Внешний ID
stores[][xmlId] string Идентификатор 1С
stores[][description] string Описание склада
stores[][email] string Email склада
stores[][type] string Тип склада
stores[][inventoryType] string Вид остатков на складе
stores[][address] object (StoreAddress) Адрес склада
stores[][address][index] string Индекс
stores[][address][countryIso] string ISO код страны
stores[][address][region] string Регион
stores[][address][regionId] integer Идентификатор региона в Geohelper
stores[][address][city] string Город
stores[][address][cityId] integer Идентификатор города в Geohelper
stores[][address][cityType] string Тип населенного пункта
stores[][address][street] string Улица
stores[][address][streetId] integer Идентификатор улицы в Geohelper
stores[][address][streetType] string Тип улицы
stores[][address][building] string Дом
stores[][address][flat] string Номер квартиры/офиса
stores[][address][floor] integer Этаж
stores[][address][block] integer Подъезд
stores[][address][house] string Строение
stores[][address][housing] string Корпус
stores[][address][metro] string Метро
stores[][address][notes] string Примечания к адресу
stores[][address][text] string Адрес в текстовом виде
stores[][ordering] string Порядок
stores[][phone] object (StorePhone) Телефон склада
stores[][phone][number] string Номер телефона
stores[][contact] string Контактное лицо на складе
stores[][code] string Символьный код
stores[][name] string Название

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/reference/stores/{code}/edit Создание/редактирование сведений о складе

Создание/редактирование сведений о складе

Для доступа к методу необходимо разрешение reference_write.

Параметры

ПараметрТипФорматОписание
storeobject (SerializedStore)
store[name]string{not blank}{length: {max: 255}}} Название
store[email]string{length: {max: 255}} Email склада
store[type]string[store-type-online|store-type-retail|store-type-supplier|store-type-warehouse] Тип склада
store[inventoryType]string[available|integer] Вид остатков на складе
store[address]object (StoreAddress) Адрес склада
store[address][index]string Индекс
store[address][countryIso]string ISO код страны
store[address][region]string Регион
store[address][regionId]integer Идентификатор региона в Geohelper
store[address][city]string Город
store[address][cityId]integer Идентификатор города в Geohelper
store[address][cityType]string Тип населенного пункта
store[address][street]string Улица
store[address][streetId]integer Идентификатор улицы в Geohelper
store[address][streetType]string Тип улицы
store[address][building]string Дом
store[address][flat]string Номер квартиры/офиса
store[address][floor]integer Этаж
store[address][block]integer Подъезд
store[address][house]string Строение
store[address][housing]string Корпус
store[address][metro]string Метро
store[address][notes]string Примечания к адресу
store[address][text]string Адрес в текстовом виде
store[phone]object (StorePhone) Телефон склада
store[phone][number]string Номер телефона
store[externalId]string Внешний ID
store[xmlId]string Идентификатор 1С
store[description]string Описание склада
store[code]string Символьный код

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Данные склада успешно изменены
201
  • Новый склад успешно создан
400
  • Ошибка при выполнении запроса

Склад

GET /api/v4/store/inventories Получение остатков и закупочных цен

Получение остатков и закупочных цен

Для доступа к методу необходимо разрешение store_read.

Метод позволяет получать информацию об остатках и закупочных ценах для торговых предложений. При указании параметра filter[details]=1 будет также возвращена детализация остатков и закупочных цен по складам. Данные возвращаются по магазинам, доступ к котором предоставлен используемому API-ключу, либо по конкретному магазину, если указан параметр filter[sites][]=site-code.

По умолчанию возвращается информация как по активным, так и неактивным товарам и торговым предложениям. Для получения информации только по активным используйте параметры filter[productActive]=1 и filter[offerActive]=1.

Поле offers[][site] возвращается в ответе только, если данные возвращаются по нескольким магазинам.

Параметры

ПараметрТипФорматОписание
limitchoice{not blank}[20|50|100|250]}
pagestring{not blank}{range: {>=1}}}
filterobject (InventoryAlternativeFilterData)
filter[ids][]array of integers Массив ID торговых предложений
filter[sites][]array of strings Магазины
filter[catalogs][]array of integers Массив ID каталогов
filter[productExternalId]string{length: {max: 255}} Внешний ID товара
filter[productArticle][]array of strings Массив артикулов товаров
filter[productActive]boolean Возвращать остатки только по активным товарам
filter[offerExternalId][]array of strings Массив внешних ID торговых предложений
filter[offerXmlId][]array of strings Массив XmlId торговых предложений
filter[offerArticle][]array of strings Массив артикулов торговых предложений
filter[offerActive]boolean Возвращать остатки только по активным торговым предложениям
filter[details]boolean Возвращать детализацию остатков по складам

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
offers[] array of objects (Offer) Торговое предложение (SKU)
offers[][id] integer ID торгового предложения
offers[][externalId] string ID торгового предложения в магазине
offers[][xmlId] string ID торгового предложения в складской системе
offers[][site] string deprecated Магазин. Используйте getCatalog()
offers[][purchasePrice] double Закупочная цена SKU (в базовой валюте)
offers[][quantity] float Доступное количество
offers[][stores][] array of objects (Inventory) Остатки по складам
offers[][stores][][quantity] float Количество
offers[][stores][][purchasePrice] double Закупочная цена (в базовой валюте)
offers[][stores][][store] string Склад

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/store/inventories/upload Обновление остатков и закупочных цен

Обновление остатков и закупочных цен

Для доступа к методу необходимо разрешение store_write.

Метод позволяет обновлять остатки и закупочные цены по складам для торговых предложений. За один запрос можно обновить до 250 торговых предложений. В одном торговом предложении можно указать остатки до 500 складов.

Поле offers[][stores][][available] может быть целочисленным или дробным. При использовании фактического учета остатков следует передавать 0 - в случае отсутствия товара на складе, и 1 - в случае наличия.

У каждого торгового предложения должен быть указан хотя бы один из трех параметров: id, xmlId или externalId. В случае указания нескольких или всех перечисленных параметров, поиск сначала осуществляется по полю id, затем по xmlId, а затем по externalId.

Если торговое предложение относится к услуге, то переданные данные будут проигнорированы.

Если c заданным xmlId найдено несколько товаров, остатки будут изменены у всех.

Параметры

ПараметрТипФорматОписание
offers[]array of objects (SerializedOffer)
offers[][id]integer ID торгового предложения
offers[][externalId]string ID торгового предложения в магазине
offers[][xmlId]string ID торгового предложения в складской системе
offers[][stores][]array of objects (SerializedStore)
offers[][stores][][code]string Символьный код
offers[][stores][][available]float Количество доступного товара или факт наличия
offers[][stores][][purchasePrice]float Закупочная цена
sitestring Символьный код магазина. Указывается в случае идентификации торговых предложений по externalId

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
processedOffersCount integer Количество успешно обработанных торговых предложений
notFoundOffers[] array of objects (Offer) Торговое предложение (SKU)
notFoundOffers[][id] integer ID торгового предложения
notFoundOffers[][externalId] string ID торгового предложения в магазине
notFoundOffers[][xmlId] string ID торгового предложения в складской системе

Статусы ответа

Код статуса ответаОписание
200
  • Остатки загружены
400
  • Ошибка при загрузке остатков либо текущие настройки системы не допускают редактирование остатков

POST /api/v4/store/prices/upload Обновление цен торговых предложений

Обновление цен торговых предложений

Для доступа к методу необходимо разрешение store_write.

За один запрос можно передавать суммарно до 250 цен.

Параметры

ПараметрТипФорматОписание
prices[]array of objects (PriceUploadInput)
prices[][externalId]string ID торгового предложения в магазине
prices[][xmlId]string ID торгового предложения в складской системе
prices[][id]integer ID торгового предложения
prices[][site]string Код магазина, необходим при передаче externalId торгового предложения
prices[][prices][]array of objects (PriceUploadPricesInput) Цена торгового предложения
prices[][prices][][code]string Код типа цены
prices[][prices][][price]float Цена
prices[][prices][][remove]boolean Удалить цену

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
processedOffersCount integer Количество успешно обработанных торговых предложений
notFoundOffers[] array of objects (PriceUploadNotFoundResponse) Список не обработанных торговых предложений
notFoundOffers[][id] string
notFoundOffers[][externalId] string ID не обработанного торгового предложения в магазине
notFoundOffers[][xmlId] string ID не обработанного торгового предложения в складской системе

Статусы ответа

Код статуса ответаОписание
200
  • Цены загружены
400
  • Ошибка при загрузке цен, либо массив слишком большой

GET /api/v4/store/products Получение списка товаров с торговыми предложениями, удовлетворяющих заданному фильтру

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

Для доступа к методу необходимо разрешение store_read.

Метод позволяет получать информацию о товарах и их торговых предложениях. Данные возвращаются по магазинам, доступ к которым предоставлен используемому API-ключу, либо по конкретному магазину, если указан параметр filter[sites][]=site-code.

При реализации постоянной трансляции изменений во внешнюю систему рекомендуется использовать подход с забором инкрементальных изменений через filter[sinceId] передавая id последнего полученного товара.

По умолчанию возвращается информация как по активным, так и неактивным товарам. Для получения информации только по активным используйте параметр filter[active]

Результат возвращается постранично. В поле pagination содержится информация о постраничной разбивке.

Фильтры filter[minPrice], filter[maxPrice] фильтруют по ценам торговых предложений, конвертированных в базовую валюту. Если же наряду с данными фильтрами указать фильтр по типу цены filter[priceType] (в который нужно передавать символьный код типа цены), то будет осуществляться фильтрация по ценам торговых предложений данного типа цены и в валюте данного типа цены.

Фильтр filter[properties][] позволяет получить товары по их свойствам. Фильтр необходимо задавать в формате filter[properties][property_code_1]=value_1&filter[properties][property_code_2]=value_2.

В фильтре filter[groups] указываются ID групп товаров.

Фильтр filter[classSegment] позволяет получить сегменты ABC/XYZ-анализа товаров. Доступны следующие значения: abc[0..2]_xyz[0..2].

Фильтры filter[offerIds][], filter[offerExternalId], filter[offerXmlId] позволяют получить товары, которым принадлежат торговые предложения с заданными id, externalId, xmlId соответственно.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (ProductFilterData)
filter[ids][]array of integers Массив ID товаров
filter[name]string{length: {max: 255}} Название/артикул товара либо артикул/штрихкод торгового предложения
filter[groups][]array of integers Группа товара
filter[sites][]array of strings Магазины
filter[catalogs][]array of integers Массив ID каталогов
filter[priceType]string Тип цены
filter[manufacturer]string{length: {max: 255}} Производитель
filter[externalId]string{length: {max: 255}} Внешний ID
filter[xmlId]string{length: {max: 255}} Xml ID
filter[url]string{length: {max: 2000}} URL
filter[urlLike]string{length: {max: 2000}} Частичное совпадение URL (игнорируя домен и query-параметры)
filter[classSegment]string{length: {max: 255}}{match: /^abc[0-2]_xyz[0-2]$/}} ABC/XYZ-сегмент
filter[active]boolean Активность
filter[popular]boolean Метка Лидер продаж
filter[stock]boolean Метка Лучшая цена
filter[novelty]boolean Метка Новинка
filter[recommended]boolean Метка Рекомендуем
filter[properties][]array Свойства товаров
filter[markable]boolean
filter[offerIds][]array of integers Массив ID торговых предложений
filter[offerExternalId]string{length: {max: 255}} Внешний ID торгового предложения
filter[offerXmlId]string{length: {max: 255}} XmlId торгового предложения
filter[groupExternalId]string{length: {max: 255}} Внешний ID товарной группы
filter[sinceUpdatedAt]DateTimeY-m-d H:i:s Нижнее ограничение по дате изменения товара (исключая границу)
filter[sinceId]custom handler result for (int){range: {>=0, <=2147483647}} Начиная с ID товара
filter[productType]custom handler result for (int)
filter[minPrice]integer Цена товара (от)
filter[maxPrice]integer Цена товара (до)
filter[minPurchasePrice]integer Закупочная цена товара (от)
filter[maxPurchasePrice]integer Закупочная цена товара (до)
filter[minQuantity]integer Количество товара (от)
filter[maxQuantity]integer Количество товара (до)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
products[] array of objects (Product) Товар
products[][minPrice] double deprecated Минимальная цена на товар (в базовой валюте)
products[][maxPrice] double deprecated Максимальная цена на товар (в базовой валюте)
products[][id] integer ID товара
products[][article] string Артикул
products[][name] string Название
products[][url] string Ссылка на страницу товара в магазине
products[][imageUrl] string Ссылка на изображение товара
products[][description] string Описание
products[][popular] boolean Метка Лидер продаж
products[][stock] boolean Метка Лучшая цена
products[][novelty] boolean Метка Новинка
products[][recommended] boolean Метка Рекомендуем
products[][externalId] string Внешний ID товара
products[][manufacturer] string Производитель
products[][offers][] array of objects (Offer) Торговые предложения
products[][offers][][name] string Название
products[][offers][][price] double deprecated Цена SKU
products[][offers][][id] integer ID торгового предложения
products[][offers][][externalId] string ID торгового предложения в магазине
products[][offers][][xmlId] string ID торгового предложения в складской системе
products[][offers][][article] string Артикул
products[][offers][][prices][] array of objects (OfferPrice) Доступные цены
products[][offers][][prices][][priceType] string Тип цены
products[][offers][][prices][][currency] string Валюта
products[][offers][][prices][][price] double Цена (в валюте объекта)
products[][offers][][prices][][ordering] integer Порядок
products[][offers][][purchasePrice] double Закупочная цена SKU (в базовой валюте)
products[][offers][][vatRate] string Ставка НДС
products[][offers][][properties] array Свойства SKU
products[][offers][][quantity] float Доступное количество
products[][offers][][weight] double Вес
products[][updatedAt] DateTime Дата редактирования товара в системе
products[][active] boolean Активность
products[][quantity] double Количество
products[][markable] boolean Подлежит маркировке

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/store/setting/{code} Получение конфигурации складской системы

Получение конфигурации складской системы

Для доступа к методу необходимо разрешение store_read.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
configuration object (ConfigurationApiV4)
configuration[actions][] array of objects (Action) Callback методы
configuration[actions][][code] string Символьный код
configuration[actions][][url] string Url метода
configuration[actions][][callPoints][] array of strings Точки вызова метода
configuration[code] string Символьный код
configuration[active] boolean Активность
configuration[name] string Название складской системы
configuration[baseUrl] string Базовый url для запросов
configuration[image] string Ссылка на svg логотип складской системы
configuration[accountUrl] string Ссылка на личный кабинет

Статусы ответа

Код статуса ответаОписание
200
  • Запрос на обновление успешно выполнен
404
  • Конфигурация не найдена

POST /api/v4/store/setting/{code}/edit Регистрация и конфигурация складской системы

Регистрация и конфигурация складской системы

Для доступа к методу необходимо разрешение store_write.

Параметры

ПараметрТипФорматОписание
configurationobject (ConfigurationApiV4)
configuration[actions][]array of objects (Action) Callback методы
configuration[actions][][code]string Символьный код
configuration[actions][][url]string Url метода
configuration[actions][][callPoints][]array of strings Точки вызова метода
configuration[clientId]string Идентификатор клиента в складской системе
configuration[code]string Символьный код
configuration[name]string Название складской системы
configuration[baseUrl]string Базовый url для запросов
configuration[image]string Ссылка на svg логотип складской системы
configuration[accountUrl]string Ссылка на личный кабинет

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Запрос на обновление успешно выполнен
201
  • Запрос на добавление успешно выполнен
400
  • Ошибка при загрузке конфигурации

CallbackPOST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["store"]["actions"]["inventoriesUpload"]} Обновление остатков и закупочных цен

Обновление остатков и закупочных цен

Метод позволяет обновлять остатки и закупочные цены по складам для торговых предложений. Для обновления остатков система инициирует POST запрос метода, указанного в integrationModule["integrations"]["store"]["actions"]["inventoriesUpload"]. Система передает перечень торговых предложений для которых необходимо передать информацию об остатках, в зависимости от контекста вызова метода. Торговые предложения, отсутствующие в запросе, будут игнорироваться в ответе. Точки вызова метода настраиваются в конфигурации в поле integrationModule["integrations"]["store"]["actions"]["inventoriesUpload"]["callPoints"].

У каждого торгового предложения должен быть указан хотя бы один из трех параметров: id, xmlId или externalId. В случае указания нескольких или всех перечисленных параметров, поиск сначала осуществляется по полю id, затем по xmlId, а затем по externalId.

Поле offers[][stores][][available] может быть целочисленным или дробным. При использовании фактического учета остатков следует передавать 0 - в случае отсутствия товара на складе, и 1 - в случае наличия.

В случае возникновения ошибки во внешнем ресурсе, к которому обращается callback-метод, данные по ошибке будут внесены в журнал действий (Настройки > Системные > Журнал действий).

Параметры

ПараметрТипФорматОписание
clientIdstring
offers[]array of objects (SerializedOffer)
offers[][id]integer ID торгового предложения
offers[][externalId]string ID торгового предложения в магазине
offers[][xmlId]string ID торгового предложения в складской системе
offers[][site]stringdeprecated Магазин. Используйте getCatalog()

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
errorMsg string Текст ошибки
offers[] array of objects (SerializedOffer)
offers[][id] integer ID торгового предложения
offers[][externalId] string ID торгового предложения в магазине
offers[][xmlId] string ID торгового предложения в складской системе
offers[][stores][] array of objects (SerializedStore)
offers[][stores][][code] string Символьный код
offers[][stores][][available] float Количество доступного товара или факт наличия
offers[][stores][][purchasePrice] float Закупочная цена
offers[][site] string deprecated Магазин. Используйте getCatalog()

Телефония

POST /api/v4/telephony/call/event События звонка

События звонка

Для доступа к методу необходимо разрешение telephony_write.

Метод фиксирует события вызова для пользователей c добавочным кодами codes и/или c ID userIds, c телефона phone. Поле codes содержит JSON массив добавочных кодов, поле userIds содержит JSON массив ID пользователей.

Если одновременно указаны оба поля codes и userIds, событие вызова будет зафиксировано для всех перечисленных пользователей.

Поле type содержит тип события: in - входящий вызов, out - исходящий вызов, hangup - завершение звонка.

В случае, если type равен ​hangup​, то в поле hangupStatus можно передать статус.

Поле hangupStatus содержит статус завершения звонка: answered - звонок принят, no answered - ответа на звонок не последовало, busy - вызывающая сторона получает сигнал "занято", cancel - звонок отменен, failed - ошибка. По умолчанию значение answered.

Поле campaign содержит рекламную кампанию в рамках которой идет звонок. Содержит JSON, с полями: name - название рекламной кампании и code - код рекламной кампании. В случае если данное поле заполнено, в окне о входящем звонке будет указываться информация о рекламной кампании.

Событие звонка может быть связано с магазином. Для этого необходио указать символьный код магазина в поле site, или внешний номер магазина в поле externalPhone. Если указаны оба поля, они будут обработаны в следующем порядке:

Параметры

ПараметрТипФорматОписание
eventobject (CallEvent)
event[phone]string{length: {max: 255}}{not blank}} Телефон
event[type]string{not blank}[hangup|in|out]} Тип события
event[codes][]array of strings Добавочные коды менеджеров
event[userIds][]array of integers Массив ID пользователей
event[site]string Символьный код магазина, связанного с событием звонка
event[hangupStatus]string[answered|busy|cancel|failed|no answered] Статус завершения звонка
event[externalPhone]string{length: {max: 255}} Внешний номер телефона
event[callExternalId]string{length: {max: 255}} External Id связанного c событием звонка
event[webAnalyticsData]object (SerializedWebAnalyticsData)
event[webAnalyticsData][campaign]object (SerializedCampaign) Рекламная кампания
event[webAnalyticsData][campaign][name]string Название рекламной кампании
event[webAnalyticsData][campaign][code]string Код рекламной кампании
event[webAnalyticsData][queryString]string Поисковый запрос

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
notExistCodes array Массив добавочных кодов, которые отсутствуют в системе
notExistUsers array Массив userId, которые отсутствуют в системе

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/telephony/calls/upload Загрузка телефонных звонков

Загрузка телефонных звонков

Для доступа к методу необходимо разрешение telephony_write.

Метод позволяет сохранять историю звонков. За один запрос можно отправить до 50 звонков.

Поле calls содержит JSON массив.

Поле calls[][date], содержит дату время звонка в формате Y-m-d H:i:s.

Поле calls[][type], может принимать следующие значения: in - входящий звонок, out - исходящий звонок.

Поле calls[][result], может принимать следующие значения: failed - ошибка , answered - принят , busy - занято, no answer - не отвечено, not allowed - запрещен , unknown - неизвестно

Поле calls[][externalId] уникальный идентификатор звонка в АТС, если передать уже существующее значение звонок не будет создан.

Поле calls[][recordUrl] ссылка на запись звонка, например http://example.com/record.mp3. Поддерживаются записи в формате .wav, .mp3

Для сохранения звонка необходимо, чтобы было заполнено поле calls[][userId] или calls[][code].

Поле calls[][userId] содержит ID пользователя, который обрабатывал звонок

Поле calls[][code] содержит внутренний номер пользователя, который обрабатывал звонок.

Поле Длительность звонкаcalls[][duration] должна быть больше, чем Время ожидания ответа оператораcalls[][durationWaiting]. Если поле calls[][duration] не передано, в интерфейсе не будет отображаться плеер прослушивания записи звонка.

Если заданы оба поля, они будут обработаны в следующем порядке:

Звонок может быть связан с магазином. Для этого необходимо указать символьный код магазина в поле calls[][site], или внешний номер магазина в поле calls[][externalPhone]. Если указаны оба поля, они будут обработаны в следующем порядке:

Параметры

ПараметрТипФорматОписание
calls[]array of objects (Call) Звонок
calls[][date]DateTime{not blank} Дата/время звонка
calls[][type]string[in|out], {not blank} Тип звонка
calls[][phone]string{not blank}{length: {max: 255}}} Номер телефона
calls[][code]string{length: {max: 255}} Внутренний номер пользователя, который обрабатывал звонок
calls[][userId]integer{range: {>=1, <=2147483647}} Id пользователя, который обрабатывал звонок
calls[][result]string[answered|busy|failed|no answer|not allowed|unknown], {not blank} Результат звонка
calls[][duration]integer{range: {>=0, <=1000000000}} Длительность звонка (в секундах)
calls[][durationWaiting]integer{range: {>=0, <=1000000000}} Время ожидания ответа оператора (в секундах)
calls[][externalId]string{not blank}{length: {max: 255}}} ID звонка в АТС
calls[][recordUrl]string{length: {max: 2048}} Ссылка на запись звонка
calls[][source]object (SerializedSource) Источник
calls[][source][source]string Источник (строка)
calls[][source][medium]string Канал
calls[][source][campaign]string Кампания
calls[][source][keyword]string Ключевое слово
calls[][source][content]string Содержание кампании
calls[][externalPhone]string{length: {max: 255}} Внешний номер телефона
calls[][site]string Магазин
calls[][clientId]string Метка клиента Google Analytics

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
processedCallsCount integer Количество успешно обработанных звонков
duplicateCalls array Массив externalId, которые уже присутствуют в системе

Статусы ответа

Код статуса ответаОписание
200
  • Звонки успешно загружены
400
  • Ошибка при выполнении запроса

GET /api/v4/telephony/manager Получение ответственного менеджера

Получение ответственного менеджера

Для доступа к методу необходимо разрешение telephony_read.

Метод возвращает ответственного менеджера, для клиента с телефоном phone, который в данный момент Онлайн в системе и в статусе Свободен. Менеджер не будет возвращен, если для него не задан добавочный код в системе.

Если ответственный менеджер не найден, поле manager в ответе будет отсутствовать.

Если поле ignoreStatus равно 1, в ответе будет присутствовать поле manager независимо от нахождения ответственного менеджера Онлайн в системе и в статусе Свободен.

Если поле details равно 1, в ответе будут присутствовать поля links, customer. В противном случае, поля будут отсутствовать.

Если клиент найден, поля links[newCustomerLink], links[newOrderLink] в ответе будет отсутствовать.

Если клиент не найден, поля customer, links[lastOrderLink], links[customerLink] в ответе будет отсутствовать.

Параметры

ПараметрТипФорматОписание
phonestring{not blank}{length: {max: 255}}} Телефон
detailsstring[0|1] Детальная информация
ignoreStatusstring[0|1] Игнорировать статус менеджера

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
manager object (SerializedManager) Менеджер
manager[id] string Id менеджера
manager[firstName] string Имя менеджера
manager[lastName] string Фамилия менеджера
manager[patronymic] string Отчество менеджера
manager[email] string Электронный адрес
manager[code] string Добавочный код менеджера в телефонии
customer object (SerializedCustomer) Клиент
customer[id] string Id клиента
customer[externalId] string Идентификатор с внешнего сайта
customer[firstName] string Имя клиента
customer[lastName] string Фамилия клиента
customer[patronymic] string Отчество клиента
customer[email] string Электронный адрес
customer[phones][] array of objects (CustomerPhone) Телефоны клиента
customer[phones][][number] string Номер телефона
links object (SerializedLinks) Ссылки
links[newOrderLink] string Ссылка на страницу создания нового заказа
links[lastOrderLink] string Ссылка на страницу последнего заказа
links[newCustomerLink] string Ссылка на страницу создания нового клиента
links[customerLink] string Ссылка на страницу клиента

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/telephony/setting/{code} Получение настроек телефонии

Получение настроек телефонии

Для доступа к методу необходимо разрешение telephony_read.

Метод позволяет получить информацию о телефонии.

Параметры

ПараметрТипФорматОписание
codestring{not blank}{length: {max: 255}}} Символьный код

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
configuration object (ConfigurationApiV4)
configuration[makeCallUrl] string Адрес инициации звонка
configuration[allowEdit] boolean Разрешить редактировать из интерфейса системы
configuration[inputEventSupported] boolean Поддерживает оповещения о входящем звонке
configuration[outputEventSupported] boolean Поддерживает оповещения о исходящем звонке
configuration[hangupEventSupported] boolean Поддерживает оповещения о завершении звонке
configuration[changeUserStatusUrl] string Уведомлять по этому адресу при смене сатуса менеджера в системе
configuration[additionalCodes][] array of objects (SerializedAdditionalCodes) Добавочные коды пользователей
configuration[additionalCodes][][userId] integer Id пользователя
configuration[additionalCodes][][code] string Добавочный код в телефонии
configuration[externalPhones][] array of objects (SerializedExternalPhones) Внешние номера
configuration[externalPhones][][siteCode] string Код магазина
configuration[externalPhones][][externalPhone] string Внешний номер
configuration[code] string Символьный код
configuration[active] boolean Активность телефонии
configuration[name] string Название сервиса
configuration[image] string Логотип сервиса
configuration[personalAccountUrl] string Адрес входа в личный кабинет телефонии

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

POST /api/v4/telephony/setting/{code}/edit Создание/редактирование телефонии

Создание/редактирование телефонии

Для доступа к методу необходимо разрешение telephony_write.

Метод позволяет создать/активировать/деактивировать телефонию в системе и задать необходимые настройки для работы.

Поле makeCallUrl содержит адрес по которому система будет отправлять запрос для инициации звонка. При попытке позвонить будет отправлен GET запрос по адресу makeCallUrl.

Поле name содержит название сервиса, которое будет отображаться в настройках системы.

Поле image содержит ссылку на логотип сервиса, который будет отображаться в настройках системы. По заданному адресу должен присутствовать файл в формате svg.

Поле inputEventSupported содержит информацию поддерживает ли сервис оповещения об входящем звонке. По умолчанию значение 0

Поле outputEventSupported содержит информацию поддерживает ли сервис оповещения об исходящем звонке. По умолчанию значение 0

Поле hangupEventSupported содержит информацию поддерживает ли сервис оповещения об завершении звонка. По умолчанию значение 0

Поле additionalCodes содержит JSON, в котором лежит массив соответствия:id пользователя и code - добавочного кода в телефонии.

Поле externalPhones содержит JSON, в котором лежит массив соответствия: siteCode - кода магазина и externalPhone - внешнего номера. Если для одного магазина будет задано несколько внешних номеров, при инициации звонка с заданного магазина будет выбран последний номер из списка.

Если задано поле changeUserStatusUrl, при смене статуса менеджера в системе по заданному адресу будет отправлен GET запрос.

Если задано поле personalAccountUrl, в карточке телефонии будет доступна кнопка «Личный кабинет телефонии», при нажатии на которую по заданному адресу будет отправлен POST запрос с параметром clientId.

Параметры

ПараметрТипФорматОписание
configurationobject (Configuration) Конфигурация интеграции с телефонией
configuration[makeCallUrl]string{url}{length: {max: 1000}}} Адрес инициации звонка
configuration[allowEdit]boolean Разрешить редактировать из интерфейса системы
configuration[inputEventSupported]boolean Поддерживает оповещения о входящем звонке
configuration[outputEventSupported]boolean Поддерживает оповещения о исходящем звонке
configuration[hangupEventSupported]boolean Поддерживает оповещения о завершении звонке
configuration[changeUserStatusUrl]string{url}{length: {max: 1000}}} Уведомлять по этому адресу при смене сатуса менеджера в системе
configuration[additionalCodes][]array of objects (SerializedAdditionalCodes) Добавочные коды пользователей
configuration[additionalCodes][][userId]integer Id пользователя
configuration[additionalCodes][][code]string Добавочный код в телефонии
configuration[externalPhones][]array of objects (SerializedExternalPhones) Внешние номера
configuration[externalPhones][][siteCode]string Код магазина
configuration[externalPhones][][externalPhone]string Внешний номер

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
notExistUsers array Массив userId, которые отсутствуют в системе
notExistSites array Массив siteCode, которые отсутствуют в системе

Статусы ответа

Код статуса ответаОписание
201
  • Телефония успешно создана
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

CallbackGET {configuration["changeUserStatusUrl"]} Оповещение о смене статуса

Оповещение о смене статуса

Если в настройках телефонии задано поле changeUserStatusUrl , при смене статуса менеджера в системе по заданному адресу будет отправлен GET запрос.

Параметры

ПараметрТипФорматОписание
codestring{not blank}{length: {max: 255}}} Добавочный код менеджера
userIdinteger{not blank}{length: {max: 255}}} Id пользователя
clientIdstring{not blank}{length: {max: 255}}} Id клиента
statusstring{not blank}[break|busy|dinner|free]} Статус пользователя в системе

CallbackGET {configuration["makeCallUrl"]} Инициация звонка

Инициация звонка

Если в настройках телефонии задано поле makeCallUrl, при инициации звонка по заданному адресу будет отправлен GET запрос. Ожидается код возврата 200, в противном случае пользователю будет выведена ошибка.

Параметры

ПараметрТипФорматОписание
codestring{not blank}{length: {max: 255}}} Добавочный код менеджера
phonestring{not blank}{length: {max: 255}}} Телефон
clientIdstring{not blank}{length: {max: 255}}} Id клиента
userIdinteger{not blank}{range: {>=1, <=2147483647}}} Id пользователя
externalPhonestring{length: {max: 255}} Внешний номер телефона

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен

CallbackPOST {configuration["personalAccountUrl"]} Переход в личный кабинет

Переход в личный кабинет

Если задано поле personalAccountUrl, в карточке телефонии будет доступна кнопка «Личный кабинет телефонии», при нажатии на которую по заданному адресу будет отправлен POST запрос с параметром clientId.

Параметры

ПараметрТипФорматОписание
clientIdstring{not blank}{length: {max: 255}}} Id клиента

CallbackGET {recordUrl} Прослушивание звонка

Прослушивание звонка

Если у звонка задано поле recordUrl, при попытке прослушать звонок по заданному адресу будет отправлен GET запрос. Ожидается код возврата 200, в противном случае пользователю будет выведена ошибка.

Для корректного воспроизведения аудиозаписи необходимо указывать верный заголовок Content-Type

Параметры

ПараметрТипФорматОписание
clientIdstring{not blank}{length: {max: 255}}} Id клиента

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен

Пользователи

GET /api/v4/user-groups Получение списка групп пользователей

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

Для доступа к методу необходимо разрешение user_read.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
groups[] array of objects (Group) Группа пользователей
groups[][name] string Наименование
groups[][signatureTemplate] string Шаблон для подписи
groups[][code] string Код
groups[][isManager] boolean Обрабатывают заказы
groups[][isDeliveryMen] boolean Группа отвечает за доставку
groups[][deliveryTypes] array Типы доставок, за которые отвечает группа
groups[][breakdownOrderTypes] array Типы тех заказов, которые распределяются на менеджеров данной группы
groups[][breakdownSites] array Магазины, заказов которых распределяются на менеджеров данной группы
groups[][breakdownOrderMethods] array Способы оформления тех заказов, которые распределяются на менеджеров данной группы
groups[][grantedOrderTypes] array Типы заказов, которые видны менеджерам данной группы, если доступ ограничен
groups[][grantedSites] array Магазины, заказы которых видны менеджерам данной группы

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/users Получение списка пользователей, удовлетворяющих заданному фильтру

Получение списка пользователей, удовлетворяющих заданному фильтру

Для доступа к методу необходимо разрешение user_read.

Параметры

ПараметрТипФорматОписание
limitinteger{not blank}[20|50|100]} Количество элементов в ответе (по умолчанию равно 20)
pageinteger{not blank}{range: {>=1}}} Номер страницы с результатами (по умолчанию равно 1)
filterobject (ApiUserFilter)
filter[email]string{length: {max: 255}} Email пользователя
filter[status]string[break|busy|dinner|free] Статус пользователя в системе. При использовании фильтра filter[status] в выборку попадают только пользователи, у которых в поле online указано значение true.
filter[online]string[0|1] Пользователь онлайн
filter[active]string[0|1] Активность пользователя
filter[isManager]string[1] Является менеджером
filter[isAdmin]string[0|1] Является администратором
filter[groups][]array Группы пользователя
filter[createdAtFrom]DateTime Дата создания пользователя (от)
filter[createdAtTo]DateTime Дата создания пользователя (до)

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
pagination object (PaginationResponse) Постраничная разбивка
pagination[limit] integer Количество элементов в ответе
pagination[totalCount] integer Общее количество найденных элементов
pagination[currentPage] integer Текущая страница выдачи
pagination[totalPageCount] integer Общее количество страниц выдачи
users[] array of objects (SerializedUser) Информация о пользователе
users[][id] integer ID пользователя
users[][createdAt] DateTime Дата создания пользователя
users[][active] boolean Активность
users[][email] string Электронный адрес
users[][firstName] string Имя пользователя
users[][lastName] string Фамилия пользователя
users[][patronymic] string Отчество пользователя
users[][position] string Должность
users[][photoUrl] string URL фотографии
users[][phone] string Телефон
users[][status] string Статус пользователя в системе
users[][online] boolean Пользователь онлайн
users[][isAdmin] boolean Является администратором
users[][isManager] boolean Является менеджером
users[][groups][] array of objects (SerializedGroups) Группы пользователя
users[][groups][][name] string Название группы
users[][groups][][code] string Код группы

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
400
  • Ошибка при выполнении запроса

GET /api/v4/users/{id} Получение информации о пользователе

Получение информации о пользователе

Для доступа к методу необходимо разрешение user_read.

Получение информации о пользователе

Поле user[status] содержит статус пользователя в системе, может принимать следующие значения: free - свободен; busy - занят;dinner - на обеде; break - перерыв.

Параметры

ПараметрТипФорматОписание
idinteger ID пользователя

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)
user object (SerializedUser) Информация о пользователе
user[id] integer ID пользователя
user[createdAt] DateTime Дата создания пользователя
user[active] boolean Активность
user[email] string Электронный адрес
user[firstName] string Имя пользователя
user[lastName] string Фамилия пользователя
user[patronymic] string Отчество пользователя
user[position] string Должность
user[photoUrl] string URL фотографии
user[phone] string Телефон
user[status] string Статус пользователя в системе
user[online] boolean Пользователь онлайн
user[isAdmin] boolean Является администратором
user[isManager] boolean Является менеджером
user[groups][] array of objects (SerializedGroups) Группы пользователя
user[groups][][name] string Название группы
user[groups][][code] string Код группы

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен
404
  • Пользователь не найден

Статистика

GET /api/v4/statistic/update Обновление статистики

Обновление статистики

Для доступа к методу необходимо разрешение analytics_write.

Ставит в очередь задание на обновление ключевых статистических показателей в системе. Таймаут повторного вызова 60 сек. При более частых вызовах будет возвращаться 400 ошибка.

Ответ

ПараметрТипОписание
success boolean Результат запроса (успешный/неуспешный)

Статусы ответа

Код статуса ответаОписание
200
  • Запрос успешно выполнен