К содержимому
Инвойсбокс
put/v3/marketplace/api/shop/{id}

Обновление точки продаж

Точка продаж меняется по своему идентификатору:

  • метод: PUT
  • ресурс: /v3/marketplace/api/shop/:id - где :id это идентификатор точки продаж
  • тело запроса - объект UpdateShopRequest
  • тело ответа - объект ShopResponse
  • Возможные ошибки
Пример запроса 
PUT /v3/marketplace/api/shop/1
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
  "description": "Это наш тестовый магазин",
  "notificationEmail": "test@test.me",
  "jivositeId": "321314123123",
  "yandexMetrikaId": 432141251234,
  "deliveryInfo": "Когда хотим, тогда и доставляем",
  "registrationAddress": "Санкт-Петербург, улица Рубинштейна, дом 12",
  "lat": 59.931228,
  "lon": 30.345557,
  "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": {}
    }
  ]
}

UpdateShopRequest

СвойствоТипОписаниеПример значения
descriptionstring(2000)Описание магазинаЭто наш первый тестовый магазин
shopUrlstring(64)Ссылка на магазинhttps://1694158899.expressclient.ru
minOrderSumfloatМинимальная сумма заказа99.99
notificationEmailstring(500)Email для отправки уведомленийtest@test.me
yandexMetrikaIdint12332134222
deliveryInfostring(1000)Описание доставкиНе доставляем по выходным и праздникам
typestring(50) enumТип магазинаshop,marketplace,external,offline,brand
registrationAddressstring(200)Адрес магазинаСанкт-Петербург, улица Рубинштейна, дом 12
latfloatШирота нахождения магазина59.931228
lonfloatДолгота нахождения магазина30.345557
brandIdintИдентификатор магазина с типом brand123
merchantIdstring(36)Идентификатор магазина Инвойсбокс, работает только в связвке с полем externalUpdate01771534-1a57-f184-dee3-ebeb91dded76
accountProgramIdsarrayМассив идентификаторов программ лояльностей, которые принимает точка[01771534-1a57-f184-dee3-ebeb91dded71,01771534-1a57-f184-dee3-ebeb91dded72]

ShopResponse

Повторяет свойства объекта UpdateShopRequest:

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

7 обязательных из 47
ПолеТипОписание
title#string≤ 50 символов
description#string≤ 2000 символов
shortDescription#string≤ 2000 символов
seoTitle#string≤ 500 символов
seoKeywords#string≤ 500 символов
seoDescription#string≤ 500 символов
categoryId#integer | null
shopDeliveryId#integer | null
alias#string≤ 32 символов
shopUrl#string≤ 64 символов
minOrderSum#number
notificationEmail#string≤ 500 символов
defaultPriceId#integer | null
imageId#integer | null
ogImageId#integer | null
mode#string≤ 100 символов
jivositeId#string | null≤ 256 символов
orderFlow#string≤ 256 символов
yandexMetrikaId#integer | null
deliveryInfo#string≤ 1000 символов
accountProgramIds#ArrayMap | null
orderLifetime#integer
modelId#integer | null
manualProperties#ArrayMap
imageIds#ArrayMap
modelIds#ArrayMap
hours#AppDomainEntityHoursPaymentgatewayUpdateApiUpdate | null
address#string≤ 200 символов
lat#number
lon#number
externalId#string | null≤ 50 символов
brandId#integer | null
active#boolean
merchantCategoryId#integer | null
status#string≤ 256 символов
contactEmail#string≤ 500 символов
contactPhone#string≤ 500 символов
Страница помогла?
Нужна помощь?Написать в поддержкуТелеграм-канал
← НазадДобавление точки продажДальше →Акции и спецпредложения
putОбновление точки продажДемо
curl -X PUT 'https://api.invoicebox.ru/v3/marketplace/api/shop/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -d '{
  "description": "Оплата бронирования"
}'
Точки продаж демо-магазина общие — правка меняет их для всех читателей.
deleteУдаляет магазин продавца (мягкое удаление — магазин помечается как удалённый, запись в БД не физически стирается)Демо
curl -X DELETE 'https://api.invoicebox.ru/v3/marketplace/api/shop/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'
Точки продаж демо-магазина общие — удаление уберёт их у всех читателей.