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

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 товаров. Чтобы получить следующие 200 товаров добавьте в тело запроса параметр смещения offset:200

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

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

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

Ответы

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

Телоapplication/json

statusboolean

productsArray of objects

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

totalnumber

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

countnumber

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

limitnumber

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

offsetnumber

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

next_offsetnumber

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

Ответ

application/json

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

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

Запрос

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

Один запрос возвращает до 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

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

curl -i -X POST \
  https://api.apicore.one/dealer/v1/catalog.product.list \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "catalog_code": "main",
    "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
}

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

Запрос

Метод возвращает цены товаров каталога дилера. Один запрос возвращает до 1000 записей цен.

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

curl -i -X POST \
  https://api.apicore.one/dealer/v1/catalog.product.prices \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "catalog_code": "main",
    "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
}

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

Запрос

Метод возвращает остатки товаров каталога дилера. Один запрос возвращает до 1000 записей остатков.

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

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

Ответы

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

Телоapplication/json

statusboolean

productsArray of objects

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

totalnumber

Общее количество доступных товаров

countnumber

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

limitnumber

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

offsetnumber

Параметр смещения

next_offsetnumber

Параметр определения, нужен ли еще один запрос.

Ответ

application/json

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

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

Запрос

Метод возвращает изображения товаров каталога дилера. Один запрос возвращает до 1000 записей.

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

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

webpboolean

Параметр для получения изображений в формате webp.

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

Ответы

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

Телоapplication/json

statusboolean

productsArray of objects

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

totalnumber

Общее количество доступных товаров

countnumber

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

limitnumber

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

offsetnumber

Параметр смещения

next_offsetnumber

Параметр определения, нужен ли еще один запрос.

Ответ

application/json

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

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

Запрос

Метод возвращает описания товаров каталога дилера. Один запрос возвращает до 1000 записей.

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

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

Ответы

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

Телоapplication/json

statusboolean

productsArray of objects

totalnumber

Общее количество доступных товаров

countnumber

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

limitnumber

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

offsetnumber

Параметр смещения

next_offsetnumber

Параметр определения, нужен ли еще один запрос.

Ответ

application/json

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

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

Запрос

Метод возвращает параметры товаров каталога дилера. Один запрос возвращает до 1000 записей.

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

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

Ответы

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

Телоapplication/json

statusboolean

productsArray of objects

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

totalnumber

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

countnumber

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

limitnumber

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

offsetnumber

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

next_offsetnumber

Параметр определения, нужен ли еще один запрос.

Ответ

application/json

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

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

Запрос

Метод возвращает свойства товаров каталога дилера. Один запрос возвращает до 1000 записей.

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Уникальный идентификатор каталога. Ограничен 40 символами

limitnumber

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

offsetnumber

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

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

Ответы

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

Телоapplication/json

statusboolean

productsArray of objects

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

totalnumber

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

countnumber

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

limitnumber

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

offsetnumber

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

next_offsetnumber

Параметр определения, нужен ли еще один запрос.

Ответ

application/json

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

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

Операции

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

Операции

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

Операции

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

Операции

Apicore Dealer API

Telegram

Api-ключ

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

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

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

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

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

Запрос

Ответы

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

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

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

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

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