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

Описание

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 min-delivery-days="{int32}" cost="{double}" delivery-service-id="{int64}" max-delivery-days="{int32}" 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

name name String

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

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

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

type type Enum

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

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

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

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

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

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

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

coords coords String

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

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

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

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

is-main isMain Boolean

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

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

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

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

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

shop-outlet-code shopOutletCode String

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

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

visibility visibility Enum

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

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

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

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

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

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

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

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

phones phones

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

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

working-schedule workingSchedule

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

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

delivery-rules deliveryRules

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

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

emails emails

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

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

region-id regionId Int64

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

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

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

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

street street String

Улица.

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

number number String

Номер дома.

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

building building String

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

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

estate estate String

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

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

block block String

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

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

additional additional String

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

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

km km Integer

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

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

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

phone String

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

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

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

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

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

work-in-holiday workInHoliday Boolean

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

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

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

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

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

schedule-items scheduleItems

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

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

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

schedule-item

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

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

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

start-day startDay Enum

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

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

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

  • TUESDAY — вторник.

  • WEDNESDAY — среда.

  • THURSDAY — четверг.

  • FRIDAY — пятница.

  • SATURDAY — суббота.

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

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

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

end-day endDay Enum

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

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

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

  • TUESDAY — вторник.

  • WEDNESDAY — среда.

  • THURSDAY — четверг.

  • FRIDAY — пятница.

  • SATURDAY — суббота.

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

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

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

start-time startTime String

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

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

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

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

end-time endTime String

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

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

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

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

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

delivery-rule

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

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

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

min-delivery-days minDeliveryDays Int32

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

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

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

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

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

cost cost Double

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

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

delivery-service-id deliveryServiceId Int64

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

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

max-delivery-days maxDeliveryDays Int32

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

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

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

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

order-before orderBefore Int32

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

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

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

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

price-free-pickup priceFreePickup Double

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

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

unspecified-delivery-interval unspecifiedDeliveryInterval Boolean

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

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

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

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

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

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

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

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

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

email String

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

Допускается любой адрес электронной почты, соответствующий стандарту 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

errors errors

Список ошибок.

Выводится, если параметр status=ERROR.

result result

Результат работы метода.

Выводится, если параметр status=OK.

status status Enum

Статус ответа.

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

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

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

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

error

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

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

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

code code Enum

Код ошибки.

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

  • 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.

message message String

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

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

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

id id Int64

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

Для формата 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 min-delivery-days="0" cost="285" delivery-service-id="100" max-delivery-days="30" order-before="24" price-free-pickup="120" unspecified-delivery-interval="true"/>
  </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>