Создание точки продаж

Метод доступен для модели DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Создает точку продаж магазина на Маркете.

⚙️ Лимит: 100 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/outlets

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

Body

application/json
{
    "name": "string",
    "type": "DEPOT",
    "coords": "string",
    "isMain": false,
    "shopOutletCode": "string",
    "visibility": "HIDDEN",
    "address": {
        "regionId": 0,
        "street": "string",
        "number": "string",
        "building": "string",
        "estate": "string",
        "block": "string",
        "additional": "string",
        "km": 0,
        "city": "string"
    },
    "phones": [
        "string"
    ],
    "workingSchedule": {
        "workInHoliday": false,
        "scheduleItems": [
            {
                "startDay": "MONDAY",
                "endDay": "MONDAY",
                "startTime": "09:59",
                "endTime": "23:59"
            }
        ]
    },
    "deliveryRules": [
        {
            "minDeliveryDays": 0,
            "maxDeliveryDays": 0,
            "deliveryServiceId": 0,
            "orderBefore": 0,
            "priceFreePickup": 0,
            "unspecifiedDeliveryInterval": false
        }
    ],
    "storagePeriod": 0
}

Name

Description

address*

Type: OutletAddressDTO

Адрес точки продаж.

name*

Type: string

Название точки продаж.

phones*

Type: string[]

Номера телефонов точки продаж. Передавайте в формате: +7 (999) 999-99-99.

Min length: 1

Min items: 1

Unique items  

type*

Type: OutletType

Тип точки продаж.

Возможные значения:

  • DEPOT — пункт выдачи заказов.
  • MIXED — смешанный тип точки продаж (торговый зал и пункт выдачи заказов).
  • RETAIL — розничная точка продаж (торговый зал).
  • NOT_DEFINED — неизвестный тип точки продажи. При определении типа произошла ошибка.

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

workingSchedule*

Type: OutletWorkingScheduleDTO

Список режимов работы точки продаж.

coords

Type: string

Координаты точки продаж.

Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.

Если параметр не передан, координаты будут определены по значениям параметров, вложенных в address.

deliveryRules

Type: OutletDeliveryRuleDTO[]

Информация об условиях доставки для данной точки продаж.

Обязательный параметр, если параметр type=DEPOT или type=MIXED.
Информация об условиях доставки для данной точки продаж.

Min items: 1

isMain

Type: boolean

Признак основной точки продаж.

Возможные значения:

  • false — неосновная точка продаж.
  • true — основная точка продаж.

shopOutletCode

Type: string

Идентификатор точки продаж, присвоенный магазином.

storagePeriod

Type: integer<int64>

Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях.

visibility

Type: OutletVisibilityType

Состояние точки продаж.

Возможные значения:

  • HIDDEN — точка продаж выключена.
  • VISIBLE — точка продаж включена.
  • UNKNOWN — неизвестное состояние точки продажи. При определении состояния произошла ошибка.

Enum: HIDDEN, VISIBLE, UNKNOWN

OutletAddressDTO

Адрес точки продаж.

Name

Description

regionId*

Type: integer<int64>

Идентификатор региона.

Идентификатор можно получить c помощью запроса GET v2/regions.

Типы регионов при создании и редактировании точек продаж

Указывайте только регионы типов TOWN (город), CITY (крупный город) и REPUBLIC_AREA (район субъекта федерации). Тип региона указан в выходных параметрах type запросов GET v2/regions и GET v2/regions/{regionId}.

additional

Type: string

Дополнительная информация.

block

Type: string

Номер корпуса.

Max length: 16

building

Type: string

Номер строения.

Max length: 16

city

⦸

Type: string

В ответах города и населенные пункты возвращаются в параметре regionId.

Max length: 200

estate

Type: string

Номер владения.

Max length: 16

km

Type: integer<int32>

Порядковый номер километра дороги, на котором располагается точка продаж, если отсутствует улица.

number

Type: string

Номер дома.

Max length: 256

street

Type: string

Улица.

Max length: 512

OutletType

Тип точки продаж.

Возможные значения:

  • DEPOT — пункт выдачи заказов.
  • MIXED — смешанный тип точки продаж (торговый зал и пункт выдачи заказов).
  • RETAIL — розничная точка продаж (торговый зал).
  • NOT_DEFINED — неизвестный тип точки продажи. При определении типа произошла ошибка.

Type

Description

OutletType

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

OutletWorkingScheduleDTO

Список режимов работы точки продаж.

Name

Description

scheduleItems*

Type: OutletWorkingScheduleItemDTO[]

Список расписаний работы точки продаж.
Расписание работы точки продаж.

Min items: 1

workInHoliday

Type: boolean

Признак, работает ли точка продаж в дни государственных праздников.

Возможные значения:

  • false — точка продаж не работает в дни государственных праздников.
  • true — точка продаж работает в дни государственных праздников.

OutletDeliveryRuleDTO

Информация об условиях доставки для данной точки продаж.

Name

Description

deliveryServiceId

Type: integer<int64>

Идентификатор службы доставки товаров в точку продаж.

Информацию о службе доставки можно получить с помощью запроса GET delivery/services.

maxDeliveryDays

Type: integer<int32>

Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях.

Минимальное значение: 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.

Min value: 0

Max value: 60

minDeliveryDays

Type: integer<int32>

Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях.

Минимальное значение: 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.

Min value: 0

Max value: 60

orderBefore

Type: integer<int32>

Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от minDeliveryDays до maxDeliveryDays.

Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от minDeliveryDays + 1 рабочий день до maxDeliveryDays + 1 рабочий день.

Значение по умолчанию: 24.

Min value: 0

Max value: 24

priceFreePickup

Type: number

Цена товара, начиная с которой действует бесплатный самовывоз товара из точки продаж.

unspecifiedDeliveryInterval

Type: boolean

Признак доставки товаров в точку продаж на заказ.

Признак выставлен, если:

  • точный срок доставки в точку продаж заранее неизвестен (например, если магазин собирает несколько заказов для отправки в точку или населенный пункт);
  • все товары изготавливаются или поставляются на заказ.

Возможные значения:

  • true — товары доставляются в точку продаж на заказ.

Параметр указывается только со значением true.

Взаимоисключающий с параметрами minDeliveryDays и maxDeliveryDays.

OutletVisibilityType

Состояние точки продаж.

Возможные значения:

  • HIDDEN — точка продаж выключена.
  • VISIBLE — точка продаж включена.
  • UNKNOWN — неизвестное состояние точки продажи. При определении состояния произошла ошибка.

Type

Description

OutletVisibilityType

Enum: HIDDEN, VISIBLE, UNKNOWN

OutletWorkingScheduleItemDTO

Расписание работы точки продаж.

Name

Description

endDay*

Type: DayOfWeekType

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

endTime*

Type: string

Точка продаж работает до указанного часа.

Формат: ЧЧ:ММ.

Example: 23:59

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

startDay*

Type: DayOfWeekType

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

startTime*

Type: string

Точка продаж работает c указанного часа.

Формат: ЧЧ:ММ.

Example: 09:59

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

DayOfWeekType

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Type

Description

DayOfWeekType

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Responses

200 OK

Информация о созданной точке продаж.

Body

application/json
{
    "status": "OK",
    "result": {
        "id": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

result

Type: OutletResponseDTO

Результат выполнения запроса. Выводится, если status="OK".

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

OutletResponseDTO

Результат выполнения запроса. Выводится, если status="OK".

Name

Description

id

Type: integer<int64>

Идентификатор точки продаж, присвоенный Маркетом.

400 Bad Request

Описание Пояснение Способы решения
datediff-is-to-big-local При доставке по своему региону разница между максимальным и минимальным сроком доставки не должна превышать двух дней. Убедитесь, что разница между maxDeliveryDays и minDeliveryDays не превышает двух дней.
datediff-is-to-big-remote При доставке в другие регионы разница между максимальным и минимальным сроком доставки не должна превышать четырех дней. Убедитесь, что разница между maxDeliveryDays и minDeliveryDays не превышает четырех дней.
datediff-is-to-big-long-period При доставке в другие регионы, где минимальный срок доставки больше 18 дней, разница между максимальным и минимальным сроком доставки не должна превышать минимальный срок. Убедитесь, что разница между maxDeliveryDays и minDeliveryDays не превышает minDeliveryDays.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

Предыдущая
Несколько точек продаж
Следующая
Изменение