Главная
/
Файлы заказов

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, с радостью рассмотрим предложения.

Telegram

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

Скачать спецификацию OpenAPI
dealer.json
dealer.yaml
Обзор API
Связаться с поддержкой support@apicore.one
Языки программирования
Серверы
Основной сервер
https://api.apicore.one/

Api-ключ

Операции

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

Операции

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

Операции

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

Операции

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

Операции

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

Операции

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

Операции

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

Операции

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

Операции

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

Операции

Документы заказов

Операции

Файлы заказов

Операции

Прикрепление файла к заказу

Запрос

Метод прикрепляет файл к заказу.

Файл прикрепится к заказу с указанным order_id или ext_id и ext_source. Приоритет в идентификации заказа имеет поле order_id.

Размер файла не должен превышать 10 МБ.

Заголовки
Content-TypestringОбязательные поля
Пример: application/json
AcceptstringОбязательные поля
Пример: application/json
Api-KeystringОбязательные поля
Телоapplication/json
order_idnumber

Номер заказа. Имеет приоритет в идентификации заказа. Если не указан, тогда должны быть заполнены поля ext_id и ext_source.

ext_idstring

Внешний ID заказа из внешнего источника.

ext_sourcestring

Код внешнего источника, из которого создан заказ. Обязательно к заполнению, если указан ext_id.

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

Данные по файлу прикрепления.

attachment.​typestringОбязательные поля

Код типа файла. Список типов доступен в эндпоинте /dealer/v1/order.attachment.type.list.

attachment.​sourcestring

Код источника файла, задается произвольное значение. Ограничен 50 символами.

attachment.​titlestring

Название файла.

attachment.​file_base64stringОбязательные поля

Исходный файл в формате base64, размером не более 10Мб. Допустимые форматы файлов: jpg, jpeg, png, webp, gif, pdf, doc, docx, xls, xlsx, ppt, pptx, rtf, txt, csv, xml, svg.

curl -i -X POST \
  https://api.apicore.one/dealer/v1/order.attachment.add \
  -H 'Accept: application/json' \
  -H 'Api-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": 1,
    "attachment": {
      "type": "shipping_label",
      "source": "kaspi",
      "title": "Транспортная наклейка Kaspi №123456789",
      "file_base64": "PHN2Zy ... Pg=="
    }
  }'

Ответы

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

Телоapplication/json
statusboolean

Статус ответа.

attachment_idstring

Уникальный идентификатор прикрепленного файла.

messagestring

Сообщение об успешном выполнении операции.

Ответ
application/json
{
  "status": true,
  "attachment_id": "01KXNKBJJ1G9STSP5B7RSEC444",
  "message": "Прикрепление успешно добавлено"
}

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

Операции
PC "APICORE LTD" ©