Описание

Система API компании Склад шин предоставляет следующие возможности:

• Получение информации о товарах;
• Получение данных об актуальных ценах и остатках;
• Возможность создания заказа;
• Получение данных о созданных заказах.

Используемый формат ответов и запросов – JSON. Все запросы отправляются методом POST.

Авторизация

Все http-запросы в заголовке должны содержать token. Для получения token-а необходимо обратиться к менеджеру компании «Склад шин».

В компании используется ограничение по IP-адресам. Необходимо предоставить менеджеру информацию об IP-адресе (адресах), с которого будут осуществляться запросы.

Коды ответов

Сервер может возвращать следующие коды в качестве ответа:

• 200 – успех;
• 201 – успешное создание объекта;
• 401 – ошибка авторизации (token неверный либо не передан);
• 400 – ошибка передачи параметров (в теле запроса в этом случае будет передано описание причины).

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

1. Метод (https://93.190.224.20:9087/Ka2n_Portal/hs/api/products). Возвращает описание товаров.

Ответ

[
    {
        "type": "Легковые шины", //тип шины
        "season": "Летняя", // сезонность
        "Products": 
            [
                {
                    "article": "0354321", //артикул
                    "name": "245/45 R20 Continental ContiCrossContact LX Sport 103W", //наименование
                    "brand": "Continental", //Производитель
                    "model": "ContiCrossContact LX Sport",  // Модель
                    "width": "245", // ширина
                    "height": "45", // высота
                    "diameter": "20", // диаметр
                    "speed_index": "W (270км/ч)", // индекс скорости
                    "load_index": "103", // индекс нагрузки
                    "runflat": false, // run flat
                    "is_studded": false, // шипы
                    "axis": "Универсальная" // ось
                }
            ]
    }
]

2. Метод (https://93.190.224.20:9087/Ka2n_Portal/hs/api/rest). Возвращает остатки и цены товаров.

Ответ

[
	{
	    "article": "Х0000027987", //артикул товара
	    "name": "175/80 R16 Forward Arctic 511 88Q TT", // наименование
	    "totalrest": 2, // общий остаток товара
        "rests": [
		    {
		        "offer": "ПТPT-002225", // номер предложения
		        "id_stock": "s1", // id склада 
		        "rest": 2, // остаток на складе по предложению
		        "pricelists": [
			        {
			            "id_price": "p14", // id вида цена
			            "price": 4662, // цена
			            "withoutVAT": false // true - цена без НДС, false - цена c НДС
			        },
			        {
			            "id_price": "p12",
			            "price": 4751,
			            "withoutVAT": false
			        },
			        {
                        "id_price": "p13",
                        "price": 4706,
                        "withoutVAT": false
			        }
			    ]
			}
		]
	}
]

3. Метод (https://93.190.224.20:9087/Ka2n_Portal/hs/api/stocks). Возвращает список складов.

Ответ

[
    {
        "id": "s1", // id склада
        "name": "В наличии" // наименование склада
    }
]

4. Метод (https://93.190.224.20:9087/Ka2n_Portal/hs/api/pricelists). Возвращает список видов цен.

Ответ

[
    {
        "id": "p12", // id вида цены
        "name": "(Отсрочка; С доставкой)" // наименование вида цены
    },
    {
        "id": "p13",
        "name": "(Отсрочка; Самовывоз)"
    }
]

5. Метод (https://93.190.224.20:9087/Ka2n_Portal/hs/api/order). Создаёт заказ.

Тело запроса

{
    "id_price": "p14", // id вида цены
    "shipdate": "30.04.2023", // желаемая дата доставки ДД.ММ.ГГГГ (не обязательно)
    "items": [
        {
            "article": "Х0000027987", //артикул товара
            "quantity": 2, // количество
            "offer": "ПТPT-002225" // номер предложения (не обязательно)
        },
    ]
}

Ответ

В случае успеха возвращается 201 с телом, содержащем номер заказа.

6. Метод (https://93.190.224.20:9087/Ka2n_Portal/hs/api/pricelists). Возвращает список заказов клиента.

Тело запроса (не обязательно)

{
    "date_from": "01.04.2023", // начальная дата
    "date_to": "30.04.2023" // конечная дата
}

Ответ

[
    {
        "number": "ПТPT-001723", // номер заказа
        "date": "19.04.2023", // дата заказа
        "status": "Ожидается обеспечение", // статус заказа
        "shipdate": "25.04.2023", // ожидаемая дата отгрузки
        "items": [
            {
                "article": "2210012", // артикул товара
                "name": "215/75 R16C Кама Euro-131 116/114R", // наименование товара
                "quantity": 4, // количество
                "sum": 25000 // общая сумма за всё количество с налогами
            }
        ]
    }
]