Изменение информации о точке продаж
Метод доступен для модели DBS.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- settings-management — Настройка магазинов
- all-methods — Полное управление кабинетом
Изменяет информацию о точке продаж магазина на Маркете.
| ⚙️ Лимит: 100 000 запросов в час |
|---|
Request
PUT
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/outlets/{outletId}
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: |
|
outletId |
Type: integer Идентификатор точки продаж. Min value: |
Body
application/json
{
"name": "example",
"type": "DEPOT",
"coords": "example",
"isMain": true,
"shopOutletCode": "example",
"visibility": "HIDDEN",
"address": {
"regionId": 0,
"street": "example",
"number": "example",
"building": "example",
"estate": "example",
"block": "example",
"additional": "example",
"km": 0,
"city": "example"
},
"phones": [
"example"
],
"workingSchedule": {
"workInHoliday": true,
"scheduleItems": [
{
"startDay": "MONDAY",
"endDay": null,
"startTime": "09:59",
"endTime": "23:59"
}
]
},
"deliveryRules": [
{
"minDeliveryDays": 0,
"maxDeliveryDays": 0,
"deliveryServiceId": 0,
"orderBefore": 0,
"priceFreePickup": 0.5,
"unspecifiedDeliveryInterval": true
}
],
"storagePeriod": 0
}
Type: OutletDTO
OutletType
Тип точки продаж.
Возможные значения:
DEPOT— пункт выдачи заказов.MIXED— смешанный тип точки продаж (торговый зал и пункт выдачи заказов).RETAIL— розничная точка продаж (торговый зал).NOT_DEFINED— неизвестный тип точки продажи. При определении типа произошла ошибка.
Type: string
Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED
OutletVisibilityType
Состояние точки продаж.
Возможные значения:
HIDDEN— точка продаж выключена.VISIBLE— точка продаж включена.UNKNOWN— неизвестное состояние точки продажи. При определении состояния произошла ошибка.
Type: string
Enum: HIDDEN, VISIBLE, UNKNOWN
OutletAddressDTO
Адрес точки продаж.
|
Name |
Description |
|
regionId |
Type: integer Идентификатор региона. Идентификатор можно получить c помощью запроса GET v2/regions. Типы регионов при создании и редактировании точек продаж Указывайте только регионы типов |
|
additional |
Type: string Дополнительная информация. Example: |
|
block |
Type: string Номер корпуса. Max length: Example: |
|
building |
Type: string Номер строения. Max length: Example: |
|
city |
Type: string В ответах города и населенные пункты возвращаются в параметре Max length: Example: |
|
estate |
Type: string Номер владения. Max length: Example: |
|
km |
Type: integer Порядковый номер километра дороги, на котором располагается точка продаж, если отсутствует улица. |
|
number |
Type: string Номер дома. Max length: Example: |
|
street |
Type: string Улица. Max length: Example: |
Example
{
"regionId": 0,
"street": "example",
"number": "example",
"building": "example",
"estate": "example",
"block": "example",
"additional": "example",
"km": 0,
"city": "example"
}
DayOfWeekType
День недели:
MONDAY— понедельник.TUESDAY— вторник.WEDNESDAY— среда.THURSDAY— четверг.FRIDAY— пятница.SATURDAY— суббота.SUNDAY— воскресенье.
Type: string
Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
OutletWorkingScheduleItemDTO
Расписание работы точки продаж.
|
Name |
Description |
|
endDay |
Type: DayOfWeekType Точка продаж работает до указанного дня недели. Возможные значения:
День недели:
Enum: |
|
endTime |
Type: string Точка продаж работает до указанного часа. Формат: Pattern: Example: |
|
startDay |
Type: DayOfWeekType Точка продаж работает с указанного дня недели. Возможные значения:
День недели:
Enum: |
|
startTime |
Type: string Точка продаж работает c указанного часа. Формат: Pattern: Example: |
Example
{
"startDay": "MONDAY",
"endDay": null,
"startTime": "09:59",
"endTime": "23:59"
}
OutletWorkingScheduleDTO
Список режимов работы точки продаж.
|
Name |
Description |
|
scheduleItems |
Type: OutletWorkingScheduleItemDTO[] Список расписаний работы точки продаж. Min items: Example
|
|
workInHoliday |
Type: boolean Признак, работает ли точка продаж в дни государственных праздников. Возможные значения:
|
Example
{
"workInHoliday": true,
"scheduleItems": [
{
"startDay": "MONDAY",
"endDay": null,
"startTime": "09:59",
"endTime": "23:59"
}
]
}
OutletDeliveryRuleDTO
Информация об условиях доставки для данной точки продаж.
|
Name |
Description |
|
deliveryServiceId |
Type: integer Идентификатор службы доставки товаров в точку продаж. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
|
maxDeliveryDays |
Type: integer Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях. Минимальное значение: Максимальное значение: Допустимые сроки доставки (разница между Для доставки по своему региону разница не должна превышать двух дней. Например, если Для доставки в другие регионы:
Обязательный параметр, если Взаимоисключающий с параметром Min value: Max value: |
|
minDeliveryDays |
Type: integer Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях. Минимальное значение: Максимальное значение: Допустимые сроки доставки (разница между Для доставки по своему региону разница не должна превышать двух дней. Например, если Для доставки в другие регионы:
Обязательный параметр, если Взаимоисключающий с параметром Min value: Max value: |
|
orderBefore |
Type: integer Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от Значение по умолчанию: Min value: Max value: |
|
priceFreePickup |
Type: number Цена товара, начиная с которой действует бесплатный самовывоз товара из точки продаж. |
|
unspecifiedDeliveryInterval |
Type: boolean Признак доставки товаров в точку продаж на заказ. Признак выставлен, если:
Возможные значения:
Параметр указывается только со значением Взаимоисключающий с параметрами |
Example
{
"minDeliveryDays": 0,
"maxDeliveryDays": 0,
"deliveryServiceId": 0,
"orderBefore": 0,
"priceFreePickup": 0.5,
"unspecifiedDeliveryInterval": true
}
OutletDTO
Информация о точке продаж.
|
Name |
Description |
|
address |
Type: OutletAddressDTO Адрес точки продаж. Example
|
|
name |
Type: string Название точки продаж. Example: |
|
phones |
Type: string[] Номера телефонов точки продаж.
Передавайте номер в формате: Примеры:
Min items: Unique items: Example
|
|
type |
Type: OutletType Тип точки продаж. Возможные значения:
Enum: |
|
workingSchedule |
Type: OutletWorkingScheduleDTO Список режимов работы точки продаж. Example
|
|
coords |
Type: string Координаты точки продаж. Формат: долгота, широта. Разделители: запятая и / или пробел. Например, Если параметр не передан, координаты будут определены по значениям параметров, вложенных в Example: |
|
deliveryRules |
Type: OutletDeliveryRuleDTO[] | null Информация об условиях доставки для данной точки продаж. Обязательный параметр, если параметр Min items: Example
|
|
isMain |
Type: boolean Признак основной точки продаж. Возможные значения:
|
|
shopOutletCode |
Type: string Идентификатор точки продаж, присвоенный магазином. Example: |
|
storagePeriod |
Type: integer Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. |
|
visibility |
Type: OutletVisibilityType Состояние точки продаж. Возможные значения:
Enum: |
Example
{
"name": "example",
"type": "DEPOT",
"coords": "example",
"isMain": true,
"shopOutletCode": "example",
"visibility": "HIDDEN",
"address": {
"regionId": 0,
"street": "example",
"number": "example",
"building": "example",
"estate": "example",
"block": "example",
"additional": "example",
"km": 0,
"city": "example"
},
"phones": [
"example"
],
"workingSchedule": {
"workInHoliday": true,
"scheduleItems": [
{
"startDay": "MONDAY",
"endDay": null,
"startTime": "09:59",
"endTime": "23:59"
}
]
},
"deliveryRules": [
{
"minDeliveryDays": 0,
"maxDeliveryDays": 0,
"deliveryServiceId": 0,
"orderBefore": 0,
"priceFreePickup": 0.5,
"unspecifiedDeliveryInterval": true
}
],
"storagePeriod": 0
}
Responses
200 OK
Пустой ответ.
Body
application/json
{
"status": "OK"
}
Type: object
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибках при работе с точками продаж
Body
application/json
{
"status": "OK"
}
Type: object
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. Example: |
Example
{
"code": "example",
"message": "example"
}
ApiErrorResponse
Стандартная обертка для ошибок сервера.
Type: object
All of 2 types
-
Type: ApiResponse
Стандартная обертка для ответов сервера.
Example
{ "status": "OK" } -
Type: object
errors
Type: ApiErrorDTO[] | null
Список ошибок.
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK"
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
pathParams:
- description: "Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.\n\nЕго можно узнать с помощью запроса [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → **Настройки** и в меню слева выберите **API и модули**:\n\n* блок **Идентификатор кампании**;\n* вкладка **Лог запросов** → выпадающий список в блоке **Показывать логи**.\n\n⚠️ Не путайте его с:\n- идентификатором магазина, который отображается в личном кабинете продавца;\n- рекламными кампаниями.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
- description: Идентификатор точки продаж.
name: outletId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams: []
headers: []
body: |-
{
"name": "example",
"type": "DEPOT",
"coords": "example",
"isMain": true,
"shopOutletCode": "example",
"visibility": "HIDDEN",
"address": {
"regionId": 0,
"street": "example",
"number": "example",
"building": "example",
"estate": "example",
"block": "example",
"additional": "example",
"km": 0,
"city": "example"
},
"phones": [
"example"
],
"workingSchedule": {
"workInHoliday": true,
"scheduleItems": [
{
"startDay": "MONDAY",
"endDay": null,
"startTime": "09:59",
"endTime": "23:59"
}
]
},
"deliveryRules": [
{
"minDeliveryDays": 0,
"maxDeliveryDays": 0,
"deliveryServiceId": 0,
"orderBefore": 0,
"priceFreePickup": 0.5,
"unspecifiedDeliveryInterval": true
}
],
"storagePeriod": 0
}
schema:
type: object
allOf:
- description: Информация о точке продаж.
type: object
required:
- name
- type
- address
- phones
- workingSchedule
properties:
name:
description: |
Название точки продаж.
type: string
type:
description: >
Тип точки продаж.
Возможные значения:
* `DEPOT` — пункт выдачи заказов.
* `MIXED` — смешанный тип точки продаж (торговый зал и пункт выдачи
заказов).
* `RETAIL` — розничная точка продаж (торговый зал).
* `NOT_DEFINED` — неизвестный тип точки продажи. При определении
типа произошла ошибка.
type: string
enum:
- DEPOT
- MIXED
- RETAIL
- NOT_DEFINED
coords:
description: >
Координаты точки продаж.
Формат: долгота, широта. Разделители: запятая и / или пробел.
Например, `20.4522144, 54.7104264`.
Если параметр не передан, координаты будут определены по значениям
параметров, вложенных в `address`.
type: string
isMain:
description: |
Признак основной точки продаж.
Возможные значения:
* `false` — неосновная точка продаж.
* `true` — основная точка продаж.
type: boolean
shopOutletCode:
description: Идентификатор точки продаж, присвоенный магазином.
type: string
visibility:
description: >
Состояние точки продаж.
Возможные значения:
* `HIDDEN` — точка продаж выключена.
* `VISIBLE` — точка продаж включена.
* `UNKNOWN` — неизвестное состояние точки продажи. При определении
состояния произошла ошибка.
type: string
enum:
- HIDDEN
- VISIBLE
- UNKNOWN
address:
description: |
Адрес точки продаж.
type: object
required:
- regionId
properties:
regionId:
description: "Идентификатор региона.\n\nИдентификатор можно получить c помощью запроса [GET\_v2/regions](../../reference/regions/searchRegionsByName.md).\n\n{% note alert \"Типы регионов при создании и редактировании точек продаж\" %}\n\nУказывайте только регионы типов `TOWN` (город), `CITY` (крупный город) и `REPUBLIC_AREA` (район субъекта федерации). Тип региона указан в выходных параметрах `type` запросов [GET\_v2/regions](../../reference/regions/searchRegionsByName.md) и [GET\_v2/regions/{regionId}](../../reference/regions/searchRegionsById.md).\n\n{% endnote %}\n"
type: integer
format: int64
street:
description: Улица.
type: string
maxLength: 512
number:
description: Номер дома.
type: string
maxLength: 256
building:
description: Номер строения.
type: string
maxLength: 16
estate:
description: Номер владения.
type: string
maxLength: 16
block:
description: Номер корпуса.
type: string
maxLength: 16
additional:
description: Дополнительная информация.
type: string
km:
description: >-
Порядковый номер километра дороги, на котором располагается
точка продаж, если отсутствует улица.
type: integer
format: int32
city:
description: "{% note warning \"В ответах города и населенные пункты возвращаются в параметре `regionId`.\" %}\n\n\_\n\n{% endnote %}\n"
maxLength: 200
type: string
deprecated: true
phones:
description: >
Номера телефонов точки продаж.
Передавайте номер в формате: `+<код страны>(<код
города>)<номер>[#<добавочный>]`.
Примеры:
- `+7 (999) 999-99-99`
- `+7 (999) 999-99-99#1234`
type: array
minItems: 1
uniqueItems: true
items:
type: string
minLength: 1
workingSchedule:
description: |
Список режимов работы точки продаж.
type: object
required:
- scheduleItems
properties:
workInHoliday:
description: >
Признак, работает ли точка продаж в дни государственных
праздников.
Возможные значения:
* `false` — точка продаж не работает в дни государственных
праздников.
* `true` — точка продаж работает в дни государственных
праздников.
type: boolean
scheduleItems:
description: |
Список расписаний работы точки продаж.
type: array
minItems: 1
items:
description: Расписание работы точки продаж.
type: object
required:
- startDay
- endDay
- startTime
- endTime
properties:
startDay:
description: |
Точка продаж работает с указанного дня недели.
Возможные значения:
* `MONDAY` — понедельник.
* `TUESDAY` — вторник.
* `WEDNESDAY` — среда.
* `THURSDAY` — четверг.
* `FRIDAY` — пятница.
* `SATURDAY` — суббота.
* `SUNDAY` — воскресенье.
$ref: '#/$defs/DayOfWeekType'
endDay:
description: |
Точка продаж работает до указанного дня недели.
Возможные значения:
* `MONDAY` — понедельник.
* `TUESDAY` — вторник.
* `WEDNESDAY` — среда.
* `THURSDAY` — четверг.
* `FRIDAY` — пятница.
* `SATURDAY` — суббота.
* `SUNDAY` — воскресенье.
$ref: '#/$defs/DayOfWeekType'
startTime:
description: |
Точка продаж работает c указанного часа.
Формат: `ЧЧ:ММ`.
type: string
pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$
example: '09:59'
endTime:
description: |
Точка продаж работает до указанного часа.
Формат: `ЧЧ:ММ`.
type: string
pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$
example: '23:59'
deliveryRules:
description: |
Информация об условиях доставки для данной точки продаж.
Обязательный параметр, если параметр `type=DEPOT` или `type=MIXED`.
type: array
nullable: true
minItems: 1
items:
description: Информация об условиях доставки для данной точки продаж.
type: object
properties:
minDeliveryDays:
description: >
Минимальный срок доставки товаров в точку продаж. Указан в
рабочих днях.
Минимальное значение: `0` — доставка в день заказа.
Максимальное значение: `60`.
Допустимые сроки доставки (разница между `minDeliveryDays` и
`maxDeliveryDays`) зависят от региона.
Для доставки по своему региону разница не должна превышать
двух дней. Например, если `minDeliveryDays` равно 1, то для
`maxDeliveryDays` допускаются значения от 1 до 3.
Для доставки в другие регионы:
* Если `minDeliveryDays` до 18 дней, разница не должна
превышать четырех дней. Например, если `minDeliveryDays` равно
10, то для `maxDeliveryDays` допускаются значения от 10 до 14.
* Если `minDeliveryDays` больше 18 дней, разница должна быть
не больше чем в два раза. Например, если `minDeliveryDays`
равно 21, то для `maxDeliveryDays` допускаются значения от 21
до 42.
Обязательный параметр, если `type="DEPOT"` или `type="MIXED"`.
Взаимоисключающий с параметром `unspecifiedDeliveryInterval`.
type: integer
format: int32
minimum: 0
maximum: 60
maxDeliveryDays:
description: >
Максимальный срок доставки товаров в точку продаж. Указан в
рабочих днях.
Минимальное значение: `0` — доставка в день заказа.
Максимальное значение: `60`.
Допустимые сроки доставки (разница между `minDeliveryDays` и
`maxDeliveryDays`) зависят от региона.
Для доставки по своему региону разница не должна превышать
двух дней. Например, если `minDeliveryDays` равно 1, то для
`maxDeliveryDays` допускаются значения от 1 до 3.
Для доставки в другие регионы:
* Если `minDeliveryDays` до 18 дней, разница не должна
превышать четырех дней. Например, если `minDeliveryDays` равно
10, то для `maxDeliveryDays` допускаются значения от 10 до 14.
* Если `minDeliveryDays` больше 18 дней, разница должна быть
не больше чем в два раза. Например, если `minDeliveryDays`
равно 21, то для `maxDeliveryDays` допускаются значения от 21
до 42.
Обязательный параметр, если `type="DEPOT"` или `type="MIXED"`.
Взаимоисключающий с параметром `unspecifiedDeliveryInterval`.
type: integer
format: int32
minimum: 0
maximum: 60
deliveryServiceId:
description: "Идентификатор службы доставки товаров в точку продаж.\n\nИнформацию о службе доставки можно получить с помощью запроса [GET\_delivery/services](../../reference/orders/getDeliveryServices.md).\n"
type: integer
format: int64
orderBefore:
description: >
Час, до которого покупателю нужно сделать заказ, чтобы он был
доставлен в точку продаж в сроки от `minDeliveryDays` до
`maxDeliveryDays`.
Если покупатель оформит заказ после указанного часа, он будет
доставлен в сроки от `minDeliveryDays` + 1 рабочий день до
`maxDeliveryDays` + 1 рабочий день.
Значение по умолчанию: `24`.
type: integer
format: int32
minimum: 0
maximum: 24
priceFreePickup:
description: >-
Цена товара, начиная с которой действует бесплатный самовывоз
товара из точки продаж.
type: number
unspecifiedDeliveryInterval:
description: >
Признак доставки товаров в точку продаж на заказ.
Признак выставлен, если:
* точный срок доставки в точку продаж заранее неизвестен
(например, если магазин собирает несколько заказов для
отправки в точку или населенный пункт);
* все товары изготавливаются или поставляются на заказ.
Возможные значения:
* `true` — товары доставляются в точку продаж на заказ.
Параметр указывается только со значением `true`.
Взаимоисключающий с параметрами `minDeliveryDays` и
`maxDeliveryDays`.
type: boolean
storagePeriod:
description: >-
Срок хранения заказа в собственном пункте выдачи заказов. Считается
в днях.
type: integer
format: int64
$defs:
/home/sandbox/.ya/build/build_root/4217/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/common/schemas.yaml#/DayOfWeekType:
description: |
День недели:
* `MONDAY` — понедельник.
* `TUESDAY` — вторник.
* `WEDNESDAY` — среда.
* `THURSDAY` — четверг.
* `FRIDAY` — пятница.
* `SATURDAY` — суббота.
* `SUNDAY` — воскресенье.
type: string
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
bodyType: application/json
method: put
security:
- type: apiKey
name: Api-Key
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/outlets/{outletId}
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.