Seller API

  • Общая информация
  • Заказы
    • Получения списка заказов
    • Получения содержания заказа по номеру заказа
    • Изменения статуса заказа
    • Вызов страницы оформления заказа

Общая информация

API для продавцов – программный интерфейс, который предназначен для получения информации о заказах и сопутствующих данных, поступивших через платформу. Данный программный интерфейс соответствует спецификации JSON API. Спецификация описывает процесс взаимодействия клиент-серверных систем, построенных на базе формата сообщений JSON и протокола передачи гипертекста (HTTP). 

Каждый запрос в систему сопровождается заголовками и набором параметров.

Каждый запрос обязательно должен содержать следующие: 

  • API-KEY — ключ, сгенерированный в управлении API-ключами

Все даты указываются в часовом поясе Алматы. 

Заказы

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

POST https://marketapi.forte.kz​/v1​/shopping-cart​/orders​/filter​/ — Получение списка заказов

Request URL: https://marketapi.forte.kz/v1/shopping-cart/orders/filter/
Request Method: POST
API-KEY: 00fc80b1-6a6a-4724-833f-09c0c9bfc245

{
"from":0,
"size":15,
"scope":"fortemarket",
"order_status":["pending_approve","filled_not_approved"],
"city_id":"",
"sort":"updated_on_DESC",
"paid":true
}

Ответ

{
   "total_hits":1,
   "orders":[
      {
         "uid":"3160627797379-00889",
         "invoice_ref":"1535274783225417929",
         "scope":"fortemarket",
         "fio":" Иван",
         "mobile":"701*******",
         "order_status":"filled_not_approved",
         "order_status_title":"Анкета заполнена. Ожидание подтверждения продавцом",
         "created_on":"2020-08-20T10:01:37.131549873Z",
         "paid":false,
         "updated_on":"2020-08-20T13:15:10.031476711Z",
         "common_price":73900,
         "delivery_types":"delivery",
         "pay_title":"Рассрочка на 24 месяца",
         "pay_types":"FORTE_EXPRESS",
         "merchant_ids":[
            "9bbsKSj51UMsZGVLMm
"
         ],
         "own_type":"dar_profile_id",
         "owner":"b4f2fcd4-3bf1-3f43-ac01-6f3c9cd5b7b2",
         "address":"Алматы, Шевченко, 22",
         "city_id":"KZ-ALA"
      }
   ]
}


Данный запрос возвращает список заказов, оставленных покупателями. Содержит общую цену заказа, способ доставки и оплаты, статус заказа и оплаты, даты создания и одобрения банком, требуется ли подписание. 

В список попадают только те заказы, которые соответствуют следующим условиям:

  • Клиент оформил заказ 
  • Клиент завершил оплату или по нему одобрен займ или не совершал оплату онлайн, так как выбрал способ оплаты “Наличными”

Запрос может принимать следующие параметры:

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

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

  • NEW – новый заказ
  • ACCEPTED_BY_MERCHANT– принят продавцом 
  • TAKEN – выдан
  • CANCELLED – отменен
  • RETURNED – возвращен

pending_approve — Ожидает подтверждения мерчантом
filled_not_approved — Анкета заполнена. Ожидание подтверждения продавцом
approved_not_filled — Подтвержден продавцом. Ожидание анкеты
awaiting_loan_approve — Ожидает подтверждения банком
pending_pickup — Ожидает выдачи
on_delivery — На доставке
cancelled — Отменён продавцом
taken — Выдан
delivered — Доставлен
returned — Возвращен
cancelledbybank — Отменён банком
cancelledbyclient — Отменён покупателем

Способ доставки

delivery_types

Способ доставки заказа. Перечисляемый тип, может принимать одно из следующих значений:
PICKUP — самовывоз
DELIVERY — доставка 

Требуется подписание

«paid»:true

Требуется ли подписания документов. Булевое значение: 

  • TRUE – подписания требуется 
  • FALSE – подписания не требуется

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

created_on

Диапазон начальной и конечной даты поиска заказа. Поиск осуществляется по дате создания заказа. Указывается как unix timestamp. Обязательный параметр.

Ответ содержит следующие поля:

  • Информация о заказе
    • Номер заказа
    • Статус заказа
    • Название витрины
    • Дата и время поступления заказа
    • Сумма
  • Информация об оплате
    • Статус оплаты/займа
    • Способ оплаты
  • Информация о доставке/самовывозе
    • Способ
    • Планируемая дата
    • Город
      • ID
      • Наименование
    • Стоимость доставки
  • Покупатель
    • Имя
    • Фамилия
    • Телефон
  • Связи
    • URL запроса “Получения содержания заказа по номеру заказа”

Получения содержания заказа по номеру заказа

POST https://marketapi.forte.kz​/shopping-cart​/orders​/{id} — Получение деталей заказа по ID

Запрос

Request URL: https://marketapi.forte.kz/v1/shopping-cart/orders/3160627797379-00889
Request Method: POST
API-KEY: 00fc80b1-6a6a-4724-833f-09c0c9bfc245

{}

Ответ

{
   "basket_id": "0eca3cf9-e2cc-11ea-b349-0a580a020759"
   "calculate_by_delivery": true
   "city_id": "KZ-ALA"
   "common_price": 73900
   "common_quantity": 1
   "created_on": "2020-08-20T10:01:37.131549873Z"
   "delivery_types": "delivery"
   "estimated_delivery_date": "2020-08-27T10:01:36.477251642Z"
   "invoice_is_created": true
   "invoice_ref": "1535274783225417929"
   "own_type": "dar_profile_id"
   "owner": "b4f2fcd4-3bf1-3f43-ac01-6f3c9cd5b7b2"
   "paid": false
   "paidDate": "0001-01-01T00:00:00Z"
   "pay_title": "Рассрочка на 24 месяца"
   "pay_types": "FORTE_EXPRESS"
   "pickup_date": "2020-08-27T10:01:36.477251642Z"
   "scope": "fortemarket"
   "status": "filled_not_approved"

   "status_title": "Анкета заполнена. Ожидание подтверждения продавцом"
   "uid": "3160627797379-00889"
   "updated_on": "2020-08-20T13:15:10.031476711Z"
}

Данный запрос возвращает состав заказа, оставленных покупателями. Содержит общую цену заказа, способ доставки и оплаты, статус заказа и оплаты, даты создания и одобрения банком, требуется ли подписание.

Запрос может принимать следующие параметры:

Номер заказа

Ответ содержит следующие поля:

  • Информация о заказе
    • Номер заказа
    • Статус заказа
    • Название витрины
    • Дата и время поступления заказа
    • Сумма
  • Информация об оплате
    • Статус оплаты/займа
    • Способ оплаты
    • Период займа (Если заказ оформлен в кредит/рассрочку)
  • Информация о доставке/самовывозе
    • Способ
    • Планируемая дата
    • Город
      • ID
      • Наименование
    • Адрес
      • ID точки продаж продавца. Если способ оплаты самовывоз, то в данном поле должно быть значение ID точки продаж продавца
      • Улица
      • Дом
      • Квартира/офис
    • Стоимость доставки
  • Покупатель
    • <Н
  • Содержание заказа
    • Название на ForteMarket
    • Название у продавца
    • Код товара продавца
    • Стоимость
    • Количество
  • История изменений
    • Дата и время
    • Действие
  • Отзыв (если есть)
    • Дата и время
    • Текст отзыва 
    • Оценка покупателя
    • Статус решения проблемы

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

POST https://marketapi.forte.kz/v1​/shopping-cart​/orders​/{id}​/set-status Обновление статуса заказа

Данный запрос изменяет статус заказа.

Запрос может принимать следующие параметры:

  • Номер заказа
  • Статус* – Новый статус заказа. Обязательный атрибут. Может принимать одно из следующих
  • значений:
    • ACCEPTED_BY_MERCHANT — Товар принят продавцом. 
    • COMPLETED – Товар выдан покупателю. Может быть использован, только если текущий статус ACCEPTED_BY_MERCHANT. 

В случае, если заказ в оформлен в кредит: 

  • Первым запросом отправляете COMLETED c ИИН клиента, 
  • На номер покупателя будет отправлен секретный СМС код 
  • После того, как покупатель сообщит СМС код, отправляете повторный запрос с указанием кода из СМС. Если код верный то статус заказа меняется на COMLETED. 

В случае, если заказ по безналичной оплате: 

  • Первым запросом отправляете COMLETED 
  • На номер покупателя будет отправлен секретный СМС код 
  • После того, как покупатель сообщит СМС код, отправляете повторный запрос с указанием кода из СМС. Если код верный то статус заказа меняется на COMLETED.

В случае, если заказ по наличной оплате: 

  • Первым запросом отправляете COMLETED и статус заказа меняется на COMLETED.
  • CANCELLED – Заказ отменен. Может быть использован, только если текущий статус ACCEPTED_BY_MERCHANT или NEW. 

В случае отмены необходимо указать: 

cancellationReason – Причина отмены. Может принимать одно из следующих значений:

  • BUYER_CANCELLATION_BY_MERCHANT – Отказ покупателя
  • BUYER_NOT_REACHABLE – Не удалось дозвониться до покупателя
  • MERCHANT_OUT_OF_STOCK – Нет в наличии

cancellationComment – Комментарий при отмене заказа. Может быть выставлен только при статусе заказа CANCELLED. Не должен быть больше 1000-ти знаков.

Ответ содержит следующие поля:

  • Номер заказа
  • Новый статус заказа

POST https://marketapi.forte.kz/v1​/shopping-cart​/orders​/{id}​/set-status Обновление статуса заказа
POST https://marketapi.forte.kz​/shopping-cart​/orders​/{id} Получение деталей заказа по ID
POST https://marketapi.forte.kz/shopping-cart​/orders​/sms​/ — Отправка СМС-сообщения

POST https://marketapi.forte.kz​/shopping-cart​/orders​/byinvoice Получение деталей заказа по invoice
POST https://marketapi.forte.kz/shopping-cart​/orders​/{id}​/pickup-points Обновление точки выдачи