Программный интерфейс My-shop. ru для партнерских магазинов (стр. 7 )

Проверка текущей версии API

Такую проверку имеет смысл делать раз в сутки в автоматическом режиме. При увеличении номера версии API ваша программа может, например, оповестить ваших программистов по электронной почте или с помощью SMS-рассылки.

Изменение целой части числа в номере версии означает существенное изменение API, при котором рекомендуется как можно быстрее ознакомиться с полным списком изменений (в актуальной версии данного документа) и внести необходимые изменения в программное обеспечение партнерского магазина.

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

О существенных обновлениях API сообщается в рассылке «Новости партнерской программы My-shop. ru». Проверить, подписаны ли Вы на эту рассылку, можно на этой странице:

http://my-shop. ru/my/subscriptions

Разработчики API прилагают усилия для поддержания устаревших версий API в течение времени, необходимого для обновления программного обеспечения партнерских магазинов, однако такая поддержка не гарантируется.

URL: https://my-shop. ru/cgi-bin/p/info. pl

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«version»

Параметры ответа:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
version	ДА	число	Версия API.
last_modified_1	ДА	дата в формате YYYY-MM-DD	Дата последнего изменения целой части числа в номере версии API.
last_modified_2	ДА	дата в формате YYYY-MM-DD	Дата последнего изменения API (изменения дробной части числа в номере версии API).

Эти параметры также передаются в ответе на запрос «Различные константы» (см. ниже).

Различные константы

Если ваши программы используют перечисленные ниже параметры, имеет смысл проверять их раз в сутки в автоматическом режиме.

URL: https://my-shop. ru/cgi-bin/p/info. pl

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«const»

Параметры ответа:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
phone	ДА	строка	Телефонные номера, по которым покупатель может связаться с клиентской службой My-shop. ru.
email	ДА	строка	E-mail клиентской службы. Внимание! Публикация адреса электронной почты на страницах, которые могут быть доступны не только конкретному покупателю (могут быть «просканированы» извне), категорически запрещена!
payment_forward_limit	ДА	число	Максимальная стоимость товаров в заказе (с учетом скидки, если она есть), который может быть отправлен наложенным платежом, руб. «0» – ограничений нет.
payment_forward_extra	ДА	число	Наценка на стоимость заказа при использовании наложенного платежа, %. Данная наценка рассчитывается как процент от итоговой стоимости заказа (с учетом скидки и стоимости доставки) и прибавляется к стоимости доставки заказа.
partner_discount_max	ДА	число	Максимальная величина скидки (в процентах), которую партнер может предоставить клиенту.
url_company	ДА	строка	URL страницы с информацией о продавце.
url_address	ДА	строка	URL страницы с адресом пункта выдачи заказов и схемой проезда.
url_schedule	ДА	строка	URL страницы с графиком работы магазина.
conditions	ДА	текст	Условия, согласие с которыми должен подтвердить покупатель, оформляющий заказ на сайте партнера.
last_modified_list_regions* last_modified_list_delivery* last_modified_list_payment last_modified_list_metro last_modified_list_zip_code last_modified_list_zip_code_limitation last_modified_list_errors	ДА	дата в формате YYYY-MM-DD	Дата последнего изменения соответствующего справочника.
version	См. раздел «Проверка текущей версии API».
last_modified_1
last_modified_2
В ответе могут быть и другие параметры, они являются служебными.

* В параметрах «last_modified_list_regions» и «last_modified_list_delivery» всегда возвращается текущая дата. Эти параметры больше не используются (начиная с версии 1.9), текущая дата в значениях этих параметров возвращается для совместимости с предыдущими версиями.

Информация о цене и доступности товара

Если вашим программам приходится делать очень большое количество таких запросов, воспользуйтесь прайсом в формате CSV, подробнее см. здесь:
http://my-shop. ru/my/helper_89

Для отображения «корзины» с товарами вместо таких запросов рекомендуется использовать запрос «Корзина».

URL: https://my-shop. ru/cgi-bin/p/info. pl

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«product»
id	ДА	число	Код (идентификатор) товара в My-shop. ru.

Параметры ответа:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
cost	ДА	число	Стоимость товара в рублях. Параметр «sale_cost», если он определен, имеет приоритет над данным параметром.
availability_code	ДА	число, 0–3	Код доступности товара: 0 – нет в наличии, заказы не принимаются, 1 – нет в наличии, но принимаются «предварительные» заказы, 2 – есть в наличии (на складе My-shop. ru или на складах поставщиков My-shop. ru), 3 – есть в наличии (на складе My-shop. ru или на складах поставщиков My-shop. ru) и может быть отгружен очень быстро (в течение нескольких рабочих часов).
ds	ДА	число	Код системы скидок. Подробнее: http://my-shop. ru/my/helper_24
limit	нет	число	Максимальное количество свободных экземпляров товара (которые можно заказать). Внимание! В большинстве случаев значение данного параметра не определенно, однако это не означает, что в наличии есть большое количество. Неопределенное значение необходимо интерпретировать как отсутствие информации о количестве свободных экземпляров товара.
sale_percent	Только для товаров в распродаже	число	Распродажная скидка, %.
sale_cost	Только для товаров в распродаже	число	Стоимость товара с учетом распродажной скидки, руб.
sale_limit	Только для товаров в распродаже	число	Количество экземпляров товара в распродаже (максимальное количество экземпляров товара, которое можно приобрести с распродажной скидкой). При заказе большего количества стоимость всех заказанных экземпляров рассчитывается без учета распродажной скидки.
time_days	Только для товаров, имеющихся в наличии	число	Ориентировочное количество рабочих дней до отгрузки товара (при условии оформления заказа в этот момент).
time_text_a	Только для товаров, имеющихся в наличии	строка	Строка с ориентировочной датой отгрузки товара (при условии оформления заказа в этот момент) следующего вида: «12.01.2010 (Вт.)».

Справочник регионов доставки

URL: https://my-shop. ru/cgi-bin/p/info. pl

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«list_regions»

Параметры ответа:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
id	ДА	число, 1–999	Код региона.
name	ДА	строка, до 75 символов	Название региона.
country_id	ДА	число, 1–999	Код страны. В других запросах код страны не используется, в данный справочник включается только для того, чтобы можно было отличить российский регион (код страны – «1») от региона с названием другой страны. Использовать в пользовательских интерфейсах список, в котором перемешаны российские регионы и другие страны, не рекомендуется!
delivery_0 delivery_1 … delivery_n	ДА	число, 1–65535	Допустимый способ доставки. Число в имени параметра после «delivery_» – код способа доставки. Значение параметра – стоимость доставки в рублях (для курьерской доставки My-shop. ru) или номер тарифной зоны (для остальных способов доставки). Указываются только допустимые для данного региона способы доставки, т. е. наличие параметра «delivery_k» означает возможность использования способа доставки с кодом k в данном регионе.
delivery_0_free	нет	число, 1–65535	Минимальная сумма (стоимость товаров в заказе за вычетом скидки, если она есть) для бесплатной курьерской доставки (только для способа доставки с кодом «0» – доставка собственной курьерской службой в Москве и Подмосковье), руб.

Справочник способов доставки