Добавление точки продаж в маркетплейс
Для добавления магазина и точки продаж в маркетплейс, необходимо вызвать следующий метод API:
- метод:
POST
- ресурс:
/v3/marketplace/api/shop
- тело запроса - объект CreateShopRequest
- тело ответа - объект ShopResponse
- Возможные ошибки
Пример запроса
POST /v3/marketplace/api/shop
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
"title": "Тестовый магазин",
"description": "Это наш тестовый магазин",
"brandId": 123,
"merchantId": "01771534-1a57-f184-dee3-ebeb91dded76",
"externalUpdate": true
}
CreateShopRequest
Свойство | Обязательное | Тип | Описание | Пример значения |
---|---|---|---|---|
title | да | string(50) | Название магазина | Тестовый магазин |
description | нет | string(2000) | Описание магазина | Это наш первый тестовый магазин |
brandId | нет | int | Идентификатор магазина с типом brand | 123 |
merchantId | нет | string(36) | Идентификатор магазина Invoicebox, для подгрузки чсти данных из Invoicebox | 01771534-1a57-f184-dee3-ebeb91dded76 |
accountProgramIds | нет | array | Массив идентификаторов программ лояльностей, котоыре принимает точка | [01771534-1a57-f184-dee3-ebeb91dded71 ,01771534-1a57-f184-dee3-ebeb91dded72 ] |
ShopResponse
Повторяет свойства объекта CreateShopRequest с дополнительными свойствами:
Свойство | Обязательное | Тип | Описание | Пример значения |
---|---|---|---|---|
id | да | int | Идентификатор магазина | 12 |
token | да | string(64) | Токен магазина | 95e5396611d261986cec0915a9f85799 |
type | да | string(50) enum | Тип магазина | shop ,marketplace ,external ,offline ,brand |
alias | да | string(20) | Алиас магазина | 1694158899 |
shopUrl | да | string(64) | Ссылка на магазин | https://1694158899.expressclient.ru |
accountProgramIds | нет | array | Массив идентификаторов программ лояльностей, которые принимает точка | [01771534-1a57-f184-dee3-ebeb91dded71 ,01771534-1a57-f184-dee3-ebeb91dded72 ] |