Получение свойств товаров

Apicore Dealer API

Начало работы

Для запросов в API используется метод POST
Для подключения нужен Api-ключ (Получить <Api-ключ> можно в разделе кабинета "Настройки")
Тело запроса raw должно быть в формате JSON
Ответ отдается также в формате JSON

Интерфейс API: https://api.apicore.one

Заголовки запроса (Headers)

POST / HTTP 1.1
Host: https://api.apicore.one
Api-Key: <Api-ключ>
Content-Type: application/json
Accept: application/json

Внимание!

Не передавайте Api-ключ посторонним лицам!

На запросы по API действует правило - не более 2-х запросов в секунду.

Если от вас поступает слишком много ошибочных или одинаковых запросов, мы можем ограничить доступ к API

Если вам требуется дополнительная функциональность в API, пишите на support@apicore.one, с радостью рассмотрим предложения.

Kанал по актуальным обновлениям.

Скачать спецификацию OpenAPI

dealer.json

dealer.yaml

Обзор API

Связаться с поддержкой support@apicore.one

Серверы

Основной сервер

https://api.apicore.one/

Api-ключ

Операции

Категории каталогов Дистрибьюторов

Операции

Товары Дистрибьюторов

Операции

Получение полного набора данных о товаре

Запрос

Отдает полный набор данных по товару. Отдает по 200 товаров на запрос.

На сбор товаров есть ограничение – не более 2х раз в день.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

distributor_idstringОбязательные поля

id дистрибьютора, который можно получить в кабинете дилера

catalog_codestring

если у дистрибьютора несколько каталогов можно указать код нужного каталога

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

сдвиг для получения следующих товаров

webpboolean

Если нужны картинки в формате webp

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.full \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "distributor_id": "d9262a56",
    "catalog_code": "main",
    "limit": 1,
    "offset": 0,
    "webp": true
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров

totalnumber

общее количество товаров

countnumber

Количество товаров в текущем ответе

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … }
  ],
  "total": 562,
  "count": 200,
  "limit": 1,
  "offset": 0,
  "next_offset": 200
}

Получение товаров каталогов Дистрибьюторов

Запрос

Метод возвращает список базовых карточек товаров из каталога требуемого Дистрибьютора. Возвращаются только активные товары, доступные к продаже.

Один запрос возвращает до 1000 товаров. Чтобы получить следующие 1000 товаров добавьте в тело запроса параметр смещения offset : 1000

В ответе возвращается параметр total, содержащий общее количество товаров. Если offset будет больше, чем total, то будет возвращаться значение из offset с пустым массивом товаров. В ответе возвращается параметр count, содержащий количество товаров в ответе.

Для определения, нужен ли еще один запрос, чтобы получить следующие 1000 товаров, в ответе возвращается параметр next_offset. Если он есть, можно подставлять значение из этого параметра в offset следующего запроса. Если next_offset отсутствует, значит вы получили весь список товаров.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

distributor_idstringОбязательные поля

Уникальный идентификатор Дистрибьютора.

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр смещения для получения следующего списка товаров.

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.list \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "distributor_id": "b4d0d204",
    "limit": 2,
    "offset": 0
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив с карточками товаров

totalnumber

общее количество товаров

countnumber

Количество товаров в текущем ответе

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "total": 1409,
  "count": 1000,
  "limit": 2,
  "offset": 0,
  "next_offset": 1000
}

Получение цен товаровустаревший

Запрос

Метод устарел! Используйте метод /dealer/v2/distrib.product.prices

Метод возвращает цены всех товаров по всем доступным Дистрибьюторам. Запрос может содержать указание id дистрибьютора или id товаров для получения фильтрованных данных по конкретным товарам.

Один запрос возвращает до 1000 записей цен. Если в запросе указано больше id товаров, ответ будет ограничен первыми 1000.

В ответе возвращается массив products, который содержит указание цены и валюты по каждому найденному товару. Также возвращается массив not_found_id, который содержит в себе id товаров, которые не были найдены у Дистрибьютора, либо эти товары не активны и отсутствуют в продаже.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

One of:

product_idArray of numbers

Массив id товаров, полученных из метода получения списка товаров

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.prices \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": [
      4803,
      21,
      22,
      19,
      20
    ]
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

Массив ненайденных ID товаров

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … },
    { … }
  ],
  "not_found_id": [
    4803,
    19
  ],
  "total": 1409,
  "count": 1000,
  "limit": 3,
  "offset": 0,
  "next_offset": 1000
}

Получение цен товаров

Запрос

Метод возвращает цены всех товаров по всем доступным Дистрибьюторам. Запрос может содержать указание id дистрибьютора или id товаров для получения фильтрованных данных по конкретным товарам.

Один запрос возвращает до 1000 записей цен. Если в параметре product_id указано больше 1000 id товаров, ответ будет ограничен первыми 1000. Чтобы получить следующие 1000 товаров добавьте в тело запроса параметр смещения offset: 1000

Для определения, нужен ли еще один запрос, чтобы получить следующие 1000 товаров, в ответе возвращается параметр next_offset. Если он есть, можно подставлять значение из этого параметра в offset следующего запроса. Если next_offset отсутствует, значит вы получили весь список товаров.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

distributor_idArray of strings

Массив ID дистрибьюторов

product_idArray of numbers

Массив ID товаров

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр смещения для получения следующего списка товаров.

curl -i -X POST \
  https://api.apicore.one/dealer/v2/distrib.product.prices \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "distributor_id": [
      "265b0478",
      "34fa23fb"
    ],
    "product_id": [
      28,
      37,
      45,
      46
    ],
    "limit": 2,
    "offset": 0
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

Массив ненайденных ID товаров

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "not_found_id": [
    45,
    46
  ],
  "limit": 2,
  "offset": 0,
  "next_offset": 1000,
  "total": 1160,
  "count": 1000
}

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

Запрос

Метод возвращает остатки всех товаров по всем доступным Дистрибьюторам. Запрос может содержать указание id дистрибьютора или id товаров для получения фильтрованных данных по конкретным товарам.

Один запрос возвращает до 1000 записей остатков. Если в запросе указано больше id товаров, ответ будет ограничен первыми 1000.

В ответе возвращается массив products, который содержит остатки найденных товаров Также возвращается массив not_found_id, который содержит в себе id товаров, которые не были найдены у Дистрибьютора, либо эти товары не активны и отсутствуют в продаже.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

One of:

product_idArray of numbers

Массив id товаров, полученных из метода получения списка товаров

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.quantities \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": [
      4803,
      21,
      22,
      19,
      20
    ]
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … },
    { … }
  ],
  "not_found_id": [
    18,
    19
  ],
  "total": 1409,
  "count": 1000,
  "limit": 3,
  "offset": 0,
  "next_offset": 1000
}

Получение общих данных цен и остатков

Запрос

Метод возвращает совмещенные данные по ценам товаров и по остаткам. По сути это объединенные методы: /dealer/v2/distrib.product.prices и /dealer/v1/distrib.product.quantities.

Один запрос возвращает до 1000 записей товаров. Чтобы получить следующие 1000 товаров добавьте в тело запроса параметр смещения offset: 1000.

Если в параметре product_id указано больше 1000 id товаров, ответ будет ограничен первыми 1000.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

distributor_idArray of strings

Массив ID дистрибьюторов

product_idArray of numbers

Массив ID товаров

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр смещения для получения следующего списка товаров.

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.inventory \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "distributor_id": [
      "265b0478",
      "b4d0d204",
      "b9e458c1"
    ],
    "product_id": [
      7820,
      5652,
      7821,
      1
    ],
    "limit": 2,
    "offset": 0
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

Массив ненайденных ID товаров

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

limitnumber

Ограничение по количеству элементов в ответе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "not_found_id": [
    1
  ],
  "total": 3,
  "count": 3,
  "limit": 2,
  "offset": 0,
  "next_offset": 2
}

Получение параметров товаров

Запрос

Метод возвращает параметры всех товаров по всем доступным Дистрибьюторам. Запрос может содержать указание id дистрибьютора или id товаров для получения фильтрованных данных по конкретным товарам.

Один запрос возвращает до 1000 записей товаров. Если в запросе указано больше id товаров, ответ будет ограничен первыми 1000.

"В ответе возвращается массив products, который содержит параметры найденных товаров: вес, габариты (ширина, высота, длина), единица веса (g, kg), единица габаритов (mm, m)" Также возвращается массив not_found_id, который содержит в себе id товаров, которые не были найдены у Дистрибьютора, либо эти товары не активны и отсутствуют в продаже.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

One of:

product_idArray of numbers

Массив id товаров, полученных из метода получения списка товаров

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.params \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": [
      4803,
      21,
      22,
      19,
      20
    ]
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "not_found_id": [
    18,
    19,
    22
  ],
  "total": 1409,
  "count": 1000,
  "limit": 2,
  "offset": 0,
  "next_offset": 1000
}

Получение изображений товаров

Запрос

Метод возвращает массив изображений всех товаров по всем доступным Дистрибьюторам.

Запрос может содержать указание id дистрибьютора или id товаров для получения фильтрованных данных по конкретным товарам.

В ответе возвращается массив “products”, который содержит изображения найденных товаров. Также возвращается массив “not_found_id”, который содержит в себе id товаров, которые не были найдены у Дистрибьютора, либо эти товары не активны и отсутствуют в продаже.

Можно в запросе указать параметр webp со значением true, чтобы получить оптимизированные картинки в формате .webp

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

One of:

product_idArray of numbers

Массив id товаров, полученных из метода получения списка товаров

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.images \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": [
      4803,
      21,
      22,
      19,
      20
    ]
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "not_found_id": [
    18,
    19,
    22
  ],
  "total": 1409,
  "count": 1000,
  "limit": 2,
  "offset": 0,
  "next_offset": 1000
}

Получение описаний товаров

Запрос

Метод возвращает массив детальных описаний всех товаров по всем доступным Дистрибьюторам

Один запрос возвращает до 100 записей товаров. Если в запросе указано больше id товаров, ответ будет ограничен первыми 100.

В ответе возвращается массив “products”, который содержит текст описания найденных товаров.

Также возвращается массив “not_found_id”, который содержит в себе id товаров, которые не были найдены у Дистрибьютора, либо эти товары не активны и отсутствуют в продаже.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

One of:

product_idArray of numbers

Массив id товаров, полученных из метода получения списка товаров

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.descriptions \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": [
      4803,
      21,
      22,
      19,
      20
    ]
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "not_found_id": [
    18,
    19,
    22
  ],
  "total": 1409,
  "count": 1000,
  "limit": 2,
  "offset": 0,
  "next_offset": 1000
}

Получение свойств товаров

Запрос

Метод возвращает массив свойств всех товаров по всем доступным Дистрибьюторам.

В ответе возвращается массив products, который содержит свойства найденных товаров.

Также возвращается массив not_found_id, который содержит в себе id товаров, которые не были найдены у Дистрибьютора, либо эти товары не активны и отсутствуют в продаже.

Заголовки

Content-TypestringОбязательные поля

Пример: application/json

AcceptstringОбязательные поля

Пример: application/json

Api-KeystringОбязательные поля

Телоapplication/json

One of:

product_idArray of numbers

Массив id товаров, полученных из метода получения списка товаров

curl -i -X POST \
  https://api.apicore.one/dealer/v1/distrib.product.props \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "product_id": [
      4803,
      21,
      22,
      19,
      20
    ]
  }'

Ответы

Успешный ответ

Телоapplication/json

statusboolean

productsArray of objects

Массив товаров с ценами

not_found_idArray of numbers

totalnumber

Общее количество товаров

countnumber

Количество товаров в запросе

limitnumber

Oграничение по количеству элементов в ответе

offsetnumber

Параметр текущего смещения.

next_offsetnumber

Параметр смещения для получения следующего списка товаров. Служит для определения, нужен ли еще один запрос.

Ответ

application/json

{
  "status": true,
  "products": [
    { … },
    { … }
  ],
  "not_found_id": [
    18,
    19,
    22
  ],
  "total": 1409,
  "count": 1000,
  "limit": 2,
  "offset": 0,
  "next_offset": 1000
}

Работа с каталогами Дилера

Операции

Категории каталогов

Операции

Товары каталогов

Операции

Работа с источниками дилера

Операции

Категории источников

Операции

Товары источников

Операции

Работа со стеком импорта

Операции

Apicore Dealer API

Telegram

Api-ключ

Категории каталогов Дистрибьюторов

Товары Дистрибьюторов

Получение полного набора данных о товаре

Запрос

Ответы

Насколько это было полезно?

Получение товаров каталогов Дистрибьюторов

Запрос

Ответы

Насколько это было полезно?

Получение цен товаровустаревший

Запрос

Ответы

Насколько это было полезно?

Получение цен товаров

Запрос

Ответы

Насколько это было полезно?

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

Запрос

Ответы

Насколько это было полезно?

Получение общих данных цен и остатков

Запрос

Ответы

Насколько это было полезно?

Получение параметров товаров

Запрос

Ответы

Насколько это было полезно?

Получение изображений товаров

Запрос

Ответы

Насколько это было полезно?

Получение описаний товаров

Запрос

Ответы

Насколько это было полезно?

Получение свойств товаров

Запрос

Ответы

Насколько это было полезно?

Работа с каталогами Дилера

Категории каталогов

Товары каталогов

Работа с источниками дилера

Категории источников

Товары источников

Работа со стеком импорта