Техническая информация
Seller API
Общая информация
Текущая версия Seller API v3
API для продавцов – программный интерфейс, который предназначен для получения информации о заказах и сопутствующих данных, поступивших через платформу. Данный программный интерфейс соответствует спецификации JSON API. Спецификация описывает процесс взаимодействия клиент-серверных систем, построенных на базе формата сообщений JSON и протокола передачи гипертекста (HTTP).
Каждый запрос в систему сопровождается заголовками и набором параметров.
Каждый запрос обязательно должен содержать следующие:
- API-KEY — ключ, сгенерированный в управлении API-ключами
Статусы заказов:
- pending_approve — Ожидает подтверждения наличия
- shipment — На доставке
- taken — Выдан
- returned — Возвращен
- cancelledbybank — Отменён банком
- cancelledbyclient — Отменён покупателем
- cancelledbymerchant — Отменён продавцом
- cancelledbytimeout — Отменён по таймауту
Получение списка заказов
Адрес:
POST 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
}
]
}
Получение деталей заказа
Адрес:
POSTv3/shopping-cart/order/{{order_id}}
Тело запроса:
{}
Ответ сервера:
{
"basket_id": "53e6591e-af67-11ec-b4bc-e2a8ac4ecfe5",
"uid": "4010297363917-92194",
"version": 3,
"scope": "fortemarket",
"created_on": "2022-03-29T13:52:29.820303851Z",
"updated_on": "2022-04-05T04:30:15.278429605Z",
"own_type": "forte_id",
"owner": "a6e8a358-cf8a-43b5-82d4-ed1eb7a60779",
"common_price": 255000,
"common_old_price": 260000,
"common_quantity": 1,
"pay_types": "FORTE_EXPRESS",
"pay_types_code": "FORTE_EXPRESS_0_12",
"pay_title": "Рассрочка на 12 месяцев",
"paid": true,
"invoice_ref": "799909f6-af67-11ec-8c26-aecd808b1bdb",
"invoice_status": "paid",
"status": "taken",
"status_title": "Выдан",
"delivery_price": 2395,
"delivery_old_price": 2395,
"delivery_types": "dhl",
"delivery_title": "DHL",
"delivery_state": "delivered",
"delivery_params": {
"from_city": "KZ-AST",
"is_courier": true,
"add_delivery_price_to_total": false
},
"estimated_delivery_date": "2022-04-06T13:52:29.802907019Z",
"invoice_is_created": true,
"paidDate": "2022-03-29T14:03:50.843576015Z",
"merchantId": "AGV11gNpST8sj169wG",
"city_id": "KZ-PAV-551010000",
"status_history": [
{
"status": "new",
"status_title": "Новый заказ",
"created_on": "2022-03-29T13:52:29.820320399Z"
},
{
"status": "pre_approve",
"status_title": "Требуют заполнения",
"created_on": "2022-03-29T13:53:18.399526658Z"
},
{
"status": "awaiting_loan_approve",
"status_title": "Согласование в банке",
"created_on": "2022-03-29T13:55:06.776280211Z"
},
{
"status": "pending_approve",
"status_title": "Ожидает подтверждения",
"created_on": "2022-03-29T14:03:50.843578446Z"
},
{
"status": "shipment",
"status_title": "На доставке",
"created_on": "2022-03-29T14:31:53.040306924Z"
},
{
"status": "taken",
"status_title": "Выдан",
"created_on": "2022-04-05T04:30:15.278428445Z",
"updated_by_profile_id": "ca341fc7-abd9-37c5-bf51-e5341f11e4e9",
"updated_by_name": "Хамит Махамбаев",
"updated_by_mobile_phone": "7012870878"
}
],
"pickup_date": "2022-04-06T13:52:29.802907019Z",
"calculate_by_delivery": true,
"promocode": "FORTE",
"promo_codes": [
"FORTE"
],
"promocode_name": "Скидка на первый заказ 5000 тенге",
"is_promocode_applied": true,
"common_discount_size": 5000,
"discount_results": [
{
"promo_code": "FORTE",
"discount": 5000,
"applied_for": "goods",
"promo_code_name": "Скидка на первый заказ 5000 тенге",
"type": "promocode",
"is_only_for_ban_card": false
}
],
"group_orders_ids": [
"4010297363917-92194"
],
"request_ip": "10.0.127.52",
"user_agent": "Mozilla/5.0 (Linux; Android 10; SM-G965F Build/QP1A.190711.020; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/99.0.4844.73 Mobile Safari/537.36",
"delivery_items": [
{
"id": "70de6baf-8fd2-11ec-b0a7-06e6100cc308",
"name": "Трансформационная игра._BB._Свидание с собой._большая",
"price": 260000,
"merchant_id": "AGV11gNpST8sj169wG",
"weight": 1,
"height": 18,
"length": 40,
"width": 27,
"quantity": 1,
"options": null,
"cities_options": [
{
"city_id": "KZ-AST"
}
],
"categories_array": [
"2756d465-643a-11ea-a96d-0a580a02044e",
"07f1af1a-b585-11eb-beee-0a580a02057d",
"aaf4776e-1a32-11e9-973e-0a580a0203f0"
]
}
],
"delivery_info": [
{
"merchant_id": "AGV11gNpST8sj169wG",
"total": 2395,
"type": "dhl",
"item_results": [
{
"item_id": "70de6baf-8fd2-11ec-b0a7-06e6100cc308",
"type": "dhl",
"title": "DHL",
"price": 2395,
"date": "2022-04-06T13:52:29.802907019Z",
"stores": []
}
]
}
],
"parcel_id": "4010297363917-92194",
"order_status_stages": [
{
"status": "new",
"title": "Новый заказ",
"created_on": "2022-03-29T13:52:29.820320399Z",
"stage_status": "passed"
},
{
"status": "pre_approve",
"title": "Заполнение анкеты",
"created_on": "2022-03-29T13:53:18.399526658Z",
"stage_status": "passed"
},
{
"status": "awaiting_loan_approve",
"title": "Подписание кредитного договора",
"created_on": "2022-03-29T13:55:06.776280211Z",
"stage_status": "passed"
},
{
"status": "pending_approve",
"title": "Подтверждение наличия товара",
"created_on": "2022-03-29T14:03:50.843578446Z",
"stage_status": "passed"
},
{
"status": "shipment",
"title": "На доставке",
"created_on": "2022-03-29T14:31:53.040306924Z",
"stage_status": "passed"
},
{
"status": "taken",
"title": "Заказ выдан",
"created_on": "2022-04-05T04:30:15.278428445Z",
"stage_status": "passed"
}
],
"seller_data": {
"settlements": {
"items": [
{
"item_id": "70de6baf-8fd2-11ec-b0a7-06e6100cc308",
"commission": 11,
"commission_sum": 28600,
"refund_sum": 0
}
],
"products_sum": 260000,
"commission_sum": 28600,
"refund_sum": 0,
"merchant_income": 231400
}
},
"next_status": [
"returned"
]
}
Расшифровка:
"basket_id" - идентификатор корзины
"uid" - номер заказа
"version" - версия заказа
"scope" - источник создания
"created_on" - время создания
"updated_on" - время последнего изменения
"own_type" - сервис авторизации клиента
"owner" - идентификатор авторизации клиента
"common_price" - сумма заказа после применения промокодов
"common_old_price" - сумма заказа
"common_quantity" - количество товаров в заказе
Подтверждение наличия товара
Адрес:
POST /v3/shopping-cart/order/{{order_id}}/set-status
Тело запроса:
{
"set_status": "shipment",
"comment": "merchant"
}
Ответ сервера:
{}
Отклонение заказа
Адрес:
POST/v3/shopping-cart/order/{{order_id}}/set-status
Тело запроса:
{
"set_status": "cancelled",
"comment": "merchant"
}
Ответ сервера:
{}
Выдача товара
Отправка 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"
}
Отклонение заказа
Адрес
POST/v3/shopping-cart/order/{{order_id}}/set-status
Тело запроса:
{
"set_status": "returned",
"comment": "merchant"
}
Ответ сервера:
{}