Справочник REST API

Заказы

• • POST /api/v1/orders/create

    • Создание заказа. Возвращает id созданного заказа.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    order	JSON		Order JSON object.

    Parameters

    Parameter	Type	Required?	Description
    number	string	false	Номер заказа
    externalId	string	false	Идентификатор с внешнего сайта
    createdAt	DateTime	false	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	false	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	false	Адрес доставки.
    deliveryAddress[index]	string	false	Почтовый индекс
    deliveryAddress[country]	string	false	Страна
    deliveryAddress[region]	string	false	Область/край
    deliveryAddress[city]	string	false	Город
    deliveryAddress[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	false	Дом
    deliveryAddress[flat]	string	false	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	false	Код домофона
    deliveryAddress[floor]	integer	false	Этаж
    deliveryAddress[block]	integer	false	Подъезд
    deliveryAddress[house]	string	false	Строение/Корпус
    deliveryAddress[metro]	string	false	Метро
    deliveryAddress[notes]	string	false	Дополнительные заметки
    deliveryAddress[text]	string	false	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	false	Время доставки
    deliveryCost	double	false	Стоимость доставки.
    discount	double	false	Скидка на заказ в рублях
    discountPercent	double	false	Скидка на заказ в процентах
    mark	integer	false	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	false	Дата и время получение оценки от покупателя.
    lastName	string	false	Фамилия контактного лица.
    firstName	string	false	Имя контактного лица.
    patronymic	string	false	Отчество контактного лица.
    phone	string	false	Контактный телефон.
    email	string	false	Контактный email.
    call	boolean	false	Требуется звонок
    expired	boolean	false	Время обработки заказа было просрочено.
    customerComment	string	false	Комментарий клиента.
    managerComment	string	false	Комментарий менеджера.
    paymentDetail	string	false	Рекизиты для оплаты
    deliveryService	object (DeliveryService)	false	Служба доставки.
    deliveryService[name]	string	false	Название службы доставки.
    deliveryService[code]	string	false	Символьный код
    statusComment	string	false	Последний комментарий к статусу
    customFields	array	false	Ассоциативный массив пользовательских полей
    orderType	string	false	Тип заказа.
    orderMethod	string	false	Способ оформления заказа.
    customerId	string	false	Клиент, который сделал заказ.
    deliveryType	string	false	Тип доставки.
    paymentType	string	false	Тип оплаты.
    paymentStatus	string	false	Статус оплаты.
    status	string	false	Текущий статус заказа.
    sourceId	string	false	Источник заказа.
    items[]	array of objects (SerializedOrderProduct)	false	Товары заказа
    items[][initialPrice]	double	false	Цена товара
    items[][purchasePrice]	double	false	Закупочная цена
    items[][discount]	double	false	Скидка в рублях на одну штуку
    items[][discountPercent]	double	false	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	false	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	false	Количество
    items[][comment]	string	false	Комментарий к товару в заказе
    items[][productId]	string	false	Идентификатор товара или торгового предложения с внешнего сайта
    items[][productName]	string	false	Название товара
    items[][status]	string	false	Статус товара

    Status Codes

    Status Code	Description
    201	Заказ создан
    400	Не верный запрос Заказа с таким id уже существует
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/orders/fix-external-ids

    • У заказов, выбранных по id, перезаписывает externalId.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orders	JSON		JSON array [{id,externalId},{id,externalId}]

    Status Codes

    Status Code	Description
    200	externalId исправлены
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/orders/history

    • Получение истории изменений по заказам. Возвращает массив объектов заказов, которые содержат только измененные поля
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Filters

    Name	Information
    startDate	Datatype DateTime<Y-m-d H:i:s> Default null Description Start date for history filtering
    endDate	Datatype DateTime<Y-m-d H:i:s> Default null Description End date for history filtering
    limit	Datatype integer Default 200 Description Size of selection
    offset	Datatype integer Default 0 Description Offset of selection

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    number	string	>=1.0	Номер заказа
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    orderType	string	>=1.0	Тип заказа.
    orderMethod	string	>=1.0	Способ оформления заказа.
    createdAt	DateTime	>=1.0	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	>=1.0	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	>=1.0	Адрес доставки.
    deliveryAddress[index]	string	>=1.0	Почтовый индекс
    deliveryAddress[country]	string	>=1.0	Страна
    deliveryAddress[region]	string	>=1.0	Область/край
    deliveryAddress[city]	string	>=1.0	Город
    deliveryAddress[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	>=1.0	Дом
    deliveryAddress[flat]	string	>=1.0	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	>=1.0	Код домофона
    deliveryAddress[floor]	integer	>=1.0	Этаж
    deliveryAddress[block]	integer	>=1.0	Подъезд
    deliveryAddress[house]	string	>=1.0	Строение/Корпус
    deliveryAddress[metro]	string	>=1.0	Метро
    deliveryAddress[notes]	string	>=1.0	Дополнительные заметки
    deliveryAddress[text]	string	>=1.0	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	>=1.0	Время доставки
    deliveryCost	double	>=1.0	Стоимость доставки.
    summ	double	>=1.0	Общая сумма по товарам.
    totalSumm	double	>=1.0	Общая сумма c учетом скидок и доставки
    purchaseSumm	double	>=1.0	Общая сумма закупки
    discount	double	>=1.0	Скидка на заказ в рублях
    discountPercent	double	>=1.0	Скидка на заказ в процентах
    mark	integer	>=1.0	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	>=1.0	Дата и время получение оценки от покупателя.
    lastName	string	>=1.0	Фамилия контактного лица.
    firstName	string	>=1.0	Имя контактного лица.
    patronymic	string	>=1.0	Отчество контактного лица.
    phone	string	>=1.0	Контактный телефон.
    email	string	>=1.0	Контактный email.
    call	boolean	>=1.0	Требуется звонок
    expired	boolean	>=1.0	Время обработки заказа было просрочено.
    customerComment	string	>=1.0	Комментарий клиента.
    managerComment	string	>=1.0	Комментарий менеджера.
    paymentDetail	string	>=1.0	Рекизиты для оплаты
    customer	object (Customer)	>=1.0	Клиент, который сделал заказ.
    customer[id]	integer	>=1.0	Автоинкрементальный идентификатор.
    customer[externalId]	string	>=1.0	Идентификатор с внешнего сайта
    customer[firstName]	string	>=1.0	Имя клиента
    customer[lastName]	string	>=1.0	Фамилия клиента
    customer[patronymic]	string	>=1.0	Отчество клиента
    customer[email]	string	>=1.0	Электронный адрес
    customer[phones][]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    customer[phones][][number]	string	>=1.0	Номер телефона.
    customer[address]	object (CustomerAddress)	>=1.0	Адреса заказчика
    customer[address][index]	string	>=1.0	Почтовый индекс
    customer[address][country]	string	>=1.0	Страна
    customer[address][region]	string	>=1.0	Область/край
    customer[address][city]	string	>=1.0	Город
    customer[address][street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    customer[address][building]	string	>=1.0	Дом
    customer[address][flat]	string	>=1.0	Номер квартиры или офиса
    customer[address][intercomCode]	string	>=1.0	Код домофона
    customer[address][floor]	integer	>=1.0	Этаж
    customer[address][block]	integer	>=1.0	Подъезд
    customer[address][house]	string	>=1.0	Строение/Корпус
    customer[address][metro]	string	>=1.0	Метро
    customer[address][notes]	string	>=1.0	Дополнительные заметки
    customer[address][text]	string	>=1.0	Адрес в виде строки
    customer[createdAt]	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    customer[vip]	boolean	>=1.0	Важный клиент
    customer[commentary]	string	>=1.0	Комментарий оператора
    customer[contragentType]	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    customer[legalName]	string	>=1.0	Полное наименование
    customer[legalAddress]	string	>=1.0	Адрес регистрации (Юридический адрес)
    customer[INN]	string	>=1.0	ИНН
    customer[OKPO]	string	>=1.0	ОКПО
    customer[KPP]	string	>=1.0	КПП
    customer[OGRN]	string	>=1.0	ОГРН
    customer[OGRNIP]	string	>=1.0	ОГРНИП
    customer[certificateNumber]	string	>=1.0	Номер свидетельства
    customer[certificateDate]	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    customer[BIK]	string	>=1.0	БИК
    customer[bank]	string	>=1.0	Банк
    customer[bankAddress]	string	>=1.0	Адрес банка
    customer[corrAccount]	string	>=1.0	Корреспондентский счет
    customer[bankAccount]	string	>=1.0	Расчетный счет
    customer[customFields]	array	>=1.0	Ассоциативный массив пользовательских полей
    deliveryType	string	>=1.0	Тип доставки.
    deliveryService	object (DeliveryService)	>=1.0	Служба доставки.
    deliveryService[name]	string	>=1.0	Название службы доставки.
    deliveryService[code]	string	>=1.0	Символьный код
    paymentType	string	>=1.0	Тип оплаты.
    paymentStatus	string	>=1.0	Статус оплаты.
    status	string	>=1.0	Текущий статус заказа.
    statusComment	string	>=1.0	Последний комментарий к статусу
    sourceId	string	>=1.0	Источник заказа.
    items[]	array of objects (OrderProduct)	>=1.0	Товары заказа
    items[][id]	integer	>=1.0
    items[][initialPrice]	double	>=1.0	Цена товара
    items[][purchasePrice]	double	>=1.0	Закупочная цена
    items[][discount]	double	>=1.0	Скидка в рублях на одну штуку
    items[][discountPercent]	double	>=1.0	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	>=1.0	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	>=1.0	Количество
    items[][status]	string	>=1.0	Статус товара в заказе
    items[][isCanceled]	boolean	>=1.0	Товар в статусе отмены
    items[][statusUpdatedAt]	DateTime	>=1.0	Дата и время изменения статуса (Y-m-d H:i:s)
    items[][comment]	string	>=1.0	Комментарий к товару в заказе
    items[][offer]	object (Offer)	>=1.0
    items[][offer][externalId]	string	>=1.0	Идентификатор с внешнего сайта
    items[][offer][xmlId]	string	>=1.0	Идентификатор 1С
    items[][offer][name]	string	>=1.0	Название (указывается, если не совпадает с названием товара).
    items[][created]	boolean	>=1.0	Добавлен
    items[][deleted]	boolean	>=1.0	Удален
    fromApi	boolean	>=2.0	Заказ оформлен через API
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей
    customerId	string	>=1.0	Клиент, который сделал заказ.
    managerId	string	>=1.0	Менеджер, прикрепленный к заказу.
    created	boolean	>=1.0	Заказ создан
    deleted	boolean	>=1.0	Заказ удален

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/orders/upload

    • Пакетная загрузка заказов. Возвращает массив uploadedOrders содержащий id и externalId добавленных заказов
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orders	JSON		JSON array of orders

    Parameters

    Parameter	Type	Required?	Description
    number	string	false	Номер заказа
    externalId	string	false	Идентификатор с внешнего сайта
    createdAt	DateTime	false	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	false	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	false	Адрес доставки.
    deliveryAddress[index]	string	false	Почтовый индекс
    deliveryAddress[country]	string	false	Страна
    deliveryAddress[region]	string	false	Область/край
    deliveryAddress[city]	string	false	Город
    deliveryAddress[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	false	Дом
    deliveryAddress[flat]	string	false	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	false	Код домофона
    deliveryAddress[floor]	integer	false	Этаж
    deliveryAddress[block]	integer	false	Подъезд
    deliveryAddress[house]	string	false	Строение/Корпус
    deliveryAddress[metro]	string	false	Метро
    deliveryAddress[notes]	string	false	Дополнительные заметки
    deliveryAddress[text]	string	false	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	false	Время доставки
    deliveryCost	double	false	Стоимость доставки.
    discount	double	false	Скидка на заказ в рублях
    discountPercent	double	false	Скидка на заказ в процентах
    mark	integer	false	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	false	Дата и время получение оценки от покупателя.
    lastName	string	false	Фамилия контактного лица.
    firstName	string	false	Имя контактного лица.
    patronymic	string	false	Отчество контактного лица.
    phone	string	false	Контактный телефон.
    email	string	false	Контактный email.
    call	boolean	false	Требуется звонок
    expired	boolean	false	Время обработки заказа было просрочено.
    customerComment	string	false	Комментарий клиента.
    managerComment	string	false	Комментарий менеджера.
    paymentDetail	string	false	Рекизиты для оплаты
    deliveryService	object (DeliveryService)	false	Служба доставки.
    deliveryService[name]	string	false	Название службы доставки.
    deliveryService[code]	string	false	Символьный код
    statusComment	string	false	Последний комментарий к статусу
    customFields	array	false	Ассоциативный массив пользовательских полей
    orderType	string	false	Тип заказа.
    orderMethod	string	false	Способ оформления заказа.
    customerId	string	false	Клиент, который сделал заказ.
    deliveryType	string	false	Тип доставки.
    paymentType	string	false	Тип оплаты.
    paymentStatus	string	false	Статус оплаты.
    status	string	false	Текущий статус заказа.
    sourceId	string	false	Источник заказа.
    items[]	array of objects (SerializedOrderProduct)	false	Товары заказа
    items[][initialPrice]	double	false	Цена товара
    items[][purchasePrice]	double	false	Закупочная цена
    items[][discount]	double	false	Скидка в рублях на одну штуку
    items[][discountPercent]	double	false	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	false	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	false	Количество
    items[][comment]	string	false	Комментарий к товару в заказе
    items[][productId]	string	false	Идентификатор товара или торгового предложения с внешнего сайта
    items[][productName]	string	false	Название товара
    items[][status]	string	false	Статус товара

    Status Codes

    Status Code	Description
    201	Заказы загружены
    403	Не передан apiKey Такого apiKey не существует
    460	Во время загрузки возникли ошибки. Часть заказов не загружена. Сообщение об ошибке в errorMsg. Детализация списка ошибок в errors.

  • POST /api/v1/orders/{externalId}/edit

    • Создание/редактирование заказа. Если заказ новый - возвращает id созданного заказа.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    order	JSON		Order JSON object
    externalId	\w+

    Parameters

    Parameter	Type	Required?	Description
    number	string	false	Номер заказа
    externalId	string	false	Идентификатор с внешнего сайта
    createdAt	DateTime	false	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	false	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	false	Адрес доставки.
    deliveryAddress[index]	string	false	Почтовый индекс
    deliveryAddress[country]	string	false	Страна
    deliveryAddress[region]	string	false	Область/край
    deliveryAddress[city]	string	false	Город
    deliveryAddress[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	false	Дом
    deliveryAddress[flat]	string	false	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	false	Код домофона
    deliveryAddress[floor]	integer	false	Этаж
    deliveryAddress[block]	integer	false	Подъезд
    deliveryAddress[house]	string	false	Строение/Корпус
    deliveryAddress[metro]	string	false	Метро
    deliveryAddress[notes]	string	false	Дополнительные заметки
    deliveryAddress[text]	string	false	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	false	Время доставки
    deliveryCost	double	false	Стоимость доставки.
    discount	double	false	Скидка на заказ в рублях
    discountPercent	double	false	Скидка на заказ в процентах
    mark	integer	false	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	false	Дата и время получение оценки от покупателя.
    lastName	string	false	Фамилия контактного лица.
    firstName	string	false	Имя контактного лица.
    patronymic	string	false	Отчество контактного лица.
    phone	string	false	Контактный телефон.
    email	string	false	Контактный email.
    call	boolean	false	Требуется звонок
    expired	boolean	false	Время обработки заказа было просрочено.
    customerComment	string	false	Комментарий клиента.
    managerComment	string	false	Комментарий менеджера.
    paymentDetail	string	false	Рекизиты для оплаты
    deliveryService	object (DeliveryService)	false	Служба доставки.
    deliveryService[name]	string	false	Название службы доставки.
    deliveryService[code]	string	false	Символьный код
    statusComment	string	false	Последний комментарий к статусу
    customFields	array	false	Ассоциативный массив пользовательских полей
    orderType	string	false	Тип заказа.
    orderMethod	string	false	Способ оформления заказа.
    customerId	string	false	Клиент, который сделал заказ.
    deliveryType	string	false	Тип доставки.
    paymentType	string	false	Тип оплаты.
    paymentStatus	string	false	Статус оплаты.
    status	string	false	Текущий статус заказа.
    sourceId	string	false	Источник заказа.
    items[]	array of objects (SerializedOrderProduct)	false	Товары заказа
    items[][initialPrice]	double	false	Цена товара
    items[][purchasePrice]	double	false	Закупочная цена
    items[][discount]	double	false	Скидка в рублях на одну штуку
    items[][discountPercent]	double	false	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	false	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	false	Количество
    items[][comment]	string	false	Комментарий к товару в заказе
    items[][productId]	string	false	Идентификатор товара или торгового предложения с внешнего сайта
    items[][productName]	string	false	Название товара
    items[][status]	string	false	Статус товара

    Status Codes

    Status Code	Description
    200	Данные заказа изменены
    201	Заказ создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/orders/{id}

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    id	\w+

    Filters

    Name	Information
    by	Values id|extarnalId Default externalId Description Search by id or externalId.

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    number	string	>=1.0	Номер заказа
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    orderType	string	>=1.0	Тип заказа.
    orderMethod	string	>=1.0	Способ оформления заказа.
    createdAt	DateTime	>=1.0	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	>=1.0	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	>=1.0	Адрес доставки.
    deliveryAddress[index]	string	>=1.0	Почтовый индекс
    deliveryAddress[country]	string	>=1.0	Страна
    deliveryAddress[region]	string	>=1.0	Область/край
    deliveryAddress[city]	string	>=1.0	Город
    deliveryAddress[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	>=1.0	Дом
    deliveryAddress[flat]	string	>=1.0	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	>=1.0	Код домофона
    deliveryAddress[floor]	integer	>=1.0	Этаж
    deliveryAddress[block]	integer	>=1.0	Подъезд
    deliveryAddress[house]	string	>=1.0	Строение/Корпус
    deliveryAddress[metro]	string	>=1.0	Метро
    deliveryAddress[notes]	string	>=1.0	Дополнительные заметки
    deliveryAddress[text]	string	>=1.0	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	>=1.0	Время доставки
    deliveryCost	double	>=1.0	Стоимость доставки.
    summ	double	>=1.0	Общая сумма по товарам.
    totalSumm	double	>=1.0	Общая сумма c учетом скидок и доставки
    purchaseSumm	double	>=1.0	Общая сумма закупки
    discount	double	>=1.0	Скидка на заказ в рублях
    discountPercent	double	>=1.0	Скидка на заказ в процентах
    mark	integer	>=1.0	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	>=1.0	Дата и время получение оценки от покупателя.
    lastName	string	>=1.0	Фамилия контактного лица.
    firstName	string	>=1.0	Имя контактного лица.
    patronymic	string	>=1.0	Отчество контактного лица.
    phone	string	>=1.0	Контактный телефон.
    email	string	>=1.0	Контактный email.
    call	boolean	>=1.0	Требуется звонок
    expired	boolean	>=1.0	Время обработки заказа было просрочено.
    customerComment	string	>=1.0	Комментарий клиента.
    managerComment	string	>=1.0	Комментарий менеджера.
    paymentDetail	string	>=1.0	Рекизиты для оплаты
    customer	object (Customer)	>=1.0	Клиент, который сделал заказ.
    customer[id]	integer	>=1.0	Автоинкрементальный идентификатор.
    customer[externalId]	string	>=1.0	Идентификатор с внешнего сайта
    customer[firstName]	string	>=1.0	Имя клиента
    customer[lastName]	string	>=1.0	Фамилия клиента
    customer[patronymic]	string	>=1.0	Отчество клиента
    customer[email]	string	>=1.0	Электронный адрес
    customer[phones][]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    customer[phones][][number]	string	>=1.0	Номер телефона.
    customer[address]	object (CustomerAddress)	>=1.0	Адреса заказчика
    customer[address][index]	string	>=1.0	Почтовый индекс
    customer[address][country]	string	>=1.0	Страна
    customer[address][region]	string	>=1.0	Область/край
    customer[address][city]	string	>=1.0	Город
    customer[address][street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    customer[address][building]	string	>=1.0	Дом
    customer[address][flat]	string	>=1.0	Номер квартиры или офиса
    customer[address][intercomCode]	string	>=1.0	Код домофона
    customer[address][floor]	integer	>=1.0	Этаж
    customer[address][block]	integer	>=1.0	Подъезд
    customer[address][house]	string	>=1.0	Строение/Корпус
    customer[address][metro]	string	>=1.0	Метро
    customer[address][notes]	string	>=1.0	Дополнительные заметки
    customer[address][text]	string	>=1.0	Адрес в виде строки
    customer[createdAt]	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    customer[vip]	boolean	>=1.0	Важный клиент
    customer[commentary]	string	>=1.0	Комментарий оператора
    customer[contragentType]	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    customer[legalName]	string	>=1.0	Полное наименование
    customer[legalAddress]	string	>=1.0	Адрес регистрации (Юридический адрес)
    customer[INN]	string	>=1.0	ИНН
    customer[OKPO]	string	>=1.0	ОКПО
    customer[KPP]	string	>=1.0	КПП
    customer[OGRN]	string	>=1.0	ОГРН
    customer[OGRNIP]	string	>=1.0	ОГРНИП
    customer[certificateNumber]	string	>=1.0	Номер свидетельства
    customer[certificateDate]	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    customer[BIK]	string	>=1.0	БИК
    customer[bank]	string	>=1.0	Банк
    customer[bankAddress]	string	>=1.0	Адрес банка
    customer[corrAccount]	string	>=1.0	Корреспондентский счет
    customer[bankAccount]	string	>=1.0	Расчетный счет
    customer[customFields]	array	>=1.0	Ассоциативный массив пользовательских полей
    deliveryType	string	>=1.0	Тип доставки.
    deliveryService	object (DeliveryService)	>=1.0	Служба доставки.
    deliveryService[name]	string	>=1.0	Название службы доставки.
    deliveryService[code]	string	>=1.0	Символьный код
    deliveryService[deliveryType]	string	>=1.0	Тип доставки.
    paymentType	string	>=1.0	Тип оплаты.
    paymentStatus	string	>=1.0	Статус оплаты.
    status	string	>=1.0	Текущий статус заказа.
    statusComment	string	>=1.0	Последний комментарий к статусу
    sourceId	string	>=1.0	Источник заказа.
    items[]	array of objects (OrderProduct)	>=1.0	Товары заказа
    items[][id]	integer	>=1.0
    items[][initialPrice]	double	>=1.0	Цена товара
    items[][purchasePrice]	double	>=1.0	Закупочная цена
    items[][discount]	double	>=1.0	Скидка в рублях на одну штуку
    items[][discountPercent]	double	>=1.0	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	>=1.0	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	>=1.0	Количество
    items[][status]	string	>=1.0	Статус товара в заказе
    items[][isCanceled]	boolean	>=1.0	Товар в статусе отмены
    items[][statusUpdatedAt]	DateTime	>=1.0	Дата и время изменения статуса (Y-m-d H:i:s)
    items[][comment]	string	>=1.0	Комментарий к товару в заказе
    items[][offer]	object (Offer)	>=1.0
    items[][offer][externalId]	string	>=1.0	Идентификатор с внешнего сайта
    items[][offer][xmlId]	string	>=1.0	Идентификатор 1С
    items[][offer][name]	string	>=1.0	Название (указывается, если не совпадает с названием товара).
    items[][offer][delete_candidate]	boolean	>=1.0
    fromApi	boolean	>=2.0	Заказ оформлен через API
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует
    404	Заказ не найден

  • POST /api/v2/orders/create

    • Создание заказа. Возвращает id созданного заказа.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    order	JSON		Order JSON object.

    Parameters

    Parameter	Type	Required?	Description
    number	string	false	Номер заказа
    externalId	string	false	Идентификатор с внешнего сайта
    createdAt	DateTime	false	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	false	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	false	Адрес доставки.
    deliveryAddress[index]	string	false	Почтовый индекс
    deliveryAddress[country]	string	false	Страна
    deliveryAddress[region]	string	false	Область/край
    deliveryAddress[city]	string	false	Город
    deliveryAddress[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	false	Дом
    deliveryAddress[flat]	string	false	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	false	Код домофона
    deliveryAddress[floor]	integer	false	Этаж
    deliveryAddress[block]	integer	false	Подъезд
    deliveryAddress[house]	string	false	Строение/Корпус
    deliveryAddress[metro]	string	false	Метро
    deliveryAddress[notes]	string	false	Дополнительные заметки
    deliveryAddress[text]	string	false	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	false	Время доставки
    deliveryCost	double	false	Стоимость доставки.
    discount	double	false	Скидка на заказ в рублях
    discountPercent	double	false	Скидка на заказ в процентах
    mark	integer	false	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	false	Дата и время получение оценки от покупателя.
    lastName	string	false	Фамилия контактного лица.
    firstName	string	false	Имя контактного лица.
    patronymic	string	false	Отчество контактного лица.
    phone	string	false	Контактный телефон.
    email	string	false	Контактный email.
    call	boolean	false	Требуется звонок
    expired	boolean	false	Время обработки заказа было просрочено.
    customerComment	string	false	Комментарий клиента.
    managerComment	string	false	Комментарий менеджера.
    paymentDetail	string	false	Рекизиты для оплаты
    deliveryService	object (DeliveryService)	false	Служба доставки.
    deliveryService[name]	string	false	Название службы доставки.
    deliveryService[code]	string	false	Символьный код
    statusComment	string	false	Последний комментарий к статусу
    customFields	array	false	Ассоциативный массив пользовательских полей
    orderType	string	false	Тип заказа.
    orderMethod	string	false	Способ оформления заказа.
    customerId	string	false	Клиент, который сделал заказ.
    deliveryType	string	false	Тип доставки.
    paymentType	string	false	Тип оплаты.
    paymentStatus	string	false	Статус оплаты.
    status	string	false	Текущий статус заказа.
    sourceId	string	false	Источник заказа.
    items[]	array of objects (SerializedOrderProduct)	false	Товары заказа
    items[][initialPrice]	double	false	Цена товара
    items[][purchasePrice]	double	false	Закупочная цена
    items[][discount]	double	false	Скидка в рублях на одну штуку
    items[][discountPercent]	double	false	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	false	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	false	Количество
    items[][comment]	string	false	Комментарий к товару в заказе
    items[][productId]	string	false	Идентификатор товара или торгового предложения с внешнего сайта
    items[][productName]	string	false	Название товара
    items[][status]	string	false	Статус товара

    Status Codes

    Status Code	Description
    201	Заказ создан
    400	Не верный запрос Заказа с таким id уже существует
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/orders/fix-external-ids

    • У заказов, выбранных по id, перезаписывает externalId.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orders	JSON		JSON array [{id,externalId},{id,externalId}]

    Status Codes

    Status Code	Description
    200	externalId исправлены
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/orders/history

    • Получение истории изменений по заказам. Возвращает массив объектов заказов, которые содержат только измененные поля
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Filters

    Name	Information
    startDate	Datatype DateTime<Y-m-d H:i:s> Default null Description Start date for history filtering
    endDate	Datatype DateTime<Y-m-d H:i:s> Default null Description End date for history filtering
    limit	Datatype integer Default 200 Description Size of selection
    offset	Datatype integer Default 0 Description Offset of selection

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    number	string	>=1.0	Номер заказа
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    orderType	string	>=1.0	Тип заказа.
    orderMethod	string	>=1.0	Способ оформления заказа.
    createdAt	DateTime	>=1.0	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	>=1.0	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	>=1.0	Адрес доставки.
    deliveryAddress[index]	string	>=1.0	Почтовый индекс
    deliveryAddress[country]	string	>=1.0	Страна
    deliveryAddress[region]	string	>=1.0	Область/край
    deliveryAddress[city]	string	>=1.0	Город
    deliveryAddress[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	>=1.0	Дом
    deliveryAddress[flat]	string	>=1.0	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	>=1.0	Код домофона
    deliveryAddress[floor]	integer	>=1.0	Этаж
    deliveryAddress[block]	integer	>=1.0	Подъезд
    deliveryAddress[house]	string	>=1.0	Строение/Корпус
    deliveryAddress[metro]	string	>=1.0	Метро
    deliveryAddress[notes]	string	>=1.0	Дополнительные заметки
    deliveryAddress[text]	string	>=1.0	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	>=1.0	Время доставки
    deliveryCost	double	>=1.0	Стоимость доставки.
    summ	double	>=1.0	Общая сумма по товарам.
    totalSumm	double	>=1.0	Общая сумма c учетом скидок и доставки
    purchaseSumm	double	>=1.0	Общая сумма закупки
    discount	double	>=1.0	Скидка на заказ в рублях
    discountPercent	double	>=1.0	Скидка на заказ в процентах
    mark	integer	>=1.0	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	>=1.0	Дата и время получение оценки от покупателя.
    lastName	string	>=1.0	Фамилия контактного лица.
    firstName	string	>=1.0	Имя контактного лица.
    patronymic	string	>=1.0	Отчество контактного лица.
    phone	string	>=1.0	Контактный телефон.
    email	string	>=1.0	Контактный email.
    call	boolean	>=1.0	Требуется звонок
    expired	boolean	>=1.0	Время обработки заказа было просрочено.
    customerComment	string	>=1.0	Комментарий клиента.
    managerComment	string	>=1.0	Комментарий менеджера.
    paymentDetail	string	>=1.0	Рекизиты для оплаты
    customer	object (Customer)	>=1.0	Клиент, который сделал заказ.
    customer[id]	integer	>=1.0	Автоинкрементальный идентификатор.
    customer[externalId]	string	>=1.0	Идентификатор с внешнего сайта
    customer[firstName]	string	>=1.0	Имя клиента
    customer[lastName]	string	>=1.0	Фамилия клиента
    customer[patronymic]	string	>=1.0	Отчество клиента
    customer[email]	string	>=1.0	Электронный адрес
    customer[phones][]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    customer[phones][][number]	string	>=1.0	Номер телефона.
    customer[address]	object (CustomerAddress)	>=1.0	Адреса заказчика
    customer[address][index]	string	>=1.0	Почтовый индекс
    customer[address][country]	string	>=1.0	Страна
    customer[address][region]	string	>=1.0	Область/край
    customer[address][city]	string	>=1.0	Город
    customer[address][street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    customer[address][building]	string	>=1.0	Дом
    customer[address][flat]	string	>=1.0	Номер квартиры или офиса
    customer[address][intercomCode]	string	>=1.0	Код домофона
    customer[address][floor]	integer	>=1.0	Этаж
    customer[address][block]	integer	>=1.0	Подъезд
    customer[address][house]	string	>=1.0	Строение/Корпус
    customer[address][metro]	string	>=1.0	Метро
    customer[address][notes]	string	>=1.0	Дополнительные заметки
    customer[address][text]	string	>=1.0	Адрес в виде строки
    customer[createdAt]	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    customer[vip]	boolean	>=1.0	Важный клиент
    customer[commentary]	string	>=1.0	Комментарий оператора
    customer[contragentType]	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    customer[legalName]	string	>=1.0	Полное наименование
    customer[legalAddress]	string	>=1.0	Адрес регистрации (Юридический адрес)
    customer[INN]	string	>=1.0	ИНН
    customer[OKPO]	string	>=1.0	ОКПО
    customer[KPP]	string	>=1.0	КПП
    customer[OGRN]	string	>=1.0	ОГРН
    customer[OGRNIP]	string	>=1.0	ОГРНИП
    customer[certificateNumber]	string	>=1.0	Номер свидетельства
    customer[certificateDate]	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    customer[BIK]	string	>=1.0	БИК
    customer[bank]	string	>=1.0	Банк
    customer[bankAddress]	string	>=1.0	Адрес банка
    customer[corrAccount]	string	>=1.0	Корреспондентский счет
    customer[bankAccount]	string	>=1.0	Расчетный счет
    customer[customFields]	array	>=1.0	Ассоциативный массив пользовательских полей
    deliveryType	string	>=1.0	Тип доставки.
    deliveryService	object (DeliveryService)	>=1.0	Служба доставки.
    deliveryService[name]	string	>=1.0	Название службы доставки.
    deliveryService[code]	string	>=1.0	Символьный код
    paymentType	string	>=1.0	Тип оплаты.
    paymentStatus	string	>=1.0	Статус оплаты.
    status	string	>=1.0	Текущий статус заказа.
    statusComment	string	>=1.0	Последний комментарий к статусу
    sourceId	string	>=1.0	Источник заказа.
    items[]	array of objects (OrderProduct)	>=1.0	Товары заказа
    items[][id]	integer	>=1.0
    items[][initialPrice]	double	>=1.0	Цена товара
    items[][purchasePrice]	double	>=1.0	Закупочная цена
    items[][discount]	double	>=1.0	Скидка в рублях на одну штуку
    items[][discountPercent]	double	>=1.0	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	>=1.0	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	>=1.0	Количество
    items[][status]	string	>=1.0	Статус товара в заказе
    items[][isCanceled]	boolean	>=1.0	Товар в статусе отмены
    items[][statusUpdatedAt]	DateTime	>=1.0	Дата и время изменения статуса (Y-m-d H:i:s)
    items[][comment]	string	>=1.0	Комментарий к товару в заказе
    items[][offer]	object (Offer)	>=1.0
    items[][offer][externalId]	string	>=1.0	Идентификатор с внешнего сайта
    items[][offer][xmlId]	string	>=1.0	Идентификатор 1С
    items[][offer][name]	string	>=1.0	Название (указывается, если не совпадает с названием товара).
    items[][created]	boolean	>=1.0	Добавлен
    items[][deleted]	boolean	>=1.0	Удален
    fromApi	boolean	>=2.0	Заказ оформлен через API
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей
    customerId	string	>=1.0	Клиент, который сделал заказ.
    managerId	string	>=1.0	Менеджер, прикрепленный к заказу.
    created	boolean	>=1.0	Заказ создан
    deleted	boolean	>=1.0	Заказ удален

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/orders/upload

    • Пакетная загрузка заказов. Возвращает массив uploadedOrders содержащий id и externalId добавленных заказов
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orders	JSON		JSON array of orders

    Parameters

    Parameter	Type	Required?	Description
    number	string	false	Номер заказа
    externalId	string	false	Идентификатор с внешнего сайта
    createdAt	DateTime	false	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	false	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	false	Адрес доставки.
    deliveryAddress[index]	string	false	Почтовый индекс
    deliveryAddress[country]	string	false	Страна
    deliveryAddress[region]	string	false	Область/край
    deliveryAddress[city]	string	false	Город
    deliveryAddress[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	false	Дом
    deliveryAddress[flat]	string	false	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	false	Код домофона
    deliveryAddress[floor]	integer	false	Этаж
    deliveryAddress[block]	integer	false	Подъезд
    deliveryAddress[house]	string	false	Строение/Корпус
    deliveryAddress[metro]	string	false	Метро
    deliveryAddress[notes]	string	false	Дополнительные заметки
    deliveryAddress[text]	string	false	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	false	Время доставки
    deliveryCost	double	false	Стоимость доставки.
    discount	double	false	Скидка на заказ в рублях
    discountPercent	double	false	Скидка на заказ в процентах
    mark	integer	false	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	false	Дата и время получение оценки от покупателя.
    lastName	string	false	Фамилия контактного лица.
    firstName	string	false	Имя контактного лица.
    patronymic	string	false	Отчество контактного лица.
    phone	string	false	Контактный телефон.
    email	string	false	Контактный email.
    call	boolean	false	Требуется звонок
    expired	boolean	false	Время обработки заказа было просрочено.
    customerComment	string	false	Комментарий клиента.
    managerComment	string	false	Комментарий менеджера.
    paymentDetail	string	false	Рекизиты для оплаты
    deliveryService	object (DeliveryService)	false	Служба доставки.
    deliveryService[name]	string	false	Название службы доставки.
    deliveryService[code]	string	false	Символьный код
    statusComment	string	false	Последний комментарий к статусу
    customFields	array	false	Ассоциативный массив пользовательских полей
    orderType	string	false	Тип заказа.
    orderMethod	string	false	Способ оформления заказа.
    customerId	string	false	Клиент, который сделал заказ.
    deliveryType	string	false	Тип доставки.
    paymentType	string	false	Тип оплаты.
    paymentStatus	string	false	Статус оплаты.
    status	string	false	Текущий статус заказа.
    sourceId	string	false	Источник заказа.
    items[]	array of objects (SerializedOrderProduct)	false	Товары заказа
    items[][initialPrice]	double	false	Цена товара
    items[][purchasePrice]	double	false	Закупочная цена
    items[][discount]	double	false	Скидка в рублях на одну штуку
    items[][discountPercent]	double	false	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	false	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	false	Количество
    items[][comment]	string	false	Комментарий к товару в заказе
    items[][productId]	string	false	Идентификатор товара или торгового предложения с внешнего сайта
    items[][productName]	string	false	Название товара
    items[][status]	string	false	Статус товара

    Status Codes

    Status Code	Description
    201	Заказы загружены
    403	Не передан apiKey Такого apiKey не существует
    460	Во время загрузки возникли ошибки. Часть заказов не загружена. Сообщение об ошибке в errorMsg. Детализация списка ошибок в errors.

  • POST /api/v2/orders/{externalId}/edit

    • Создание/редактирование заказа. Если заказ новый - возвращает id созданного заказа.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    order	JSON		Order JSON object
    externalId	\w+

    Parameters

    Parameter	Type	Required?	Description
    number	string	false	Номер заказа
    externalId	string	false	Идентификатор с внешнего сайта
    createdAt	DateTime	false	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	false	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	false	Адрес доставки.
    deliveryAddress[index]	string	false	Почтовый индекс
    deliveryAddress[country]	string	false	Страна
    deliveryAddress[region]	string	false	Область/край
    deliveryAddress[city]	string	false	Город
    deliveryAddress[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	false	Дом
    deliveryAddress[flat]	string	false	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	false	Код домофона
    deliveryAddress[floor]	integer	false	Этаж
    deliveryAddress[block]	integer	false	Подъезд
    deliveryAddress[house]	string	false	Строение/Корпус
    deliveryAddress[metro]	string	false	Метро
    deliveryAddress[notes]	string	false	Дополнительные заметки
    deliveryAddress[text]	string	false	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	false	Время доставки
    deliveryCost	double	false	Стоимость доставки.
    discount	double	false	Скидка на заказ в рублях
    discountPercent	double	false	Скидка на заказ в процентах
    mark	integer	false	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	false	Дата и время получение оценки от покупателя.
    lastName	string	false	Фамилия контактного лица.
    firstName	string	false	Имя контактного лица.
    patronymic	string	false	Отчество контактного лица.
    phone	string	false	Контактный телефон.
    email	string	false	Контактный email.
    call	boolean	false	Требуется звонок
    expired	boolean	false	Время обработки заказа было просрочено.
    customerComment	string	false	Комментарий клиента.
    managerComment	string	false	Комментарий менеджера.
    paymentDetail	string	false	Рекизиты для оплаты
    deliveryService	object (DeliveryService)	false	Служба доставки.
    deliveryService[name]	string	false	Название службы доставки.
    deliveryService[code]	string	false	Символьный код
    statusComment	string	false	Последний комментарий к статусу
    customFields	array	false	Ассоциативный массив пользовательских полей
    orderType	string	false	Тип заказа.
    orderMethod	string	false	Способ оформления заказа.
    customerId	string	false	Клиент, который сделал заказ.
    deliveryType	string	false	Тип доставки.
    paymentType	string	false	Тип оплаты.
    paymentStatus	string	false	Статус оплаты.
    status	string	false	Текущий статус заказа.
    sourceId	string	false	Источник заказа.
    items[]	array of objects (SerializedOrderProduct)	false	Товары заказа
    items[][initialPrice]	double	false	Цена товара
    items[][purchasePrice]	double	false	Закупочная цена
    items[][discount]	double	false	Скидка в рублях на одну штуку
    items[][discountPercent]	double	false	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	false	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	false	Количество
    items[][comment]	string	false	Комментарий к товару в заказе
    items[][productId]	string	false	Идентификатор товара или торгового предложения с внешнего сайта
    items[][productName]	string	false	Название товара
    items[][status]	string	false	Статус товара

    Status Codes

    Status Code	Description
    200	Данные заказа изменены
    201	Заказ создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/orders/{id}

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    id	\w+

    Filters

    Name	Information
    by	Values id|extarnalId Default externalId Description Search by id or externalId.

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    number	string	>=1.0	Номер заказа
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    orderType	string	>=1.0	Тип заказа.
    orderMethod	string	>=1.0	Способ оформления заказа.
    createdAt	DateTime	>=1.0	Дата и время создания. (Y-m-d H:i:s)
    deliveryDate	DateTime	>=1.0	Дата доставки.
    deliveryAddress	object (OrderDeliveryAddress)	>=1.0	Адрес доставки.
    deliveryAddress[index]	string	>=1.0	Почтовый индекс
    deliveryAddress[country]	string	>=1.0	Страна
    deliveryAddress[region]	string	>=1.0	Область/край
    deliveryAddress[city]	string	>=1.0	Город
    deliveryAddress[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    deliveryAddress[building]	string	>=1.0	Дом
    deliveryAddress[flat]	string	>=1.0	Номер квартиры или офиса
    deliveryAddress[intercomCode]	string	>=1.0	Код домофона
    deliveryAddress[floor]	integer	>=1.0	Этаж
    deliveryAddress[block]	integer	>=1.0	Подъезд
    deliveryAddress[house]	string	>=1.0	Строение/Корпус
    deliveryAddress[metro]	string	>=1.0	Метро
    deliveryAddress[notes]	string	>=1.0	Дополнительные заметки
    deliveryAddress[text]	string	>=1.0	Адрес в виде строки
    deliveryAddress[deliveryTime]	string	>=1.0	Время доставки
    deliveryCost	double	>=1.0	Стоимость доставки.
    summ	double	>=1.0	Общая сумма по товарам.
    totalSumm	double	>=1.0	Общая сумма c учетом скидок и доставки
    purchaseSumm	double	>=1.0	Общая сумма закупки
    discount	double	>=1.0	Скидка на заказ в рублях
    discountPercent	double	>=1.0	Скидка на заказ в процентах
    mark	integer	>=1.0	Оценка сервиса покупателем от 0 до 10.
    markDatetime	DateTime	>=1.0	Дата и время получение оценки от покупателя.
    lastName	string	>=1.0	Фамилия контактного лица.
    firstName	string	>=1.0	Имя контактного лица.
    patronymic	string	>=1.0	Отчество контактного лица.
    phone	string	>=1.0	Контактный телефон.
    email	string	>=1.0	Контактный email.
    call	boolean	>=1.0	Требуется звонок
    expired	boolean	>=1.0	Время обработки заказа было просрочено.
    customerComment	string	>=1.0	Комментарий клиента.
    managerComment	string	>=1.0	Комментарий менеджера.
    paymentDetail	string	>=1.0	Рекизиты для оплаты
    customer	object (Customer)	>=1.0	Клиент, который сделал заказ.
    customer[id]	integer	>=1.0	Автоинкрементальный идентификатор.
    customer[externalId]	string	>=1.0	Идентификатор с внешнего сайта
    customer[firstName]	string	>=1.0	Имя клиента
    customer[lastName]	string	>=1.0	Фамилия клиента
    customer[patronymic]	string	>=1.0	Отчество клиента
    customer[email]	string	>=1.0	Электронный адрес
    customer[phones][]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    customer[phones][][number]	string	>=1.0	Номер телефона.
    customer[address]	object (CustomerAddress)	>=1.0	Адреса заказчика
    customer[address][index]	string	>=1.0	Почтовый индекс
    customer[address][country]	string	>=1.0	Страна
    customer[address][region]	string	>=1.0	Область/край
    customer[address][city]	string	>=1.0	Город
    customer[address][street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    customer[address][building]	string	>=1.0	Дом
    customer[address][flat]	string	>=1.0	Номер квартиры или офиса
    customer[address][intercomCode]	string	>=1.0	Код домофона
    customer[address][floor]	integer	>=1.0	Этаж
    customer[address][block]	integer	>=1.0	Подъезд
    customer[address][house]	string	>=1.0	Строение/Корпус
    customer[address][metro]	string	>=1.0	Метро
    customer[address][notes]	string	>=1.0	Дополнительные заметки
    customer[address][text]	string	>=1.0	Адрес в виде строки
    customer[createdAt]	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    customer[vip]	boolean	>=1.0	Важный клиент
    customer[commentary]	string	>=1.0	Комментарий оператора
    customer[contragentType]	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    customer[legalName]	string	>=1.0	Полное наименование
    customer[legalAddress]	string	>=1.0	Адрес регистрации (Юридический адрес)
    customer[INN]	string	>=1.0	ИНН
    customer[OKPO]	string	>=1.0	ОКПО
    customer[KPP]	string	>=1.0	КПП
    customer[OGRN]	string	>=1.0	ОГРН
    customer[OGRNIP]	string	>=1.0	ОГРНИП
    customer[certificateNumber]	string	>=1.0	Номер свидетельства
    customer[certificateDate]	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    customer[BIK]	string	>=1.0	БИК
    customer[bank]	string	>=1.0	Банк
    customer[bankAddress]	string	>=1.0	Адрес банка
    customer[corrAccount]	string	>=1.0	Корреспондентский счет
    customer[bankAccount]	string	>=1.0	Расчетный счет
    customer[customFields]	array	>=1.0	Ассоциативный массив пользовательских полей
    deliveryType	string	>=1.0	Тип доставки.
    deliveryService	object (DeliveryService)	>=1.0	Служба доставки.
    deliveryService[name]	string	>=1.0	Название службы доставки.
    deliveryService[code]	string	>=1.0	Символьный код
    deliveryService[deliveryType]	string	>=1.0	Тип доставки.
    paymentType	string	>=1.0	Тип оплаты.
    paymentStatus	string	>=1.0	Статус оплаты.
    status	string	>=1.0	Текущий статус заказа.
    statusComment	string	>=1.0	Последний комментарий к статусу
    sourceId	string	>=1.0	Источник заказа.
    items[]	array of objects (OrderProduct)	>=1.0	Товары заказа
    items[][id]	integer	>=1.0
    items[][initialPrice]	double	>=1.0	Цена товара
    items[][purchasePrice]	double	>=1.0	Закупочная цена
    items[][discount]	double	>=1.0	Скидка в рублях на одну штуку
    items[][discountPercent]	double	>=1.0	Скидка в процентах на одну штуку
    items[][createdAt]	DateTime	>=1.0	Дата и время добавления позиции (Y-m-d H:i:s)
    items[][quantity]	integer	>=1.0	Количество
    items[][status]	string	>=1.0	Статус товара в заказе
    items[][isCanceled]	boolean	>=1.0	Товар в статусе отмены
    items[][statusUpdatedAt]	DateTime	>=1.0	Дата и время изменения статуса (Y-m-d H:i:s)
    items[][comment]	string	>=1.0	Комментарий к товару в заказе
    items[][offer]	object (Offer)	>=1.0
    items[][offer][externalId]	string	>=1.0	Идентификатор с внешнего сайта
    items[][offer][xmlId]	string	>=1.0	Идентификатор 1С
    items[][offer][name]	string	>=1.0	Название (указывается, если не совпадает с названием товара).
    items[][offer][delete_candidate]	boolean	>=1.0
    fromApi	boolean	>=2.0	Заказ оформлен через API
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует
    404	Заказ не найден

Клиенты

• • POST /api/v1/customers/create

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customer	JSON		Customer JSON object.

    Parameters

    Parameter	Type	Required?	Description
    externalId	string	false	Идентификатор с внешнего сайта
    firstName	string	false	Имя клиента
    lastName	string	false	Фамилия клиента
    patronymic	string	false	Отчество клиента
    email	string	false	Электронный адрес
    phones[]	array of objects (CustomerPhone)	false	Телефоны заказчика.
    phones[][number]	string	false	Номер телефона.
    address	object (CustomerAddress)	false	Адреса заказчика
    address[index]	string	false	Почтовый индекс
    address[country]	string	false	Страна
    address[region]	string	false	Область/край
    address[city]	string	false	Город
    address[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	false	Дом
    address[flat]	string	false	Номер квартиры или офиса
    address[intercomCode]	string	false	Код домофона
    address[floor]	integer	false	Этаж
    address[block]	integer	false	Подъезд
    address[house]	string	false	Строение/Корпус
    address[metro]	string	false	Метро
    address[notes]	string	false	Дополнительные заметки
    address[text]	string	false	Адрес в виде строки
    createdAt	DateTime	false	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	false	Важный клиент
    commentary	string	false	Комментарий оператора
    contragentType	string	false	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	false	Полное наименование
    legalAddress	string	false	Адрес регистрации (Юридический адрес)
    INN	string	false	ИНН
    OKPO	string	false	ОКПО
    KPP	string	false	КПП
    OGRN	string	false	ОГРН
    OGRNIP	string	false	ОГРНИП
    certificateNumber	string	false	Номер свидетельства
    certificateDate	DateTime	false	Дата свидетельства (Y-m-d)
    BIK	string	false	БИК
    bank	string	false	Банк
    bankAddress	string	false	Адрес банка
    corrAccount	string	false	Корреспондентский счет
    bankAccount	string	false	Расчетный счет
    customFields	array	false	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    201	Пользователь создан
    400	Не верный запрос Пользователь с таким id уже существует
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/customers/fix-external-ids

    • У клиентов, выбранных по id, перезаписывает externalId.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customers	JSON		JSON array [[id,externalId],[id,externalId]]

    Status Codes

    Status Code	Description
    200	externalId исправлены
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/customers/upload

    • Пакетная загрузка клиентов. Возвращает массив uploaded содержащий id и externalId добавленных клиентов
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customers	JSON		JSON array of customers

    Parameters

    Parameter	Type	Required?	Description
    externalId	string	false	Идентификатор с внешнего сайта
    firstName	string	false	Имя клиента
    lastName	string	false	Фамилия клиента
    patronymic	string	false	Отчество клиента
    email	string	false	Электронный адрес
    phones[]	array of objects (CustomerPhone)	false	Телефоны заказчика.
    phones[][number]	string	false	Номер телефона.
    address	object (CustomerAddress)	false	Адреса заказчика
    address[index]	string	false	Почтовый индекс
    address[country]	string	false	Страна
    address[region]	string	false	Область/край
    address[city]	string	false	Город
    address[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	false	Дом
    address[flat]	string	false	Номер квартиры или офиса
    address[intercomCode]	string	false	Код домофона
    address[floor]	integer	false	Этаж
    address[block]	integer	false	Подъезд
    address[house]	string	false	Строение/Корпус
    address[metro]	string	false	Метро
    address[notes]	string	false	Дополнительные заметки
    address[text]	string	false	Адрес в виде строки
    createdAt	DateTime	false	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	false	Важный клиент
    commentary	string	false	Комментарий оператора
    contragentType	string	false	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	false	Полное наименование
    legalAddress	string	false	Адрес регистрации (Юридический адрес)
    INN	string	false	ИНН
    OKPO	string	false	ОКПО
    KPP	string	false	КПП
    OGRN	string	false	ОГРН
    OGRNIP	string	false	ОГРНИП
    certificateNumber	string	false	Номер свидетельства
    certificateDate	DateTime	false	Дата свидетельства (Y-m-d)
    BIK	string	false	БИК
    bank	string	false	Банк
    bankAddress	string	false	Адрес банка
    corrAccount	string	false	Корреспондентский счет
    bankAccount	string	false	Расчетный счет
    customFields	array	false	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    201	Клиенты загружены
    403	Не передан apiKey Такого apiKey не существует
    460	Во время загрузки возникли ошибки. Часть клиентов не загружена. Сообщение об ошибке в errorMsg. Детализация списка ошибок в errors.

  • POST /api/v1/customers/{externalId}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customer	JSON		Customer JSON object.
    externalId	\w+

    Parameters

    Parameter	Type	Required?	Description
    externalId	string	false	Идентификатор с внешнего сайта
    firstName	string	false	Имя клиента
    lastName	string	false	Фамилия клиента
    patronymic	string	false	Отчество клиента
    email	string	false	Электронный адрес
    phones[]	array of objects (CustomerPhone)	false	Телефоны заказчика.
    phones[][number]	string	false	Номер телефона.
    address	object (CustomerAddress)	false	Адреса заказчика
    address[index]	string	false	Почтовый индекс
    address[country]	string	false	Страна
    address[region]	string	false	Область/край
    address[city]	string	false	Город
    address[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	false	Дом
    address[flat]	string	false	Номер квартиры или офиса
    address[intercomCode]	string	false	Код домофона
    address[floor]	integer	false	Этаж
    address[block]	integer	false	Подъезд
    address[house]	string	false	Строение/Корпус
    address[metro]	string	false	Метро
    address[notes]	string	false	Дополнительные заметки
    address[text]	string	false	Адрес в виде строки
    createdAt	DateTime	false	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	false	Важный клиент
    commentary	string	false	Комментарий оператора
    contragentType	string	false	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	false	Полное наименование
    legalAddress	string	false	Адрес регистрации (Юридический адрес)
    INN	string	false	ИНН
    OKPO	string	false	ОКПО
    KPP	string	false	КПП
    OGRN	string	false	ОГРН
    OGRNIP	string	false	ОГРНИП
    certificateNumber	string	false	Номер свидетельства
    certificateDate	DateTime	false	Дата свидетельства (Y-m-d)
    BIK	string	false	БИК
    bank	string	false	Банк
    bankAddress	string	false	Адрес банка
    corrAccount	string	false	Корреспондентский счет
    bankAccount	string	false	Расчетный счет
    customFields	array	false	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Данные пользователя изменены
    201	Пользователь создан
    400	Не верный запрос
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/customers/{id}

    • Получение сведений о клиенте
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    id	\w+

    Filters

    Name	Information
    by	Values id|extarnalId Default externalId Description Search by id or externalId.

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    firstName	string	>=1.0	Имя клиента
    lastName	string	>=1.0	Фамилия клиента
    patronymic	string	>=1.0	Отчество клиента
    email	string	>=1.0	Электронный адрес
    phones[]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    phones[][number]	string	>=1.0	Номер телефона.
    address	object (CustomerAddress)	>=1.0	Адреса заказчика
    address[index]	string	>=1.0	Почтовый индекс
    address[country]	string	>=1.0	Страна
    address[region]	string	>=1.0	Область/край
    address[city]	string	>=1.0	Город
    address[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	>=1.0	Дом
    address[flat]	string	>=1.0	Номер квартиры или офиса
    address[intercomCode]	string	>=1.0	Код домофона
    address[floor]	integer	>=1.0	Этаж
    address[block]	integer	>=1.0	Подъезд
    address[house]	string	>=1.0	Строение/Корпус
    address[metro]	string	>=1.0	Метро
    address[notes]	string	>=1.0	Дополнительные заметки
    address[text]	string	>=1.0	Адрес в виде строки
    createdAt	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	>=1.0	Важный клиент
    commentary	string	>=1.0	Комментарий оператора
    contragentType	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	>=1.0	Полное наименование
    legalAddress	string	>=1.0	Адрес регистрации (Юридический адрес)
    INN	string	>=1.0	ИНН
    OKPO	string	>=1.0	ОКПО
    KPP	string	>=1.0	КПП
    OGRN	string	>=1.0	ОГРН
    OGRNIP	string	>=1.0	ОГРНИП
    certificateNumber	string	>=1.0	Номер свидетельства
    certificateDate	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    BIK	string	>=1.0	БИК
    bank	string	>=1.0	Банк
    bankAddress	string	>=1.0	Адрес банка
    corrAccount	string	>=1.0	Корреспондентский счет
    bankAccount	string	>=1.0	Расчетный счет
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует
    404	Пользователь не найден

  • GET /api/v1/customers/{id}/orders

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    id	\w+

    Filters

    Name	Information
    createdAtFrom	Datatype DateTime Default null Description Start of search interval.
    createdAtTo	Datatype DateTime Default null Description End of search interval.
    limit	Datatype integer Default 100 Description Maximum results.
    offset	Datatype integer Default 0 Description Results offset.
    by	Values id|extarnalId Default externalId Description Search by id or externalId.

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует
    404	Пользователь не найден

  • GET /api/v2/customers

    • Получение списка клиентов в соответствии с заданными фильтрами. Возвращает массив объектов клиентов
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Filters

    Name	Information
    phone	Datatype string Default null Description Email to filter result
    fio	Datatype string Default null Description Fio to filter result
    limit	Datatype integer Default 200 Description Size of selection
    offset	Datatype integer Default 0 Description Offset of selection

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    firstName	string	>=1.0	Имя клиента
    lastName	string	>=1.0	Фамилия клиента
    patronymic	string	>=1.0	Отчество клиента
    email	string	>=1.0	Электронный адрес
    phones[]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    phones[][number]	string	>=1.0	Номер телефона.
    address	object (CustomerAddress)	>=1.0	Адреса заказчика
    address[index]	string	>=1.0	Почтовый индекс
    address[country]	string	>=1.0	Страна
    address[region]	string	>=1.0	Область/край
    address[city]	string	>=1.0	Город
    address[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	>=1.0	Дом
    address[flat]	string	>=1.0	Номер квартиры или офиса
    address[intercomCode]	string	>=1.0	Код домофона
    address[floor]	integer	>=1.0	Этаж
    address[block]	integer	>=1.0	Подъезд
    address[house]	string	>=1.0	Строение/Корпус
    address[metro]	string	>=1.0	Метро
    address[notes]	string	>=1.0	Дополнительные заметки
    address[text]	string	>=1.0	Адрес в виде строки
    createdAt	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	>=1.0	Важный клиент
    commentary	string	>=1.0	Комментарий оператора
    contragentType	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	>=1.0	Полное наименование
    legalAddress	string	>=1.0	Адрес регистрации (Юридический адрес)
    INN	string	>=1.0	ИНН
    OKPO	string	>=1.0	ОКПО
    KPP	string	>=1.0	КПП
    OGRN	string	>=1.0	ОГРН
    OGRNIP	string	>=1.0	ОГРНИП
    certificateNumber	string	>=1.0	Номер свидетельства
    certificateDate	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    BIK	string	>=1.0	БИК
    bank	string	>=1.0	Банк
    bankAddress	string	>=1.0	Адрес банка
    corrAccount	string	>=1.0	Корреспондентский счет
    bankAccount	string	>=1.0	Расчетный счет
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/customers/create

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customer	JSON		Customer JSON object.

    Parameters

    Parameter	Type	Required?	Description
    externalId	string	false	Идентификатор с внешнего сайта
    firstName	string	false	Имя клиента
    lastName	string	false	Фамилия клиента
    patronymic	string	false	Отчество клиента
    email	string	false	Электронный адрес
    phones[]	array of objects (CustomerPhone)	false	Телефоны заказчика.
    phones[][number]	string	false	Номер телефона.
    address	object (CustomerAddress)	false	Адреса заказчика
    address[index]	string	false	Почтовый индекс
    address[country]	string	false	Страна
    address[region]	string	false	Область/край
    address[city]	string	false	Город
    address[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	false	Дом
    address[flat]	string	false	Номер квартиры или офиса
    address[intercomCode]	string	false	Код домофона
    address[floor]	integer	false	Этаж
    address[block]	integer	false	Подъезд
    address[house]	string	false	Строение/Корпус
    address[metro]	string	false	Метро
    address[notes]	string	false	Дополнительные заметки
    address[text]	string	false	Адрес в виде строки
    createdAt	DateTime	false	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	false	Важный клиент
    commentary	string	false	Комментарий оператора
    contragentType	string	false	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	false	Полное наименование
    legalAddress	string	false	Адрес регистрации (Юридический адрес)
    INN	string	false	ИНН
    OKPO	string	false	ОКПО
    KPP	string	false	КПП
    OGRN	string	false	ОГРН
    OGRNIP	string	false	ОГРНИП
    certificateNumber	string	false	Номер свидетельства
    certificateDate	DateTime	false	Дата свидетельства (Y-m-d)
    BIK	string	false	БИК
    bank	string	false	Банк
    bankAddress	string	false	Адрес банка
    corrAccount	string	false	Корреспондентский счет
    bankAccount	string	false	Расчетный счет
    customFields	array	false	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    201	Пользователь создан
    400	Не верный запрос Пользователь с таким id уже существует
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/customers/fix-external-ids

    • У клиентов, выбранных по id, перезаписывает externalId.
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customers	JSON		JSON array [[id,externalId],[id,externalId]]

    Status Codes

    Status Code	Description
    200	externalId исправлены
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/customers/upload

    • Пакетная загрузка клиентов. Возвращает массив uploaded содержащий id и externalId добавленных клиентов
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customers	JSON		JSON array of customers

    Parameters

    Parameter	Type	Required?	Description
    externalId	string	false	Идентификатор с внешнего сайта
    firstName	string	false	Имя клиента
    lastName	string	false	Фамилия клиента
    patronymic	string	false	Отчество клиента
    email	string	false	Электронный адрес
    phones[]	array of objects (CustomerPhone)	false	Телефоны заказчика.
    phones[][number]	string	false	Номер телефона.
    address	object (CustomerAddress)	false	Адреса заказчика
    address[index]	string	false	Почтовый индекс
    address[country]	string	false	Страна
    address[region]	string	false	Область/край
    address[city]	string	false	Город
    address[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	false	Дом
    address[flat]	string	false	Номер квартиры или офиса
    address[intercomCode]	string	false	Код домофона
    address[floor]	integer	false	Этаж
    address[block]	integer	false	Подъезд
    address[house]	string	false	Строение/Корпус
    address[metro]	string	false	Метро
    address[notes]	string	false	Дополнительные заметки
    address[text]	string	false	Адрес в виде строки
    createdAt	DateTime	false	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	false	Важный клиент
    commentary	string	false	Комментарий оператора
    contragentType	string	false	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	false	Полное наименование
    legalAddress	string	false	Адрес регистрации (Юридический адрес)
    INN	string	false	ИНН
    OKPO	string	false	ОКПО
    KPP	string	false	КПП
    OGRN	string	false	ОГРН
    OGRNIP	string	false	ОГРНИП
    certificateNumber	string	false	Номер свидетельства
    certificateDate	DateTime	false	Дата свидетельства (Y-m-d)
    BIK	string	false	БИК
    bank	string	false	Банк
    bankAddress	string	false	Адрес банка
    corrAccount	string	false	Корреспондентский счет
    bankAccount	string	false	Расчетный счет
    customFields	array	false	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    201	Клиенты загружены
    403	Не передан apiKey Такого apiKey не существует
    460	Во время загрузки возникли ошибки. Часть клиентов не загружена. Сообщение об ошибке в errorMsg. Детализация списка ошибок в errors.

  • POST /api/v2/customers/{externalId}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    customer	JSON		Customer JSON object.
    externalId	\w+

    Parameters

    Parameter	Type	Required?	Description
    externalId	string	false	Идентификатор с внешнего сайта
    firstName	string	false	Имя клиента
    lastName	string	false	Фамилия клиента
    patronymic	string	false	Отчество клиента
    email	string	false	Электронный адрес
    phones[]	array of objects (CustomerPhone)	false	Телефоны заказчика.
    phones[][number]	string	false	Номер телефона.
    address	object (CustomerAddress)	false	Адреса заказчика
    address[index]	string	false	Почтовый индекс
    address[country]	string	false	Страна
    address[region]	string	false	Область/край
    address[city]	string	false	Город
    address[street]	string	false	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	false	Дом
    address[flat]	string	false	Номер квартиры или офиса
    address[intercomCode]	string	false	Код домофона
    address[floor]	integer	false	Этаж
    address[block]	integer	false	Подъезд
    address[house]	string	false	Строение/Корпус
    address[metro]	string	false	Метро
    address[notes]	string	false	Дополнительные заметки
    address[text]	string	false	Адрес в виде строки
    createdAt	DateTime	false	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	false	Важный клиент
    commentary	string	false	Комментарий оператора
    contragentType	string	false	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	false	Полное наименование
    legalAddress	string	false	Адрес регистрации (Юридический адрес)
    INN	string	false	ИНН
    OKPO	string	false	ОКПО
    KPP	string	false	КПП
    OGRN	string	false	ОГРН
    OGRNIP	string	false	ОГРНИП
    certificateNumber	string	false	Номер свидетельства
    certificateDate	DateTime	false	Дата свидетельства (Y-m-d)
    BIK	string	false	БИК
    bank	string	false	Банк
    bankAddress	string	false	Адрес банка
    corrAccount	string	false	Корреспондентский счет
    bankAccount	string	false	Расчетный счет
    customFields	array	false	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Данные пользователя изменены
    201	Пользователь создан
    400	Не верный запрос
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/customers/{id}

    • Получение сведений о клиенте
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    id	\w+

    Filters

    Name	Information
    by	Values id|extarnalId Default externalId Description Search by id or externalId.

    Return

    Parameter	Type	Versions	Description
    id	integer	>=1.0	Автоинкрементальный идентификатор.
    externalId	string	>=1.0	Идентификатор с внешнего сайта
    firstName	string	>=1.0	Имя клиента
    lastName	string	>=1.0	Фамилия клиента
    patronymic	string	>=1.0	Отчество клиента
    email	string	>=1.0	Электронный адрес
    phones[]	array of objects (CustomerPhone)	>=1.0	Телефоны заказчика.
    phones[][number]	string	>=1.0	Номер телефона.
    address	object (CustomerAddress)	>=1.0	Адреса заказчика
    address[index]	string	>=1.0	Почтовый индекс
    address[country]	string	>=1.0	Страна
    address[region]	string	>=1.0	Область/край
    address[city]	string	>=1.0	Город
    address[street]	string	>=1.0	Название улицы, шоссе, проспекта, проезда...
    address[building]	string	>=1.0	Дом
    address[flat]	string	>=1.0	Номер квартиры или офиса
    address[intercomCode]	string	>=1.0	Код домофона
    address[floor]	integer	>=1.0	Этаж
    address[block]	integer	>=1.0	Подъезд
    address[house]	string	>=1.0	Строение/Корпус
    address[metro]	string	>=1.0	Метро
    address[notes]	string	>=1.0	Дополнительные заметки
    address[text]	string	>=1.0	Адрес в виде строки
    createdAt	DateTime	>=1.0	Дата создания и время создания. (Y-m-d H:i:s)
    vip	boolean	>=1.0	Важный клиент
    commentary	string	>=1.0	Комментарий оператора
    contragentType	string	>=1.0	Тип контрагента: физ. лицо (individual), юр. лицо (legal-entity), ИП (enterpreneur). Физическое лицо (individual) по умолчанию
    legalName	string	>=1.0	Полное наименование
    legalAddress	string	>=1.0	Адрес регистрации (Юридический адрес)
    INN	string	>=1.0	ИНН
    OKPO	string	>=1.0	ОКПО
    KPP	string	>=1.0	КПП
    OGRN	string	>=1.0	ОГРН
    OGRNIP	string	>=1.0	ОГРНИП
    certificateNumber	string	>=1.0	Номер свидетельства
    certificateDate	DateTime	>=1.0	Дата свидетельства (Y-m-d)
    BIK	string	>=1.0	БИК
    bank	string	>=1.0	Банк
    bankAddress	string	>=1.0	Адрес банка
    corrAccount	string	>=1.0	Корреспондентский счет
    bankAccount	string	>=1.0	Расчетный счет
    customFields	array	>=1.0	Ассоциативный массив пользовательских полей

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует
    404	Пользователь не найден

  • GET /api/v2/customers/{id}/orders

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    id	\w+

    Filters

    Name	Information
    createdAtFrom	Datatype DateTime Default null Description Start of search interval.
    createdAtTo	Datatype DateTime Default null Description End of search interval.
    limit	Datatype integer Default 100 Description Maximum results.
    offset	Datatype integer Default 0 Description Results offset.
    by	Values id|extarnalId Default externalId Description Search by id or externalId.

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует
    404	Пользователь не найден

Справочники

• • GET /api/v1/reference/delivery-services

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/delivery-services/{code}/edit

    • Создание/Редактирование сервиса доставки
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    deliveryService	JSON		Delivery Service JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название службы доставки.
    code	string	false	Символьный код
    deliveryType	string	false	Тип доставки.

    Status Codes

    Status Code	Description
    200	Данные типа доставки изменены
    201	Новый типа доставки создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/delivery-types

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/delivery-types/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    deliveryType	JSON		Delivery Type JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название типа доставки.
    code	string	false	Символьный код
    defaultCost	double	false	Стоимость по-умолчанию.
    description	string	false	Описание.
    paymentTypes	array	false	Массив идентификаторов совместимых типов оплаты
    deliveryServices	array	false	Массив идентификаторов совместимых служб доставки

    Status Codes

    Status Code	Description
    200	Данные типа доставки изменены
    201	Новый типа доставки создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/order-methods

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/order-methods/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orderMethod	JSON		Order Method JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название метода заказа
    code	string	false	Код метода
    defaultForCrm	boolean	false	Способ по умолчанию для заказов из CRM
    defaultForApi	boolean	false	Способ по умолчанию для заказов из API

    Status Codes

    Status Code	Description
    200	Данные способа оформления заказа изменены
    201	Новый способ оформления заказа создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/order-types

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/order-types/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orderType	JSON		Order Type JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название типа заказа
    code	string	false	Код типа
    defaultForApi	boolean	false	Способ по умолчанию для заказов из API

    Status Codes

    Status Code	Description
    200	Данные типа заказа изменены
    201	Новый типа заказа создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/payment-statuses

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/payment-statuses/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    paymentStatus	JSON		Payment Status JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название статус оплаты
    code	string	false	Символьный код
    description	string	false	Описание.

    Status Codes

    Status Code	Description
    200	Статус оплаты изменен
    201	Новый статус оплаты создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/payment-types

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/payment-types/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    paymentType	JSON		Payment Type JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название типа оплаты
    code	string	false	Символьный код
    description	string	false	Описание.
    paymentStatuses	array	false	Массив идентификаторов совместимых статусов оплаты

    Status Codes

    Status Code	Description
    200	Тип оплаты изменен
    201	Новый типа оплаты создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/product-statuses

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/product-statuses/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    productStatus	JSON		Order Status JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    code	string	false	Символьный код
    ordering	integer	false	Порядковый номер
    active	boolean	false	Флаг активности статуса
    name	string	false
    orderStatusByProductStatus	string	false	Статус заказа, который выставляется, если у всех товаров данный статус товара
    orderStatusForProductStatus	string	false	Статус заказа, при котором статус товаров меняется на данный статус товара

    Status Codes

    Status Code	Description
    200	Данные статуса товара изменены
    201	Новый статус товара создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/status-groups

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v1/reference/statuses

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v1/reference/statuses/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    status	JSON		Order Status JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false
    code	string	false	Символьный код
    ordering	integer	false
    statusGroup	string	false	Группа статусов, к которой относится данный статус заказа

    Status Codes

    Status Code	Description
    200	Данные статуса заказа изменены
    201	Новый статус заказа создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/delivery-services

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/delivery-services/{code}/edit

    • Создание/Редактирование сервиса доставки
    • Documentation

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    deliveryService	JSON		Delivery Service JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название службы доставки.
    code	string	false	Символьный код
    deliveryType	string	false	Тип доставки.

    Status Codes

    Status Code	Description
    200	Данные типа доставки изменены
    201	Новый типа доставки создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/delivery-types

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/delivery-types/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    deliveryType	JSON		Delivery Type JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название типа доставки.
    code	string	false	Символьный код
    defaultCost	double	false	Стоимость по-умолчанию.
    description	string	false	Описание.
    paymentTypes	array	false	Массив идентификаторов совместимых типов оплаты
    deliveryServices	array	false	Массив идентификаторов совместимых служб доставки

    Status Codes

    Status Code	Description
    200	Данные типа доставки изменены
    201	Новый типа доставки создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/order-methods

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/order-methods/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orderMethod	JSON		Order Method JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название метода заказа
    code	string	false	Код метода
    defaultForCrm	boolean	false	Способ по умолчанию для заказов из CRM
    defaultForApi	boolean	false	Способ по умолчанию для заказов из API

    Status Codes

    Status Code	Description
    200	Данные способа оформления заказа изменены
    201	Новый способ оформления заказа создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/order-types

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/order-types/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    orderType	JSON		Order Type JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название типа заказа
    code	string	false	Код типа
    defaultForApi	boolean	false	Способ по умолчанию для заказов из API

    Status Codes

    Status Code	Description
    200	Данные типа заказа изменены
    201	Новый типа заказа создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/payment-statuses

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/payment-statuses/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    paymentStatus	JSON		Payment Status JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название статус оплаты
    code	string	false	Символьный код
    description	string	false	Описание.

    Status Codes

    Status Code	Description
    200	Статус оплаты изменен
    201	Новый статус оплаты создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/payment-types

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/payment-types/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    paymentType	JSON		Payment Type JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false	Название типа оплаты
    code	string	false	Символьный код
    description	string	false	Описание.
    paymentStatuses	array	false	Массив идентификаторов совместимых статусов оплаты

    Status Codes

    Status Code	Description
    200	Тип оплаты изменен
    201	Новый типа оплаты создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/product-statuses

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/product-statuses/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    productStatus	JSON		Order Status JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    code	string	false	Символьный код
    ordering	integer	false	Порядковый номер
    active	boolean	false	Флаг активности статуса
    name	string	false
    orderStatusByProductStatus	string	false	Статус заказа, который выставляется, если у всех товаров данный статус товара
    orderStatusForProductStatus	string	false	Статус заказа, при котором статус товаров меняется на данный статус товара

    Status Codes

    Status Code	Description
    200	Данные статуса товара изменены
    201	Новый статус товара создан
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/status-groups

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • GET /api/v2/reference/statuses

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует

  • POST /api/v2/reference/statuses/{code}/edit

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key
    status	JSON		Order Status JSON object
    code	[\w,\-]+

    Parameters

    Parameter	Type	Required?	Description
    name	string	false
    code	string	false	Символьный код
    ordering	integer	false
    statusGroup	string	false	Группа статусов, к которой относится данный статус заказа

    Status Codes

    Status Code	Description
    200	Данные статуса заказа изменены
    201	Новый статус заказа создан
    403	Не передан apiKey Такого apiKey не существует

Статистика

• • GET /api/v1/statistic/update

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

    Requirements

    Name	Requirement	Type	Description
    apiKey	\w+		Api key

    Status Codes

    Status Code	Description
    200	Запрос успешно выполнен
    403	Не передан apiKey Такого apiKey не существует