Описание API

Для работы с АПИ используется логин и пароль что были выданы Вам для доступа в Личный Кабинет. После успешной авторизации Вы получаете временный токен (срок жизни - 24 часа) используя который можно получить доступ ко всем запросам. Для авторизации по токену следует использовать тип авторизации Bearer token.

Авторизация

Авторизация - Логин

posthttps://f.ua/marketplace/api/login

BodyParams

Название Тип Описание
username String

Имя пользователя
password String

Пароль в base64()

Success 200

Название Тип Описание
id Number

ID марекетплейса

Допустимые значения: int

access_token String

access Токен авторизации
market Object
  id Number

ID маркетплейса

Допустимые значения: int

  email String

email маркетплейса
  logo String

Логотип (ссылка)

Допустимые значения: null

  title String

Название магазина

Допустимые значения: null

Категории

Категории - Список доступных категорий

Выборка всех доступных категорий на сайте

gethttps://f.ua/marketplace/api/categories/search

Request headers

Название Тип Описание
Authorization String

authorization header

Параметр

Название Тип Описание
category_id необязательный Number

ID категории

Формат значения: int

parent_id необязательный Number

ID родительской категории

формат значения: int 

https://f.ua/marketplace/api/categories/search?parent_id=1170

Success 200

Название Тип Описание
SuccessResponse json

{ "success": boolean, "content":{ "categories":[]}
MarketCategory Object

MarketCategoryModel
  category_id Number

ID категории
  parent_id Number

ID родительской категории
  name String

Название категории
  has_child Boolean

Наличие подкатегорий в категории

Категории - Список доступных характеристик категории

Выборка всех доступных категорий на сайте

gethttps://f.ua/marketplace/api/categories/properties

Request headers

Название Тип Описание
Authorization String

authorization header

Параметр

Название Тип Описание
category_id Number

ID категории

Формат значения: int 

https://f.ua/marketplace/api/categories/properties?category_id=4630027

Success 200

Название Тип Описание
SuccessResponse json

{ "success": boolean, "content":{ "properties":[]}
Properties Object

PropertiesModel
  id Number

ID свойства
  name String

Название параметра
  attr_type String

тип параметра

Возможные значения:

  • select Выбор одного вариана
  • select_multiple Выбор нескольких вариантов
  • number Числовое значение
  • text Текстовое значение
  • checkbox Выбор одного варианта
  • range Числовое значение (от и до)
  • title Заголовок
  required Boolean

Объязательность параметра

Возможные значения: true|false

  values Array

Возможные варианты значения параметра
  unit String

Единицы измерения
  description String

Описание параметра (служебное)

Управление заказами

Управление заказами - Счетчики заказов

Счетчики количества заказов "В обработке", "Успешно завершенные", "Отмененные", "Новые", "Доставляются"

gethttps://f.ua/marketplace/api/orders/counts

Request headers

Название Тип Описание
Authorization String

authorization header

Success 200

Название Тип Описание
inProgress Number

Кол-во заказов в обработке
inDone Number

Кол-во успешно завершенных заказов
inNotDone Number

Кол-во отмененных заказов
new Number

Кол-во новых заказов
delivering Number

Кол-во заказов в процессе доставки

Управление заказами - Детали заказа

Получение информации о заказе

gethttps://f.ua/marketplace/api/orders/id

Request headers

Название Тип Описание
Authorization String

authorization header

Параметр

Название Тип Описание
id Number

ID заказа (уникальный ID) Required

 
https://f.ua/marketplace/api/orders/4976618

Success 200

Название Тип Описание
Success-Response json

{ "success": boolean, "content": {} }
Order Object

OrderModel
  id Number

ID заказа

Формат значения: int

  created String

Дата создания заказа

Формат значения: YYYY-MM-DD H:i:s

  status Number

Статус заказа

Формат значения: int

  total_quantity Number

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

Формат значения: int

  amount Number

Сумма заказа по товарам

Формат значения: decimal(0000000000.00)

  delivery_address String

Адрес доставки
  seller_comment String

Комментарии продавца к заказу
  delivery_type String

Тип доставки которым была отправлення посылка

Возможные значения:

  • np - Нова пошта
  • me - Meest
  • up - Укрпочта
  • js - Justin
  ttn String

Товарно-транспортная накладная Required - при статусе заказа = 3
  seller_id Number

ИД Поставщика
  cancel_reason_code String

Код причины отказа
  cancel_reason String

Причина отказа
  customer Object

Информация о покупателе
    contact_fio String

ФИО покупателя
    user_phone String

Телефон покупателя
    comment String

Комментарий к заказу (от покупателя)
  products Object

Информация о товарах в заказе
    id Number

ID товара

Формат значения: int

    article String

Артикул товара
    name String

Название товара
    price Number

Цена товара в гривнах

Формат значения: decimal(0000000000.00)

    quantity Int

Rол-во товаров

Формат значения: int

    amount Number

Сума за товары

Формат значения: decimal(0000000000.00)

    photo_preview String

Фото-превью, в виде ссылки
    url String

Ссылка на товар
    catalog_category Object

Категория товара
      id Number

ID категории

Формат значения: int

      name String

Название категории

Управление заказами - Фильтры по заказам

Фильтры по заказам, выборка всех заказов

gethttps://f.ua/marketplace/api/orders/search

Request headers

Название Тип Описание
Authorization String

authorization header

Parameters

Название Тип Описание
page необязательный Number

Номер страницы

По умолчанию: 1

Допустимые значения: int

status необязательный Number

Статус заказа

Допустимые значения: int

created_from необязательный String

Дата создания заказа: от

Допустимые значения: YYYY-MM-DD

created_to необязательный String

Дата создания заказа: до

Допустимые значения: YYYY-MM-DD

Управление заказами - Редактирование заказа (статус, ТТН)

Редактирование заказа (смена статуса, добавление ТТН и комментария продавца)

posthttps://f.ua/marketplace/api/orders/id

Request headers

Название Тип Описание
Authorization String

authorization header
Content-type String

application/json

Параметр

Название Тип Описание
id Number

ID заказа Required

Допустимые значения: int

Body Params

Название Тип Описание
status Number

Новый статус заказа

Допустимые значения: int

seller_comment необязательный String

Комментарий продавца
ttn необязательный String

ТТН Required (Только при переходе в статус - 3)
delivery_type необязательный String

ТИП службы доставки Required (Только при переходе в статус - 3)

Допустимые значения:

  • np - Нова пошта
  • me - Meest
  • up - Укрпочта
  • js - Justin
cancel_reason_code необязательный String

Код причины отказа Required (Только при переходе в статус - 6)
cancel_reason необязательный String

Причина отказа Required (Только при переходе в статус - 6 и Код причины отказа - other)

 
https://f.ua/marketplace/api/orders/4976618

Success 200

Название Тип Описание
Success-Response json

Example (такой же ответ, как и в Order Details)

Статусы заказов

Статусы заказов - Статусы заказа

Информация по статусам, не является АПИ-запросом

Название Тип Описание
  0 Number

Новый заказ
  1 Number

Обрабатывается менеджером
  2 Number

Данные подтверждены. Ожидает отправки
  3 Number

Передан в службу доставки
  4 Number

Посылка получена
  5 Number

Отмена подтверждена
  6 Number

Отменен поставщиком
  7 Number

Требует уточнения. Присваивается в результате ошибки трекинга ттн (номер ттн удален, не найден или перевозчик ожидает поступление посылки более 5 дней)

Причины отмены

Информация по статусам, не является АПИ-запросом

Название Тип Описание
  other String

Другое
  replace_product String

Замена на другой товар
  cost_delivery String

Не устраивает стоимость доставки
  method_delivery String

Не устраивает перевозчик, способ доставки
  delivery_time String

Не устраивают сроки доставки
  prepayment String

Не устраивает предоплата
  quality_goods String

Не устраивает качество товара
  characteristics_not_fit String

Не подошли характеристики товара (цвет,размер)
  incorrect_price String

Некорректная цена на сайте
  bought_another_site String

Купил на другом сайте
  changed_mind String

Клиент передумал
  not_available String

Нет в наличии
  incorrect_contact String

Некорректные контактные данные
  not_contact_customer String

Не удалось связаться с покупателем
  defect String

Брак
  order_ungrouping String

Не устраивает разгруппировка заказа
  request_buyer String

По просьбе покупателя
  duplicate String

Заказ-дубликат
  fake String

Фейковый заказ
  not_take String

Не забрал заказ на