Перейти к основному контенту

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

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

/api/lite/pub/account_info

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


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

 /api/lite/pub/order

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


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

/api/lite/offer

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

Запрос:

19
 
1
{
2
     "sku": {    
3
                "id": "12345",  - опциональный параметр, только для обновления существующего предложения. значение генерируется при создании предложения.           
4
                "shortName": "краткое наименование",
5
                "fullName": "полное наименование",
6
                "article": "234234",
7
                "description": "описание"
8
            },  
9
     "price": 33.45,  
10
     "discountPrice": 20,
11
     "weight": 357,  - единица измерения: грамм
12
     "dimensions":{
13
                "height":12,  - единица измерения: сантиметр
14
                "width":20,  - единица измерения: сантиметр
15
                "depth":8  - единица измерения: сантиметр
16
                },
17
     "enabled":true,
18
     "pos": 123.456            
19
}

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

Успех:

6
 
1
{
2
"success": true,
3
​
4
"humanId": "12345"
5
​
6
}


ошибка: 

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

Обновление позиции товарного предложения(/api/lite/offer/pos)

POST /api/lite/offer/pos

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

Запрос:

Пример результата запроса
{
  "id": "1002",
  "pos": 123.456
}


Ответ

Пример успешного ответа
{
  "success": true
}

Создание картинки к товарному предложению (/api/lite/offer/image)

POST /api/lite/offer/image

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

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

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

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


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

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



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

Успех
{
  "success": true,
  "image": {
    "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
    "pos": 123.456,
    "crop_p": [
      10,
      500,
      400,
      150
    ]
  }
}

Параметры:

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



ошибка: 

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


Загрузка картинки без привязки к предложению (/api/lite/image)

POST /api/lite/image

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

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

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

  • upfile - картинка


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

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


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

Успех
{
  "success": true,
}

Параметры:

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


ошибка: 

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


Обновление кропа картинки к товарному предложению (/api/lite/offer/image/crop)

POST /api/lite/offer/image/crop

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

Запрос:

Пример результата запроса
{
  "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
  "crop_p": [
    10,
    500,
    400,
    150
  ]
}


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

Пример успешного ответа
{
  "success": true,
  "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
}


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

Пример ошибки
{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "Картинки с указанным id не существует"
    }
  ]
}



Удаление картинки у товарного предложения (/api/lite/offer/image)

DELETE /api/lite/offer/image


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

Пример запроса
{ 
   "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF" 
}


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

Пример успешного ответа
{
  "success": true,
  "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF"
}

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

Пример ошибки
{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "Картинки с указанным id не существует"
    }
  ]
}


Обновление позиции картинки (/api/lite/offer/image/pos)

POST /api/lite/offer/image/pos

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

Запрос:

Пример результата запроса
{
  "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF",
  "pos": 123.456
}


Ответ

Пример успешного ответа
{
  "success": true
}


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

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



Создание/обновление заказа (/api/lite/order)

POST /api/lite/order

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

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

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

Пример запроса
{
    "order": {
        "comment": "",
        "confirmStatus": "NEED_CONFIRM",
        "paymentStatus": "NOT_PAID",
        "paymentMethodCode": "online",
        "totalOrderSum": 1212,
        "delivery": {
            "receiver": {
                "name": "Олег",
                "surname": "Коробов",
                "patronymic": "",
                "phone": "9153112255",
                "alternativePhone": "",
                "email": "korobov.oleg@gmail.com"
            },
            "deliveryCode": "courier",
            "timeFrom": "10:30",
            "timeTo": "20:00",
            "desiredDeliveryDate": "2018-10-18",
            "deliveryComment": "",
            "address": {
                "regionFias":"18133adf-90c2-438e-88c4-62c41656de70",
                "areaFias":"b502ae45-897e-4b6f-9776-6ff49740b537",
                "cityFias":"",
                "settlementFias":"",
                "country": "RU",
                "region": "Москва",
                "area": "",
                "city": "Москва",
                "settlement": "",
                "street": "Боровское ш.",
                "house": "20",
                "block": "",
                "building": "",
                "flat": "120",
                "fullAddress": "",
                "zip": ""
            },
            "pickupPointId": ""
        },
        "items": [
            {
                "num":1,
                "id": "48488",
                "quantity": 1,
                "price": 1212
            }
        ]
    }
}

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

успех:

{
"success": true,

1
 
1
"orderId": "12345"

}


ошибка: 

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



Заказ → обновление контактной информации получателя (/api/lite/order/receiver)

POST /api/lite/order/receiver

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


Запрос

Пример запроса
{
     "orderId": "1234",
     "name": "Олег",
     "surname": "Коробов",
     "patronymic": "",
     "phone": "9153112255",
     "alternativePhone": "",
     "email": "korobov.oleg@gmail.com"
            
}

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

успех:

{
"success": true

}


ошибка: 

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


Заказ → обновление товарной части (/api/lite/order/items)

POST /api/lite/order/items

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

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

Запрос

Пример запроса
{
    "orderId": "1234", 
    "items": [
            {
                "num":1,
                "id": "48488",
                "quantity": 1,
                "price": 1212
            }
        ]
            
}

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

успех:

{
"success": true

}


ошибка: 

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




Заказ → отменить(/api/lite/order/cancelled)

POST /api/lite/order/cancelled

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

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

{ 
"orderId":"1029" 
}

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

успех:

{
"success": true

}


ошибка: 

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

Заказ → пометить оплаченным получателем (/api/lite/order/payment)

POST /api/lite/order/payment

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


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

{ 
"orderId":"1029" 
}

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

успех:

{
"success": true

}


ошибка: 

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

Заказ → снять пометку оплаты заказа получателем (/api/lite/order/payment)

DELETE /api/lite/order/payment

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


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

{ 
"orderId":"1029" 
}

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

успех:

{
"success": true

}


ошибка: 

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


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

Заказ → получить акт приема передачи (/api/lite/order/takeout_list)

POST /api/lite/order/takeout_list

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

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


Пример ошибки
{
  "orders": ["1001", "1002", "1003"]
}

Успех:

Пример ошибки
{
  "success": true, 
  "content" : "base64data"
     
}


Ошибка:

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

Оплатить доставку заказа/заказов (/api/lite/order_delivery_payment)

POST /api/lite/order_delivery_payment

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

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

{
  "orders": ["1005", "1008"],
  "date": "2018-01-01", - обязательные для всех способов отгрузки кроме Своих курьеров
  "timeFrom": "09:00", - см выше
  "timeTo": "14:00", - см выше
  "courierId": "aa23s" - обязательный только для способа отгрузки Свои курьеры 
}

Успех:

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

{
  "success": true,
  "date": "2018-01-01",
  "timeFrom": "09:00",
  "timeTo": "14:00"
}


Ошибка:

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


Отменить оплату доставки заказа/заказов (/api/lite/order_delivery_payment)

DELETE /api/lite/order_delivery_payment

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

Вариант:

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


Оформить вызов курьера (/api/lite/courier_call)

POST /api/lite/courier_call

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

Пример ошибки
{
  "date": "2018-01-01",
  "timeFrom": "09:00",
  "timeTo": "14:00"
}

Успех:

Пример ошибки
{
  "success": true
}


Ошибка:

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

Отменить вызов курьера (/api/lite/courier_call)

DELETE /api/lite/courier_call

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

Пример ошибки
{
  "date": "2018-01-01",
  "timeFrom": "09:00",
  "timeTo": "14:00"
}

Успех:

Пример ошибки
{
  "success": true
}


Ошибка:

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

Получить список транзакций (/api/lite/transaction)

GET /api/lite/transaction

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


Пример ошибки
{
  "transactions":[
        {
            "date": "2019-03-01 17:53:23.538",
            "sum": 1500.50,
            "documentId": "1003",
            "documentType": "PAYMENT",
            "description": "Пополнение баланса по счету", // из справочника        
            "orderId": null
        },
        {
            "date": "2019-03-02 19:57:23.538",
            "sum": -265.57,
            "documentId": "1050",
            "documentType": "ORDER_PAYMENT_DOC_FACT",
            "description": "Оплата доставки заказа 1024 (доставка)", // в скобках - справочник статей расхода: доставка, страховка, наложенный платеж          
            "orderId": "1024"
        }
    ]
}


Ошибка:

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

Получить список транзакций по заказу (/api/lite/order/transaction)

GET /api/lite/order/transaction

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

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

?orderId=1020


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

Пример ошибки
{
  "transactions":[ 
        {
            "date": "2019-03-02 19:57:23.538",
            "sum": -265.57,
            "documentId": "1050",
            "documentType": "ORDER_EXPENSE_PAYMENT_DOC",
            "description": "Списание по расходам на оплату услуг заказа 1020 (доставка)",
            "orderId": "1020"
        }, 
        {
            "date": "2019-03-02 19:57:23.538",
            "sum": 265.57,
            "documentId": "1052",
            "documentType": "ORDER_PAYMENT_DOC_FACT",
            "description": "Оплата доставки заказа 1020 (доставка)",           
            "orderId": "1020"
        }
         
    ]
}


Ошибка:

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

Создать счет на оплату и получить информацию для оплаты (/api/lite/payment)

POST /api/lite/payment
Запрос
{
    "sum" : "222"
}
Ответ
{
    "success": true,
    "errors": [],
    "redirectData": {
        "data": {
            "entries": [
                {
                    "num": 0,
                    "name": "MERCHANT",
                    "value": "kaktwocr"
                },
                {
                    "num": 1,
                    "name": "ORDER_REF",
                    "value": "25567175-8d84-e371-90fa-8a6e86a69aa4"
                },
                {
                    "num": 2,
                    "name": "ORDER_DATE",
                    "value": "2019-03-11 17:09:35"
                },
                {
                    "num": 3,
                    "name": "ORDER_PNAME[]",
                    "value": "Пополнение баланса аккаунта №6419855"
                },
                {
                    "num": 4,
                    "name": "ORDER_PCODE[]",
                    "value": "balance"
                },
                {
                    "num": 5,
                    "name": "ORDER_PRICE[]",
                    "value": "222.00"
                },
                {
                    "num": 6,
                    "name": "ORDER_QTY[]",
                    "value": "1"
                },
                {
                    "num": 7,
                    "name": "ORDER_VAT[]",
                    "value": "0"
                },
                {
                    "num": 8,
                    "name": "PRICES_CURRENCY",
                    "value": "RUB"
                },
                {
                    "num": 9,
                    "name": "DESTINATION_CITY",
                    "value": ""
                },
                {
                    "num": 10,
                    "name": "DESTINATION_STATE",
                    "value": ""
                },
                {
                    "num": 11,
                    "name": "DESTINATION_COUNTRY",
                    "value": ""
                },
                {
                    "num": 12,
                    "name": "PAY_METHOD",
                    "value": "CCVISAMC"
                },
                {
                    "num": 13,
                    "name": "ORDER_PRICE_TYPE[]",
                    "value": "GROSS"
                },
                {
                    "num": 14,
                    "name": "ORDER_HASH",
                    "value": "6fe466d056fcc82836a861c322070381"
                },
                {
                    "num": 15,
                    "name": "BILL_FNAME",
                    "value": "Петр"
                },
                {
                    "num": 16,
                    "name": "BILL_LNAME",
                    "value": "Петров"
                },
                {
                    "num": 17,
                    "name": "BILL_EMAIL",
                    "value": "abc3@abc.ru"
                },
                {
                    "num": 18,
                    "name": "BILL_PHONE",
                    "value": "111111"
                },
                {
                    "num": 19,
                    "name": "BILL_COUNTRYCODE",
                    "value": "RU"
                },
                {
                    "num": 20,
                    "name": "BACK_REF",
                    "value": ""
                },
                {
                    "num": 21,
                    "name": "LANGUAGE",
                    "value": "RU"
                },
                {
                    "num": 22,
                    "name": "CURRENCY",
                    "value": "RUB"
                }
            ],
            "url": "https://sandbox.payu.ru/order/lu.php"
        },
        "paymentProvider": "PAYU"
    }
}

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


Пример формы, которую нужно сгенерировать на клиенте
<html>
    <head></head>
    <body>
        <form name="example" method="POST" action="https://sandbox.payu.ru/order/lu.php">
            <input type="hidden" name="MERCHANT" value="kaktwocr">
            <input type="hidden" name="ORDER_REF" value="25567175-8d84-e371-90fa-8a6e86a69aa4">
            <input type="hidden" name="ORDER_DATE" value="2019-03-11 17:09:35">
            <input type="hidden" name="ORDER_PNAME[]" value="Пополнение баланса аккаунта №6419855">
            <input type="hidden" name="ORDER_PCODE[]" value="balance">
            <input type="hidden" name="ORDER_PRICE[]" value="222.00">
            <input type="hidden" name="ORDER_QTY[]" value="1">
            <input type="hidden" name="ORDER_VAT[]" value="0">
            <input type="hidden" name="PRICES_CURRENCY" value="RUB">
            <input type="hidden" name="DESTINATION_CITY" value="">
            <input type="hidden" name="DESTINATION_STATE" value="">
            <input type="hidden" name="DESTINATION_COUNTRY" value="">
            <input type="hidden" name="PAY_METHOD" value="CCVISAMC">
            <input type="hidden" name="ORDER_PRICE_TYPE[]" value="GROSS">
            <input type="hidden" name="ORDER_HASH" value="6fe466d056fcc82836a861c322070381">
            <input type="hidden" name="BILL_FNAME" value="Петр">
            <input type="hidden" name="BILL_LNAME" value="Петров">
            <input type="hidden" name="BILL_EMAIL" value="abc3@abc.ru">
            <input type="hidden" name="BILL_PHONE" value="111111">
            <input type="hidden" name="BILL_COUNTRYCODE" value="RU">
            <input type="hidden" name="BACK_REF" value="">
            <input type="hidden" name="LANGUAGE" value="RU">
            <input type="hidden" name="CURRENCY" value="RUB">
            <button type="submit">Оплатить</button>
        </form>
    </body>
</html>









Получить список своих курьеров (/api/lite/own_courier)

GET /api/lite/own_courier

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


Пример ошибки
{
  "couriers":[
        {
            "id": "123456abc",
            "fullName": "Василий",
            "phone": "+7(901)1122121"
        },
        {
            "id": "123457abc",
            "fullName": "Петр",
            "phone": "+7(901)1122122"
        }
    ]
}


Ошибка:

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

Создать/обновить своего курьера (/api/lite/own_courier)

POST /api/lite/own_courier

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


Пример запроса
{
  "id": "123456abc",
  "fullName": "Василий",
  "phone": "+7(901)1122121"
}


Ошибка:

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


Удаление курьера (/api/lite/own_courier)

DELETE /api/lite/own_courier


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

Пример запроса
{ 
   "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF" 
}


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

Пример успешного ответа
{
  "success": true 
}

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

Пример ошибки
{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "курьера с указанным id не существует"
    }
  ]
}

Заказ - отметить доставку (/api/lite/order/delivery_result)

POST /api/lite/delivery_result

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


Пример запроса
{
  "orderId": "123456abc",
  "result": "DELIVERED", //LOST,RETURNING,RETURNED
  "comment": "abcd"
}


Ошибка:

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



Ответ
 
Пример ошибки
 

Записать данные собственного аккаунта Робокасса(/api/lite/settings/payment/robokassa)

POST /api/lite/settings/payment/robokassa

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


Пример запроса
{
  "merchantId": "abcd",
  "accountSecret": "abcd",
  "accountSecret2": "abcd"
}

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

Пример запроса
{
  "success":true,
  "accountId": "abcd",
  "resultUrl": "abcd",  - основной адрес приема ipn уведомлений (только оплаченные)
  "failUrl": "abcd", - адрес приема ipn уведомлений (только неоплаченные/отказ покупателя)
  "successesUrl": "abcd"  - адрес редиректа в магазин после оплаты 
}

Ошибка:

Получить макет витрины(публичный) (/api/lite/pub/settings/template)

GET /api/lite/pub/settings/template

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


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

Пример
{
  "templates" : [
        {
            "id": "123456",
            "isDefault": true,
            "htmlContent": "<html>...."
        }
    ]
}


Ошибка:

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


Получить макеты витрин (/api/lite/settings/template)

GET /api/lite/settings/template

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

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


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

Пример
{
  "templates" : [
        {
            "id": "123456",
            "isDefault": true,
            "content": "contentData...."
        }
    ]
}


Ошибка:

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



Создать/обновить макет витрины (/api/lite/settings/template)

POST /api/lite/settings/template

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


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

Пример
{      
        "id": "123456",  // при наличии параметра - обновляет существующий макет по его id
        "isDefault": true,
        "content": "contentData....",
        "htmlContent": "html content Data"
}


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

Пример
{
        "success": true,
        "id": "123456"
}


Ошибка:

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

Удалить макет витрины (/api/lite/settings/template)

DELETE /api/lite/settings/template

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


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

Пример
{
   "success": true
}


Ошибка:

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


Получить общие макеты витрин (/api/lite/settings/template/general)

GET /api/lite/settings/template/general

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

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


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

Пример
{
  "templates" : [
        {
            "id": "123456",
            "isDefault": true,
            "content": "contentData...."
        }
    ]
}


Ошибка:

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



Получить общие шаблоны блоков витрин (/api/lite/settings/template/block)

GET /api/lite/settings/template/block

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

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


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

Пример
{
    "blocks": [
        {
            "id": "f4173840-f409-424d-a000-24542b391c5d",
            "name": "block name",
            "content": "contentData...."
        }
    ]
}


Ошибка:

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


Получить заявки на сбор (/api/lite/gather)

GET /api/lite/gather

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

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

Пример
{
    "gathers": [
        {
            "success": true,
            "comment": null,
            "id": "1000-GD",
            "date": "2019-03-07 12:37:18",          
            "desiredDate": "2019-03-15",
            "desiredHourStart": "09:00",
            "desiredHourEnd": "14:00",
            "status": "AWAITING_CARGO",   //CREATED,CARGO_SHIPPED,HOLD,CANCELED
            "trackingNumber": "100039439"
        }
    ]
}


Ошибка:

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



Получить варианты курьерских пакетов (/api/lite/pub/courier_pack_type)

GET /api/lite/pub/courier_pack

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

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

Пример
{
    "courier_packs": [
        {
            "success": true,
            "type": "PACKET", // PAPERBOX
            "sizeType": "S",  // M/L
            "cargoWeight": 1500,  // максимальный вес содержимого в граммах          
            "dimensions": {
                "height": 12,
                "width": 20,
                "depth": 8
            }
        }
    ]
}


Ошибка:

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

Создать пользователя для Expert (/api/lite/settings/go-expert)

GET /api/lite/settings/go-expert

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

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

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

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

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

Пример
{
      "success": true
}


Ошибка:

Пример ошибки
{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "текст ошибки"
    }
  ]
}
Наверх