Skip to main content

Описание методов (old)

Запрос данных аккаунта (публичный)

/api/lite/pub/account_info

Документация обновляется.

 

Получение информации по предзаказу (публичный)

 /api/lite/pub/order

Документация обновляется.

 

Создание / обновление товарного предложения

/api/lite/offer

создает или обновляет (если задан sku.humanID) товарное предложение

 

Запрос:

В ответ возвращается

Успех:

 

Ошибка: 

/api/lite/offer/pos

 

Обновление позиции товарного предложения

/api/lite/offer/pos

Обновляет значение позиции для сортировки предложений в списке 

 

Запрос:

 

 

Ответ:

 

Создание картинки к товарному предложению

/api/lite/offer/image

Загружает на сервер картинку и привязывает изображение к товару.

Используется заголовок запроса Content-type: multipart/form-data.

В качестве параметров запроса передается:

  • id - идентификатор товара
  • upfile - картинка

На стороне сервера:

  • Сохраняется оригинал картинки (но с ограничением в максимальное количество пикселей) - original
  • Сохраняется обрезанное изображение 1х1 (ближе к центру) - cropper
  • Сохраняется миниатюра обрезанного изображения - thumbnail

В ответ возвращается информация о загруженной картинке:

 

Успех:

Параметры:

  • orig - прямая ссылка на оригинал картинки
  • crop - прямая ссылка на кропнутое изображение
  • prev - прямая ссылка
  • id - идентификатор картинки (для последующего обновления или удаления)
  • crop_p - координаты кропнутого изображения относительно оригинала (topLeftX, topLeftY, bottomRightX, bottomRightY)

 

Ошибка: 

 

Загрузка картинки без привязки к предложению

 /api/lite/image

Загружает на сервер картинку в исходных размерах без сжатия.

Используется заголовок запроса Content-type: multipart/form-data.

В качестве параметров запроса передается:

  • upfile - картинка

На стороне сервера:

  • Сохраняется оригинал картинки (без ограничений) - original

В ответ возвращается информация о загруженной картинке:

 

Успех:

Параметры:

  • orig - прямая ссылка на оригинал картинки

 

ошибка: 

 

Обновление кропа картинки к товарному предложению

/api/lite/offer/image/crop

Обновляет параметры кропа (обрезки) у картинки товарного предложения.

 

Запрос:

 

В ответ возвращается результат операции, id обновленной картинки и новый url на кропнутое изображение и превью.

 

Пример успешного ответа:

 

 

В случае ошибки:

 

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

/api/lite/offer/image

Для удаления метки, выполняется следующий POST запрос с указанием идентификатора картинки.

 

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

 

В ответ возвращается результат операции и id удаленной картинки.

 

Пример успешного ответа:

 

В случае ошибки:

 

Обновление позиции картинки

/api/lite/offer/image/pos

Обновляет значение позиции для сортировки картинок в списке 

 

Запрос:


Ответ:

 

В случае ошибки:

 

Создание/обновление заказа

/api/lite/order

Создает новый заказ в системе Кактус или обновляет существующий.

Доставка выгружается как позиция в items (id = "delivery").

Цены позиций задаются в запросе.

 

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

 

В ответ возвращается

успех:

 

ошибка: 

 

Заказ → обновление контактной информации получателя

/api/lite/order/receiver

Возможность обновить только контактную информацию

 

Запрос:

 

В ответ возвращается

успех:

 

ошибка: 

 

Заказ → обновление товарной части

/api/lite/order/items

Возможность обновить только табличную часть заказа

Необходимо в запросе передать новое желаемое состояние табличной части в виде непустого перечня позиций

 

Запрос:

 

В ответ возвращается

успех:

 

ошибка: 

 

Заказ → отменить

 /api/lite/order/cancelled

Производит отмену заказа. 

 

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

 

В ответ возвращается

успех:

 

 

ошибка: 

 

Заказ → пометить оплаченным получателем

/api/lite/order/payment

Ставит статус оплаты покупателем.

 

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

 

В ответ возвращается

успех:

 

ошибка: 

 

Заказ → снять пометку оплаты заказа получателем

/api/lite/order/payment

Снимает статус оплаты покупателем.

 

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

 

 

В ответ возвращается

успех:

 

 

ошибка: 

 

Пример ошибки:

Документация обновляется.

Заказ → получить акт приема передачи

/api/lite/order/takeout_list

Получение печатной формы в pdf для указанного списка заказов

Печатная форма возвращается в формате base64.

 

Пример ошибки:

 

Успех:

 

Ошибка:

 

Оплатить доставку заказа/заказов

 /api/lite/order_delivery_payment

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

После успешного списания - создает заявку на сбор курьером на указанную дату. Если заявка уже есть - новая не создается. Если на указанную дату заявку оформить уже нельзя (опоздал) - автоматом создается заявка на ближайшую возможную дату.

 

Успех:

Возвращается дата и интервал запрошенного приезда курьера.

 

Ошибка:

 

Отменить оплату доставки заказа/заказов

/api/lite/order_delivery_payment

Пока не реализуем этот метод.

Вариант:

Производит отмену списания с баланса доставки указанных заказов, если по ним не было статусов от GD по сбору. Если какие то статусы по заказу поступали от GD - значит они уже забрали груз - тогда все заказы данного реестра отгрузки автоматом помечаются отгруженными и вернуть сумму по ним нельзя. 

 

Оформить вызов курьера

/api/lite/courier_call

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

 

Пример ошибки:

 

Успех:

 

 

Ошибка:

 

Отменить вызов курьера

/api/lite/courier_call

Отменяет заявку на вызов курьера, если заявка на эту дату и интервал есть. если заявки нет - возвращает ошибку.

Пример ошибки:

 

Успех:

 

Ошибка:

 

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

/api/lite/transaction

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

 

Пример ошибки:

 

 

Ошибка:

 

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

 /api/lite/order/transaction

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

запрос должен содержать параметр orderId с номером заказа, например

?orderId=1020

 

Результат запроса:

 

 

Ошибка:

 

Создать счет на оплату и получить информацию для оплаты

/api/lite/payment

 

Запрос:

 

Ответ:

 

Для работы в песочнице PayU использовать карты из https://secure.payu.ru/docs/integration-sandbox/ru/

 

Пример формы, которую нужно сгенерировать на клиенте:

 

Получить список своих курьеров

/api/lite/own_courier

Получение списка своих курьеров.

Пример ошибки:

 

Ошибка:

 

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

/api/lite/own_courier

Создание или обновление (если задан id) своего курьера

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

 

Ошибка:

 

Удаление курьера

/api/lite/own_courier

Для удаления курьера, выполняется следующий POST запрос с указанием идентификатора курьера.

 

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


В ответ возвращается результат операции

Пример успешного ответа:

В случае ошибки:

 

Заказ - отметить доставку

/api/lite/delivery_result

Для доставки своими курьерами - простановка результата доставки: доставлен/отказ/утеря.

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

 

Ошибка:

 

Ответ:

Документация обновляется.

 

Пример ошибки:

Документация обновляется.

 

Записать данные собственного аккаунта Робокасса

/api/lite/settings/payment/robokassa

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

 

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

 

Результат запроса:

 

Ошибка:

Документация обновляется.

 

Получить макет витрины(публичный)

 /api/lite/pub/settings/template

Получение макета витрины магазина аккаунта, в формате, предназначенном для ui витрины

 

Результат запроса:

 

Ошибка:

 

Получить макеты витрин

/api/lite/settings/template

Получение перечня макетов витрин магазинов аккаунта, в формате, предназначенном для ui конструктора витрины

Для получения одного макета по id - использовать параметр в url вида ?id=123456

 

Результат запроса:

 

Ошибка:

 

 

Создать/обновить макет витрины

/api/lite/settings/template

Создание/обновление данных о макете витрины в формате для ui конструтора

 

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

 

Результат запроса:

 

Ошибка:

 

Удалить макет витрины

/api/lite/settings/template

Удаление одного макета. Использовать параметр в url вида     ?id=123456

 

Результат запроса:

 

Ошибка:

 

Получить общие макеты витрин

/api/lite/settings/template/general

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

Для получения одного макета по id - использовать параметр в url вида     ?id=123456

 

Результат запроса:

 

Ошибка:

 

Получить общие шаблоны блоков витрин

/api/lite/settings/template/block

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

Для получения одного блока по id - использовать параметр в url вида     ?id=123456

 

Результат запроса:

 

Ошибка:

 

Получить заявки на сбор

/api/lite/gather

Получение списка заявок на сбор, сортировка - свежие по полю date - сначала

 

Результат запроса: 

 

Ошибка:

 

 

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

/api/lite/pub/courier_pack

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

 

Результат запроса:

 

Ошибка:

 

Создать пользователя для Expert

 /api/lite/settings/go-expert

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

Логин равен логину исходного аккаунта (тенанта) + суффикс "-expert", например: manager@shop.ru-expert

Пароль равен паролю исходного аккаунта. При смене пароля исходного пользователя - expert логин останется с прошлым паролем.

Параметр URL:     ?с=123    - проверочный код.

 

Результат запроса:

 

Ошибка: