Работаем в будние дни с 09:00 до 18:00

Регистрация

Вход

Регистрация

Надежный и креативный оптовый поставщик посуды
для сервировки и приготовления, сувениров, подарков,
предметов интерьера и текстиля.

Назад Главная/Информация о работе с API

Информация о работе с API

Общая информация

Запросы

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

Положение о работе с API

Описание полей товара, которые запрашивает API
Описание полей товара, которые возвращает API
Возможные ошибки при подключении по API

Общая информация о работе с API

API arti-m.ru предоставляет доступ к следующим функциям: получение товаров по артикулам, получение товаров по артикулам с возможностью выбора нужных полей, получение всех товаров, получение всех товаров с возможностью выбора нужных полей, получение всех артикулов в наличии с остатками и создание нового заказа.

Для работы с API вам необходимо получить APIKEY. Он выдаётся только зарегистрированным пользователям. Напишите нам на почту web@arti-m.com, чтобы мы выслали Вам APIKEY.

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

Для получения данных можно использовать программу Advanced Rest Client или аналогичную.

Обратите внимание! Если Вы получаете все товары, которые есть в наличии, то запрос может выполняться в течении 5-7 минут.

Запросы

POST

https://arti-m.ru/index.php?dispatch=api.products_by_code Получить товары по артикулу

Во входных параметрах нужно указать "apikey" и "user_id"(высылается Вам на почту, после запроса у нашего менеджера). В массиве "product_codes" - артикулы товара, которые хотите получить

Входные параметры

{
    "product_codes": ["850-842-61","850-708-66"],
    "apikey": "YOURAPIKEY",
    "user_id": YOURUSERID
}

В случае успешного запроса, поле "status" будет равно true и возвратятся товары(со всеми доступными в API полями) для указанных артикулов, которые есть в наличии

В случае ошибки, поле "status" будет равно false, в поле "status_text" будет описание ошибки. Подробнее о всех ошибках можете узнать здесь.

Пример ответа

{
    "status": true,
    "status_text": "Запрос выполнен успешно",
    "data": {
       "850-708-66": {
           "name": "КОМПЛЕКТ ПОЛОТЕНЕЦ ИЗ 2Х ШТ "НАТЮРМОРТ" 40Х70СМ,40Х40 100% ХЛОПОК,ТВИЛЛ+МАХРА СИНЕЕ",
           "description": "",
           "barcode": "4601850708663",
           "price": 300,
           "rrp": 300,
           "amount": 21,
           "category": "Кухонные полотенца",
           "full_category": "Текстиль/Кухня/Кухонные полотенца",
           "code": "850-708-66",
           "packing": "Фасовка: 1/1",
           "serie": "Натюрморт",
           "type": "Полотенца для кухни",
           "brand": "SANTALINO",
           "country": "Россия",
           "material": "Хлопок",
           "volume": "0,9л",
           "diameter": "10,2 см",
           "min_qty": "10",
           "box_length": "30", 
           "box_width": "20",
           "box_height": "20",
           "max_discount": "0",
           "marking": "N",
           "images": {[
 	      0: "https://www.arti-m.ru/images/detailed/417/850-708-66.jpg",
  	      1: "https://www.arti-m.ru/images/detailed/417/850-708-66_2_.jpg"
 	      2: "https://www.arti-m.ru/images/detailed/417/850-708-66_3_.jpg",
  	      3: "https://www.arti-m.ru/images/detailed/417/850-708-66_4_.jpg"
           ]}
       },
       "850-842-61": {
           "name": "ПОДУШКА ДЕКОРАТИВНАЯ 45*45 СМ, "ИНИЦИО", 100% ХЛОПОК",
           "description": "",
           "barcode": "4601850842619",
           "price": "513",
           "rrp": "300",
           "amount": "0",
           "category": "Декоративные подушки",
           "full_category": "Текстиль/Гостиная и спальня/Декоративные подушки и наволочки/Декоративные подушки",
           "code": "850-842-61",
           "packing": "Фасовка: 1/1",
           "serie": "Иницио",
           "type": "Подушки декоративные",
           "brand": "SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": "10",
           "box_length": "30",
           "box_width": "20",
           "box_height": "20",
           "max_discount": "0",
           "marking": "N",
           "images": {[
 	      0: "https://www.arti-m.ru/images/detailed/417/850-842-61.jpg",
  	      1: "https://www.arti-m.ru/images/detailed/417/850-842-61_2_.jpg"
           ]}
       },
    }
}

POST

https://arti-m.ru/index.php?dispatch=api.products_by_code_part Получить товары c нужными полями по артикулам

Входные параметры

{
    "apikey": "YOURAPIKEY",
    "user_id": YOURUSERID,
    "product_codes": ["850-842-61","850-708-66"],
    "show_packing": 1,
    "show_series": 1,
    "show_type": 0,
    "show_size": 1,
    "show_min_qty": 1,
    "show_category": 1,
    "show_brand": 1,
    "show_images": 0,
    "show_price": 1,
    "show_max_discount": 1,
    "show_box": 1
}

В случае успешного запроса, поле "status" будет равно true и возвратяться товары(с выбранными полями) для указанных артикулов, которые есть в наличии

Пример ответа

{
    "status": true,
    "status_text": "Запрос выполнен успешно",
    "data": {
       "850-708-66": {
           "name": "КОМПЛЕКТ ПОЛОТЕНЕЦ ИЗ 2Х ШТ "НАТЮРМОРТ" 40Х70СМ,40Х40 100% ХЛОПОК,ТВИЛЛ+МАХРА СИНЕЕ",
           "description": "",
           "barcode": "4601850708663",
           "price": 300,
           "rrp": 300,
           "amount": 21,
           "category": "Кухонные полотенца",
           "full_category": "Текстиль/Кухня/Кухонные полотенца",
           "code": "850-708-66",
           "packing": "1/1
           "serie": "Натюрморт",
           "brand": "SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": 10,
           "box_length": 30,
           "box_width": 20,
           "box_height": 20,
           "max_discount": 0,
           "marking": N,
       },
       "850-842-61": {
           "name": "ПОДУШКА ДЕКОРАТИВНАЯ 45*45 СМ, "ИНИЦИО", 100% ХЛОПОК",
           "description": "",
           "barcode": 4601850842619",
           "price": 513,
           "rrp": 300,
           "amount": 0,
           "category": Декоративные подушки",
           "full_category": Текстиль/Гостиная и спальня/Декоративные подушки и наволочки/Декоративные подушки",
           "code": 850-842-61",
           "packing": 1/1",
           "serie": Иницио",
           "brand": SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": 10,
           "box_length": 30,
           "box_width": 20,
           "box_height": 20,
           "max_discount": 0,
           "marking": N,
       },
    }
}

POST

https://arti-m.ru/index.php?dispatch=api.products Получить все товары

Во входных параметрах нужно указать "apikey" и "user_id"(высылается Вам на почту, после запроса у нашего менеджера).

Также есть возможность порционной подгрузки данных. Для этого нужно указать параметры "page" - номер итерации порции и "items_per_page" - количество товаров в порции. Таким образом, при указании "page" = 1 и "items_per_page" = 100, будут подгружены первые 100 товаров, при указании "page" = 2 и "items_per_page" = 100, будут подгружены следующие 100 товаров и так далее.

Также возможно указать поле "limit" - оно ограничит получение товаров указанным количеством, за счёт чего значительно уменьшит время запроса. При указании поле "limit" поля "page" и "items_per_page" будут игнорироваться.

Если не указывать ни один из параметров "limit", "page","items_per_page", то будут запрошены все товары сразу, но запрос будет довольно долгим. Этот вариант не рекомендуется.

Входные параметры

{
    "apikey": "YOURAPIKEY",
    "user_id": YOURUSERID,
    "page": 1,
    "items_per_page": 100
}

В случае успешного запроса, поле "status" будет равно true и возвратятся все товары(со всеми доступными в API полями), которые есть в наличии

Также вернется поле "total_count" - все доступное количество товаров.

Обратите внимание! Данный запрос может выполняться в течении 5-7 минут

Пример ответа

{
    "status": true,
    "status_text": "Запрос выполнен успешно",
    "page": 1,
    "items_per_page": 100,
    "total_count": 7800,
    "data": {
       "850-708-66": {
           "name": "КОМПЛЕКТ ПОЛОТЕНЕЦ ИЗ 2Х ШТ "НАТЮРМОРТ" 40Х70СМ,40Х40 100% ХЛОПОК,ТВИЛЛ+МАХРА СИНЕЕ",
           "description": "",
           "barcode": "4601850708663",
           "price": 300,
           "rrp": 300,
           "amount": 21,
           "category": "Кухонные полотенца",
           "full_category": "Текстиль/Кухня/Кухонные полотенца",
           "code": "850-708-66",
           "packing": "Фасовка: 1/1
           "serie": "Натюрморт",
           "type": "Полотенца для кухни",
           "brand": "SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": 10,
           "box_length": 30,
           "box_width": 20,
           "box_height": 20,
           "max_discount": 0,
           "marking": N,
           "images": {[
 	      0: "https://www.arti-m.ru/images/detailed/417/850-708-66.jpg",
  	      1: "https://www.arti-m.ru/images/detailed/417/850-708-66_2_.jpg"
 	      2: "https://www.arti-m.ru/images/detailed/417/850-708-66_3_.jpg",
  	      3: "https://www.arti-m.ru/images/detailed/417/850-708-66_4_.jpg"
           ]}
       },
       "850-842-61": {
           "name": "ПОДУШКА ДЕКОРАТИВНАЯ 45*45 СМ, "ИНИЦИО", 100% ХЛОПОК,
           "description": "",
           "barcode": "4601850842619",
           "price": 513,
           "rrp": 300,
           "amount": 0,
           "category": "Декоративные подушки",
           "full_category": "Текстиль/Гостиная и спальня/Декоративные подушки и наволочки/Декоративные подушки",
           "code": "850-842-61",
           "packing": "Фасовка: 1/1",
           "serie": "Иницио",
           "type": "Подушки декоративные",
           "brand": "SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": 10,
           "box_length": 30,
           "box_width": 20,
           "box_height": 20,
           "max_discount": 0,
           "marking": N,
           "images": {[
 	      0: "https://www.arti-m.ru/images/detailed/417/850-842-61.jpg",
  	      1: "https://www.arti-m.ru/images/detailed/417/850-842-61_2_.jpg"
           ]}
       },
    }
}

POST

https://arti-m.ru/index.php?dispatch=api.products_part Получить все товары c нужными полями

Во входных параметрах нужно указать "apikey" и "user_id"(высылается Вам на почту, после запроса у нашего менеджера).

Также вернется поле "total_count" - все доступное количество товаров.

Входные параметры

{
    "apikey": "YOURAPIKEY",
    "page": 1,
    "items_per_page": 100,
    "user_id": YOURUSERID,
    "show_packing": 1,
    "show_series": 1,
    "show_type": 0,
    "show_size": 1,
    "show_min_qty": 1,
    "show_category": 1,
    "show_brand": 1,
    "show_images": 0,
    "show_price": 1,
    "show_max_discount": 1,
    "show_box": 1
}

В случае успешного запроса, поле "status" будет равно true и возвратятся все товары(с выбранными полями), которые есть в наличии

Пример ответа

{
    "status": true,
    "status_text": "Запрос выполнен успешно",
    "page": 1,
    "items_per_page": 100,
    "total_count": 7800,
    "data": {
       "850-708-66": {
           "name": "КОМПЛЕКТ ПОЛОТЕНЕЦ ИЗ 2Х ШТ "НАТЮРМОРТ" 40Х70СМ,40Х40 100% ХЛОПОК,ТВИЛЛ+МАХРА СИНЕЕ",
           "description": "",
           "barcode": "4601850708663",
           "price": 300,
           "rrp": 300,
           "amount": 21,
           "category": "Кухонные полотенца",
           "full_category": "Текстиль/Кухня/Кухонные полотенца",
           "code": "850-708-66",
           "packing": "1/1
           "serie": "Натюрморт",
           "brand": "SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": 10,
           "box_length": 30,
           "box_width": 20,
           "box_height": 20,
           "max_discount": 0,
           "marking": N,
       },
       "850-842-61": {
           "name": "ПОДУШКА ДЕКОРАТИВНАЯ 45*45 СМ, "ИНИЦИО", 100% ХЛОПОК",
           "description": "",
           "barcode": 4601850842619",
           "price": 513,
           "rrp": 300,
           "amount": 0,
           "category": Декоративные подушки",
           "full_category": Текстиль/Гостиная и спальня/Декоративные подушки и наволочки/Декоративные подушки",
           "code": 850-842-61",
           "packing": 1/1",
           "serie": Иницио",
           "brand": SANTALINO",
           "size": "10,2х10,2х12,2 см",
           "min_qty": 10,
           "box_length": 30,
           "box_width": 20,
           "box_height": 20,
           "max_discount": 0,
           "marking": N,
       },
    }
}

POST

https://arti-m.ru/index.php?dispatch=api.products_codes_in_stock Получить все артикулы в наличии

Входные параметры

{
    "apikey": "YOURAPIKEY",
    "user_id": YOURUSERID
}

В случае успешного запроса, поле "status" будет равно true и возвратятся артикулы товаров, которые есть в наличии с их остатком на складе

Пример ответа

{
    "status": true,
    "status_text": "Запрос выполнен успешно",
    "data": {
       "850-708-66": {
           "amount": 21,
           "code": "850-708-66"
       },
       "850-842-61": {
           "amount": 18,
           "code": "850-842-61",
       },
    }
}

POST

https://arti-m.ru/index.php?dispatch=api.create_order Создать новый заказ

Во входных параметрах нужно указать "apikey" и "user_id"(высылаются Вам на почту, после запроса у нашего менеджера). В массиве "product_codes" указываются поля "code" - артикул товара и "amount" - количество товара, которое Вы хотите добавить в заказ. Вы также можете указать поле "order_id" - для учёта в своей системе.

Входные параметры

{
    "apikey": "YOURAPIKEY",
    "user_id": YOURUSERID,
    "order_id": 10,
    "product_codes": [
    	{
 	   "code": "195-112",
 	   "amount": 1
    	},
    	{
 	   "code": "59-040-1",
 	   "amount": 2
    	},
    	{
 	   "code": "575-913-50",
 	   "amount": 1
    	}
    ]
}

В случае успешного запроса, поле "status" будет равно true и заказ добавиться в систему. Если в Вашем заказе были товары, которых нет в наличии, то артикулы товаров будут добавлены в поле "codes_zero_amount". Если в Вашем заказе были артикулы, которых нет в системе, то артикулы товаров будут добавлены в поле "codes_failed_products"

Пример ответа

{
    "status": true,
    "status_text": "Заказ был создан успешно, но некоторые артикулы отсутствуют в наличии и не были добавлены в заказ. Также некоторые артикулы не существуют в системе",
    "codes_zero_amount": ["575-913-50","59-040-1"],
    "codes_failed_products": ["100 100","200"]
}

POST

https://arti-m.ru/index.php?dispatch=api.products_images Получить ссылки на изображения товаров

Во входных параметрах нужно указать "apikey" и "user_id"(высылаются Вам на почту, после запроса у нашего менеджера). В массиве "product_codes" указываеются артикулы товара, которое изображения которых хотите получить.

Входные параметры

{
    "product_codes": ["850-842-61","850-708-66"],
    "apikey": "YOURAPIKEY",
    "user_id": YOURUSERID
}

В случае успешного запроса, поле "status" будет равно true и вернётся список со ссылками на изображения запрошенных товаров

Пример ответа

{
    "status": true,
    "status_text": "Запрос выполнен успешно",
    "data": {
       "850-842-61": ["https://www.arti-m.ru/images/detailed/417/850-842-61.jpg","https://www.arti-m.ru/images/detailed/417/850-842-61_2_.jpg"],
       "850-708-66": ["https://www.arti-m.ru/images/detailed/417/850-708-66.jpg","https://www.arti-m.ru/images/detailed/417/850-708-66_2_.jpg","https://www.arti-m.ru/images/detailed/417/850-708-66_3_.jpg","https://www.arti-m.ru/images/detailed/417/850-708-66_4_.jpg"]
    }
}

Описание полей товара, которые запрашивает API

Поле	Описание	Тип	Комментарий
apikey	API ключ	(string)	Обязательное поле. Уникальный ключ для работы с API (высылается на почту)
user_id	ID пользователя	(int)	Обязательное поле. ID вашего профиля в системе arti-m.ru (высылается на почту)
order_id	ID заказа	(string)	Необязательное поле. Только для запроса create_order. ID заказа с вашего сайта
product_codes	Артикулы	(array)	Обязательное поле только для запросово с артикулами. Массив артикулов товаров. В запросе с созданием заказа в массиве нужно также указывать количество товара. Только для запросов products_by_code, products_by_code_part, create_order, products_images
limit	Ограничение товаров	(int)	Необязательное поле. Количество товаров, которые Вы хотите получить. Если указывать этот параметр, то запрос по получению товаров будет проходить гораздо быстрее. Если этот параметр установлен, то параметры page и items_per_page будут игнорироваться. Только для запросов products и products_part
page	Итерация порции	(int)	Необязательное поле. Только для запросов products и products_part
items_per_page	Ограничение товаров	(int)	Необязательное поле. Количество товаров, которые будет в одной итерации(page). Только для запросов products и products_part

Описание полей товара, которые возвращает API

Поле	Описание	Тип	Комментарий
name	Название	(string)
description	Текстовое описание	(string)
barcode	Штрих-код	(string)
price	Оптовая цена	(int)
rrp	Рекомендованная розничная цена	(int)
marking	Маркировка	(string)	Значения Y/N
amount	Доступное количество на складе	(int)	если больше 21, то всегда указывается 21
category	Главная категория	(string)
full_category	Полное дерево категорий	(string)
code	Артикул	(string)
packing	Фасовка (характеристика)	(string)	Пример - "Фасовка: 1/1"
serie	Серия (характеристика)	(string)	Пример - "Натюрморт"
type	Тип (характеристика)	(string)	Пример - "Полотенца для кухни"
brand	Бренд (характеристика)	(string)	Пример - "SANTALINO"
country	Страна (характеристика)	(string)	Пример - "Россия"
manufactory	Производитель (характеристика)	(string)
material	Материал (характеристика)	(string)	Пример - "Хлопок"
size	Размер (характеристика)	(string)	Пример - "10,2х10,2х12,2 см"
volume	Объём (характеристика)	(string)	Пример - "0,9 л"
diameter	Диаметр (характеристика)	(string)	Пример - "10,2 см"
images	Изображения (главное + дополнительные)	(array)
min_qty	Минимальное количество	(int)
max_discount	Максимально возможная скидка	(int)	измеряется в %. Если равно 0, то скидка не предусмотрена, если 100, то любая скидка возможна
weight	Вес (характеристика)	(int)	измеряется в КГ
box_length	Длина коробки (характеристика)	(int)	измеряется в СМ
box_width	Ширина коробки (характеристика)	(int)	измеряется в СМ
box_height	Высота коробки (характеристика)	(int)	измеряется в СМ
status	Статус запроса	(boolean)	только для запроса на создание заказа
status_text	Текстовое описание статуса запроса	(string)	только для запроса на создание заказа
total_count	Общее количество товаров	(int)	только для запросов products и products_part
codes_zero_amount	Список артикулов товаров, которые не были в наличии на момент запроса	(array)	только для запроса на создание заказа
codes_failed_products	Список артикулов товаров, которые нет в системе	(array)	только для запрос на создание заказа

Возможные ошибки при подключении по API

Ошибка	Описание
apikey отсутствует	В запросе во входных параметрах было пропущено поле apikey. Напишите нам на почту web@arti-m.com для получения apikey
user_id отсутствует	В запросе во входных параметрах было пропущено поле user_id. Напишите нам на почту web@arti-m.com для получения user_id
apikey не верен	В запросе во входных параметрах был указан не верный apikey или user_id. Возможно у Вашего аккаунта не включена возможность подключения по API.

Информация о работе с API

Входные параметры

Пример ответа

Входные параметры

Пример ответа

Входные параметры

Пример ответа

Входные параметры

Пример ответа

Входные параметры

Пример ответа

Входные параметры

Пример ответа

Входные параметры

Пример ответа

Каталог

Для покупателей

О магазине

Контакты