Apicore Distributor 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

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

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

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

distributor.json

distributor.yaml

Обзор API

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

Серверы

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

https://api.apicore.one/

Api-ключ

Операции

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

Операции

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

Операции

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

Операции

Работа с заказами

Операции

Получение списка заказов

Запрос

Метод возвращает список заказов дистрибьютора. Один запрос возвращает до 100 заказов.

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

filterobject

Фильтр по заказам.

Фильтрация по параметрам происходит по принципу "AND", т.е. заказ должен соответствовать всем условиям фильтра для вывода в результат.

withobject

Массив дополнительных полей, которые нужно добавить в ответ.

date_tzboolean

Признак конвертации дат в формат с временной зоной (TZ). Пример: 2025-10-18T19:23:45+05:00.

limitnumber

Oграничение по количеству заказов в ответе. Максимальное значение 100.

offsetnumber

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

curl -i -X POST \
  https://api.apicore.one/distributor/v1/order.list \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter": {
      "status_code": "NW",
      "order_id_gt": 10,
      "order_id_lt": 100,
      "order_id": [
        15,
        20,
        25
      ]
    },
    "with": {
      "note": true
    },
    "date_tz": false,
    "limit": 100,
    "offset": 0
  }'

Ответы

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

Телоapplication/json

statusboolean

ordersArray of objects

Массив заказов дистрибьютора.

totalnumber

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

countnumber

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

limitnumber

Лимит количества заказов в текущем ответе.

offsetnumber

Параметр смещения количества заказов.

next_offsetnumber

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

Ответ

application/json

{
  "status": true,
  "orders": [
    { … }
  ],
  "total": 250,
  "count": 100,
  "limit": 100,
  "offset": 0,
  "next_offset": 100
}

Изменение статуса заказа

Запрос

Метод меняет статус заказа дистрибьютора.

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Номер заказа дистрибьютора.

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

Код статуса заказа.

curl -i -X POST \
  https://api.apicore.one/distributor/v1/order.status.set \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": 1,
    "status_code": "NW"
  }'

Ответы

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

Телоapplication/json

statusboolean

messagestring

Ответ

application/json

{
  "status": true,
  "message": "Статус заказа успешно изменен"
}

Изменение состава заказа

Запрос

Метод меняет состав заказа, изменяя количество, цену, валюту и список товаров.

Указывается полный список товаров, включая их количество, цену, валюту. Если товар не найден в заказе, он будет добавлен. Если товар есть в заказе, но отсутствует в теле запроса, то товар будет удален из заказа.

Если было хоть одно изменение, то сумма заказа будет пересчитана.

Все изменения отображаются в истории заказа.

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Номер заказа дистрибьютора.

productsArray of objectsОбязательные поля

Список товаров в заказе.

products[].ext_idstringОбязательные поля

Внешний ID - идентификатор товара в системе дистрибьютора, уникальный в рамках каталога. Ограничен 40 символами.

products[].namestring

Название товара. Указывать не обязательно, если товар уже существует в каталоге Apicore. Если товара нет в каталоге, то он будет создан с этим названием и привязан к заказу.

products[].quantitynumberОбязательные поля

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

products[].purchasenumberОбязательные поля

Цена товара в заказе.

products[].purchase_currencystringОбязательные поля

Валюта цены товара в заказе.

curl -i -X POST \
  https://api.apicore.one/distributor/v1/order.product.update \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": 1,
    "products": [
      {
        "ext_id": "ext-5001",
        "name": "Товар 1",
        "quantity": 3,
        "purchase": 5500,
        "purchase_currency": "KZT"
      },
      {
        "ext_id": "ext-5002",
        "name": "Товар 2",
        "quantity": 1,
        "purchase": 4600,
        "purchase_currency": "KZT"
      }
    ]
  }'

Ответы

Успешный ответ. Возвращает результат с указанием проведенных изменений.

Телоapplication/json

statusboolean

no_updateArray of arrays

Массив ext_id товаров, которые не были изменены. Либо null, если по всем товарам были изменения.

quantity_updateArray of arrays

Массив ext_id товаров, для которых было изменено количество. Либо null, если не было изменений по количеству.

purchase_updateArray of arrays

Массив ext_id товаров, для которых была изменена цена/валюта. Либо null, если не было изменений по цене.

addArray of arrays

Массив ext_id товаров, которые были добавлены в заказ. Либо null, если не было товаров для добавления.

deleteArray of arrays

Массив ext_id товаров, которые были удалены из заказа. Либо null, если не было товаров для удаления.

Ответ

application/json

{
  "status": true,
  "no_update": null,
  "quantity_update": [
    "ext-5001",
    "ext-5002"
  ],
  "purchase_update": [
    "ext-5001"
  ],
  "add": null,
  "delete": [
    "ext-5003"
  ]
}

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

Запрос

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

Заголовки

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

Пример: application/json

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

Пример: application/json

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

curl -i -X POST \
  https://api.apicore.one/distributor/v1/order.status.list \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json'

Ответы

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

Телоapplication/json

statusboolean

statusesArray of objects

Массив статусов заказа дистрибьютора.

Ответ

application/json

{
  "status": true,
  "statuses": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Изменение параметра оплаты заказа

Запрос

Метод устанавливает/снимает параметр оплаты заказа дистрибьютора.

Заголовки

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

Пример: application/json

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

Пример: application/json

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

Телоapplication/json

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

Номер заказа дистрибьютора.

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

Признак оплаты заказа. true - оплачен, false - не оплачен.

curl -i -X POST \
  https://api.apicore.one/distributor/v1/order.payment.set \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": 1,
    "payed": true
  }'

Ответы

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

Телоapplication/json

One of:

statusboolean

messagestring

Ответ

application/json

{
  "status": true,
  "message": "Оплата заказа установлена"
}

Работа с типами цен

Операции

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

Операции

Apicore Distributor API

Telegram

Api-ключ

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

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

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

Работа с заказами

Получение списка заказов

Запрос

Ответы

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

Изменение статуса заказа

Запрос

Ответы

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

Изменение состава заказа

Запрос

Ответы

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

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

Запрос

Ответы

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

Изменение параметра оплаты заказа

Запрос

Ответы

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

Работа с типами цен

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

Apicore Distributor API

Telegram

Api-ключ

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

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

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

Работа с заказами

Получение списка заказов

ЗапросРазвернуть все

Ответы

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

Изменение статуса заказа

Запрос

Ответы

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

Изменение состава заказа

ЗапросРазвернуть все

Ответы

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

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

Запрос

Ответы

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

Изменение параметра оплаты заказа

Запрос

Ответы

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

Работа с типами цен

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

Запрос

Запрос