Seller API

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

Текущая версия Seller API v3

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

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

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

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

Все даты указываются в часовом поясе UTC+6 

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

  • pending_approve — Ожидает подтверждения наличия
  • shipment — На доставке
  • taken — Выдан

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

Адрес:

GET v3/shopping-cart/orders/filter/

Тело запроса:

{

    "scope": "fortemarket",
    "size": 15,
    "sort": "updated_on_DESC",
    "from": 0,
    "order_status": [
        "pending_approve"

    ]
}

Ответ сервера:

{
    "total_hits": 1,
    "orders": [
        {
            "uid": "4015490658352-71774",
            "version": 3,
            "invoice_ref": "307c3c76-b238-11ec-85e7-5e00af60b03a",
            "invoice_status": "paid",
            "scope": "fortemarket",

            "order_status": "pending_approve",
            "order_status_title": "Ожидает подтверждения",
            "created_on": "2022-04-02T03:51:34.299836463Z",
            "paid": true,
            "updated_on": "2022-04-02T04:39:37.312275106Z",
            "common_price": 129579,
            "delivery_price": 2395,
            "delivery_types": "dhl",
            "delivery_title": "DHL",
            "estimated_delivery_date": "2022-04-10T03:51:34.292450332Z",
            "pay_title": "Рассрочка на 4 месяца",
            "pay_types": "FORTE_EXPRESS",
            "pay_types_code": "FORTE_EXPRESS_0_4",

            "own_type": "forte_id",
            "city_id": "KZ-PAV-552210000",

            "common_old_price": 129579,
            "delivery_old_price": 2395
        }
    ]
}

Статусы заказа:

  • pending_approve (ожидает подтверждения)
  • shipment (ожидает доставки)
  • taken (выдан)
  • returned (возвращен)

Получение деталей заказа

Адрес:

GET v3/shopping-cart/orders/{{order_id}}

Тело запроса:

{}

Ответ сервера:


Подтверждение наличия товара

Товары которые требуется подтвердить, следует перевести в статус shipment.

Адрес:

POST /v3/shopping-cart/order/{{order_id}}/set-status

Тело запроса:

{
    "set_status": "shipment",
    "comment": "merchant"
}

Ответ сервера:

{}

Отклонение заказа

Товары которые требуется отклонить, следует перевести в статус cancelledbymerchant.

Адрес:

POST /v3/shopping-cart/order/{{order_id}}/set-status

Тело запроса:

{
    "set_status": "cancelledbymerchant",
    "comment": "merchant"
}

Ответ сервера:

{}

Выдача товара

Товары находящиеся в статусе доставке, выдаются через OTP верификацию.

Отправка SMS

Адрес:

POST /v2/delivery/parcel/sms/send

Тело запроса:

{
    "parcel_id": "{{order_id}}"
}

Ответ сервера

{
    "message": "SMS send"
}

Проверка SMS

Адрес

POST /v2/delivery/parcel/sms/check

Тело запроса

{
    "parcel_id": "{{order_id}}",
    "sms_code": "578765"
}

Ответ сервера

{
    "message": "success"
}

Отклонение заказа

Товары которые требуется отклонить, следует перевести в статус cancelledbymerchant.

Адрес:

POST /v3/shopping-cart/order/{{order_id}}/set-status

Тело запроса:

{
    "set_status": "returned",
    "comment": "merchant"
}

Ответ сервера:

{}