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

Описание

POST /campaigns/{campaignId}/outlets

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

URL ресурса:

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

Входные данные

Параметр

Тип

Значение

Обязательные

campaignId

Int64

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

Структура тела POST-запроса:

<outlet name="{string}" type="{enum}" coords="{string}" is-main="{boolean}" shop-outlet-code="{string}" visibility="{enum}" is-book-now="{boolean}">
  <address region-id="{int64}" street="{string}" number="{string}" building="{string}" estate="{string}" block="{string}" additional="{string}" km="{integer}"/>
  <phones>
    <phone>{string}</phone>
    ...
  </phones>
  <working-schedule work-in-holiday="{boolean}">
    <schedule-items>
      <schedule-item start-day="{enum}" end-day="{enum}" start-time="{string}" end-time="{string}"/>
      ...
    </schedule-items>
  </working-schedule>
  <delivery-rules>
    <delivery-rule cost="{double}" min-delivery-days="{int32}" max-delivery-days="{int32}" delivery-service-id="{int64}" order-before="{int32}" price-free-pickup="{double}" unspecified-delivery-interval="{boolean}"/>
  </delivery-rules>
  <emails>
    <email>{string}</email>
  </emails>
</outlet>

Параметры тела POST-запроса:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

outlet

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

Обязательный параметр, указывается только для формата XML.

Параметры, вложенные в outlet

namenameString

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

Обязательный параметр.

Для формата XML является атрибутом параметра outlet.

typetypeEnum

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

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

  • DEPOT — пункт выдачи заказов.

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

  • RETAIL — розничная точка продаж (торговый зал).

Обязательный параметр.

Для формата XML является атрибутом параметра outlet.

coordscoordsString

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

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

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

Для формата XML является атрибутом параметра outlet.

is-mainisMainBoolean

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

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

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

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

Для формата XML является атрибутом параметра outlet.

shop-outlet-codeshopOutletCodeString

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

Для формата XML является атрибутом параметра outlet.

visibilityvisibilityEnum

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

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

  • HIDDEN — точка продаж выключена.

  • VISIBLE — точка продаж включена.

Для формата XML является атрибутом параметра outlet.

is-book-nowisBookNowBoolean
Внимание. Параметр устарел и не рекомендуется к использованию.
addressaddress

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

Обязательный параметр.

phonesphones

Номера телефонов точки продаж.

Обязательный параметр.

working-scheduleworkingSchedule

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

Обязательный параметр.

delivery-rulesdeliveryRules

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

Обязательный параметр, если параметр type=DEPOT или type=MIXED.

emailsemails

Адрес электронной почты точки продаж.

Может содержать только один параметр email.

Параметры, вложенные в address

region-idregionIdInt64

Идентификатор города или населенного пункта.

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

Обязательный параметр.

Для формата XML является атрибутом параметра address.

streetstreetString

Улица.

Для формата XML является атрибутом параметра address.

numbernumberString

Номер дома.

Для формата XML является атрибутом параметра address.

buildingbuildingString

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

Для формата XML является атрибутом параметра address.

estateestateString

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

Для формата XML является атрибутом параметра address.

blockblockString

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

Для формата XML является атрибутом параметра address.

additionaladditionalString

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

Для формата XML является атрибутом параметра address.

kmkmInteger

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

Для формата XML является атрибутом параметра address.

Параметры, вложенные в phones

phoneString

Номер телефона точки продаж.

Формат: + код страны (код города) телефон #добавочный. Например, +7 (495) 012-34-56 #789.

Обязательный параметр.

Для формата JSON выводится в виде строки.

Параметры, вложенные в working-schedule / workingSchedule

work-in-holidayworkInHolidayBoolean

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

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

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

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

Для формата XML является атрибутом параметра working-schedule.

schedule-itemsscheduleItems

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

Обязательный параметр.

Параметры, вложенные в schedule-items

schedule-item

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

Обязательный параметр, указывается только для формата XML.

Параметры, вложенные в schedule-item / scheduleItems

start-daystartDayEnum

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

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

  • MONDAY — понедельник.

  • TUESDAY — вторник.

  • WEDNESDAY — среда.

  • THURSDAY — четверг.

  • FRIDAY — пятница.

  • SATURDAY — суббота.

  • SUNDAY — воскресенье.

Обязательный параметр.

Для формата XML является атрибутом параметра schedule-item.

end-dayendDayEnum

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

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

  • MONDAY — понедельник.

  • TUESDAY — вторник.

  • WEDNESDAY — среда.

  • THURSDAY — четверг.

  • FRIDAY — пятница.

  • SATURDAY — суббота.

  • SUNDAY — воскресенье.

Обязательный параметр.

Для формата XML является атрибутом параметра schedule-item.

start-timestartTimeString

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

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

Обязательный параметр.

Для формата XML является атрибутом параметра schedule-item.

end-timeendTimeString

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

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

Обязательный параметр.

Для формата XML является атрибутом параметра schedule-item.

Параметры, вложенные в delivery-rules

delivery-rule

Условие доставки для данной точки продаж.

Обязательный параметр, если параметр type=DEPOT или type=MIXED. Указывается только для формата XML.

Параметры, вложенные в delivery-rule / deliveryRules

costcostDouble

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

Обязательный параметр.

Для формата XML является атрибутом параметра delivery-rule.

min-delivery-daysminDeliveryDaysInt32

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

Минимальное значение: 0 — доставка в день заказа.

Максимальное значение: 60.

Допустимые сроки доставки (разница между min-delivery-days и max-delivery-days) зависят от региона.

Для доставки по своему региону разница не должна превышать двух дней. Например, если min-delivery-days равно 1, то для max-delivery-days допускаются значения от 1 до 3.

Для доставки в другие регионы:

  • если min-delivery-days до 18 дней, разница не должна превышать четырех дней. Например, если min-delivery-days равно 10, то для max-delivery-days допускаются значения от 10 до 14;
  • если min-delivery-days больше 18 дней, разница должна быть не больше чем в два раза. Например, если min-delivery-days равно 21, то для max-delivery-days допускаются значения от 21 до 42.

Обязательный параметр, если type="DEPOT" или type="MIXED".

Взаимоисключающий с параметром unspecified-delivery-interval.

Для формата XML является атрибутом параметра delivery-rule.

max-delivery-daysmaxDeliveryDaysInt32

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

Минимальное значение: 0 — доставка в день заказа.

Максимальное значение: 60.

Допустимые сроки доставки (разница между min-delivery-days и max-delivery-days) зависят от региона.

Для доставки по своему региону разница не должна превышать двух дней. Например, если min-delivery-days равно 1, то для max-delivery-days допускаются значения от 1 до 3.

Для доставки в другие регионы:

  • если min-delivery-days до 18 дней, разница не должна превышать четырех дней. Например, если min-delivery-days равно 10, то для max-delivery-days допускаются значения от 10 до 14;
  • если min-delivery-days больше 18 дней, разница должна быть не больше чем в два раза. Например, если min-delivery-days равно 21, то для max-delivery-days допускаются значения от 21 до 42.

Обязательный параметр, если type="DEPOT" или type="MIXED".

Взаимоисключающий с параметром unspecified-delivery-interval.

Для формата XML является атрибутом параметра delivery-rule.

delivery-service-iddeliveryServiceIdInt64

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

Для формата XML является атрибутом параметра delivery-rule.

order-beforeorderBeforeInt32

Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от min-delivery-days до max-delivery-days.

Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от min-delivery-days + 1 рабочий день до max-delivery-days + 1 рабочий день.

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

Для формата XML является атрибутом параметра delivery-rule.

price-free-pickuppriceFreePickupDouble

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

Для формата XML является атрибутом параметра delivery-rule.

unspecified-delivery-intervalunspecifiedDeliveryIntervalBoolean

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

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

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

  • все товары изготавливаются или поставляются на заказ.

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

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

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

Взаимоисключающий с параметрами min-delivery-days и max-delivery-days.

Для формата XML является атрибутом параметра delivery-rule.

Параметры, вложенные в emails

emailString

Адрес электронной почты точки продаж.

Допускается любой адрес электронной почты, соответствующий стандарту RFC 2822.

Для формата JSON выводится в виде строки.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <errors>
    <error code="{enum}" message="{string}"/>
    ...
  </errors>
  <result>
    <id>{int64}</id>
  </result>
  <status>{enum}</status>
</response>

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

errorserrors

Список ошибок при выполнении запроса.

Выводится, если status="ERROR".

resultresult

Результат выполнения запроса.

Выводится, если status="OK".

statusstatusEnum

Статус выполнения запроса.

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

  • OK — запрос выполнен успешно.

  • ERROR — произошла ошибка.

Параметры, вложенные в errors

error

Информация об ошибке.

Параметр выводится только для формата XML.

Параметры, вложенные в error / errors

codecodeEnum

Код ошибки.

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

  • BAD_REQUEST — не удалось выполнить запрос.

  • COULD_NOT_FIND_COORDS — по значениям, переданным в теле запроса в параметре address, не удалось определить координаты точки.

  • DUPLICATE_OUTLET_CODE — в теле запроса в параметре shop-outlet-code передан идентификатор, который присвоен другой точке магазина.

  • INVALID_EMAIL_FORMAT — в теле запроса в параметре email передан адрес электронной почты, который не соответствует указанному формату.

  • INVALID_OUTLET_INFO — в теле запроса переданы некорректные данные, например, значение параметра min-delivery-days больше, чем значение max-delivery-days.

  • INVALID_PHONE_FORMAT — в теле запроса в параметре phone передан телефон, который не соответствует указанному формату.

  • NOT_SPECIFIED — в теле запроса не указан обязательный параметр.

  • UNKNOWN_REGION — в теле запроса в параметре region-id указано некорректное значение.

  • WRONG_OUTLET_GPS_COORDINATES — в теле запроса в параметре coords передано значение, которое не соответствует указанному формату.

Для формата XML является атрибутом параметра error.

messagemessageString

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

Для формата XML является атрибутом параметра error.

Параметры, вложенные в result

ididInt64

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

Для формата XML является атрибутом параметра outlet.

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

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ограничения

Для методов DELETE /campaigns/{campaignId}/outlets/{outletId}, GET /campaigns/{campaignId}/outlets, GET /campaigns/{campaignId}/outlets/{outletId}, POST /campaigns/{campaignId}/outlets и PUT /campaigns/{campaignId}/outlets/{outletId} действует групповое ресурсное ограничение.

Ограничение вводится на суммарное количество точек продаж, информация по которым получена или передана при помощи этих методов. Объем запросов к ресурсу, который возможно выполнить в течение суток, рассчитывается индивидуально и зависит от следующих показателей:

  • количество точек продаж магазина.

Примеры

Запрос:

curl -i -H 'Content-Type: application/xml'-X POST 'https://api.partner.market.yandex.ru/v2/campaigns/12345/outlets.xml'

Тело POST-запроса:

-d '<outlet name="На Озёрной" type="DEPOT" coords="20.4522144, 54.7104264" is-main="false" shop-outlet-code="419" visibility="VISIBLE">
  <address region-id="22" street="ОЗЕРНАЯ" number="20А"/>
  <phones>
    <phone>+7 (401) 212-22-32 #123</phone>
  </phones>
  <working-schedule work-in-holiday="false">
    <schedule-items>
      <schedule-item start-day="MONDAY" end-day="FRIDAY" start-time="09:00" end-time="19:00"/>
      <schedule-item start-day="SATURDAY" end-day="SATURDAY" start-time="10:00" end-time="16:00"/>
    </schedule-items>
  </working-schedule>
  <delivery-rules>
    <delivery-rule cost="285" min-delivery-days="19" max-delivery-days="30" delivery-service-id="100" order-before="24" price-free-pickup="120"/>
  </delivery-rules>
  <emails>
    <email>example-shop@yandex.ru</email>
  </emails>
</outlet>'

Ответ:

HTTP/1.1 200 OK
Date: Thu, 10 Aug 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <result>
    <id>171819</id>
  </result>
  <status>OK</status>
</response>