К содержимому
post/v3/marketplace/api/shop

Добавление точки продаж в маркетплейс

Магазин и точка продаж добавляются в маркетплейс одним запросом:

Пример запроса
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
}

Ответ (по схеме):

{
  "data": {
    "id": 1,
    "title": "string",
    "description": "string",
    "shortDescription": "string",
    "seoTitle": "string",
    "seoKeywords": "string",
    "seoDescription": "string",
    "categoryId": 1,
    "shopDeliveryId": 1,
    "alias": "string",
    "shopUrl": "string",
    "minOrderSum": 100.5,
    "stockMode": "string",
    "priceMode": "string",
    "notificationEmail": "string",
    "defaultPriceId": 1,
    "imagePath": "string",
    "imageId": 1,
    "ogImagePath": "string",
    "ogImageId": 1,
    "mode": "string",
    "jivositeId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "orderFlow": "string",
    "yandexMetrikaId": 1,
    "deliveryInfo": "string",
    "shopIds": {},
    "accountProgramIds": {},
    "type": "string",
    "orderLifetime": 1,
    "modelId": 1,
    "manualProperties": {},
    "compiledProperties": {},
    "properties": {},
    "imageIds": {},
    "modelIds": {},
    "hours": {
      "mon": {},
      "tue": {},
      "wed": {},
      "thu": {},
      "fri": {},
      "sat": {},
      "sun": {}
    },
    "address": "string",
    "lat": 100.5,
    "lon": 100.5,
    "distance": 100.5,
    "externalId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "brandId": 1,
    "merchantId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "countryId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "cityId": 1,
    "active": false,
    "priority": 1,
    "merchantCategoryId": 1,
    "status": "string",
    "contactEmail": "string",
    "contactPhone": "string",
    "contactVkLink": "string",
    "contactTgLink": "string",
    "contactOkLink": "string"
  },
  "metaData": {
    "totalCount": 1,
    "pageSize": 1,
    "page": 1
  },
  "extendedData": [
    {
      "type": "string",
      "data": {}
    }
  ]
}

CreateShopRequest

СвойствоТипОписаниеПример значения
title *string(50)Название магазинаТестовый магазин
descriptionstring(2000)Описание магазинаЭто наш первый тестовый магазин
brandIdintИдентификатор магазина с типом brand123
merchantIdstring(36)Идентификатор магазина Инвойсбокс, для подгрузки чсти данных из Инвойсбокс01771534-1a57-f184-dee3-ebeb91dded76
accountProgramIdsarrayМассив идентификаторов программ лояльностей, котоыре принимает точка[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
accountProgramIdsarrayМассив идентификаторов программ лояльностей, которые принимает точка[01771534-1a57-f184-dee3-ebeb91dded71,01771534-1a57-f184-dee3-ebeb91dded72]

Параметры запроса — POST

7 обязательных из 24
ПолеТипОписание
title#string≤ 50 символов
description#string≤ 2000 символов
shortDescription#string≤ 2000 символов
mode#string≤ 100 символов
accountProgramIds#ArrayMap | null
type#string
modelId#integer | null
manualProperties#ArrayMap
hours#AppDomainEntityHoursPaymentgatewayCreateApiCreate | null
address#string≤ 200 символов
lat#number
lon#number
externalId#string | null≤ 50 символов
brandId#integer | null
merchantId#string | null≤ 36 символов
active#boolean
merchantCategoryId#integer | null
Страница помогла?
postДобавление точки продажДемо
curl -X POST 'https://api.invoicebox.ru/v3/marketplace/api/shop' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -d '{
  "description": "Оплата бронирования"
}'
Точка продаж создаётся в вашей организации, а не на демо-магазине.
getСписок точек продажДемо
curl -X GET 'https://api.invoicebox.ru/v3/marketplace/api/shop' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'