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

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

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

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
id	ДА	число, 0–9999	Код способа доставки.
name	ДА	строка, до 50 символов	Название способа доставки.
payment	ДА	строка, до 255 символов, пример: «4,1,2,3,5,6,7»	Список кодов способов оплаты (через запятую), допустимых при данном способе доставки. Первым указывается самый популярный для данного способа доставки способ оплаты (способ оплаты по умолчанию).
info	нет	текст	Текст, содержащий дополнительную информацию о способе доставки (может содержать простой HTML-код: гиперссылки на страницы сайтов транспортных компаний, «&nbsp;», «<br>» и т. п.).
info_importance	Только при наличии параметра «info»	число, 1-3	Важность информации в параметре «info»: 1 – просто дополнительная информация, отображение рекомендуется, но необязательно; 2 – отображение обязательно; 3 – отображение обязательно, очень важно.

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

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

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

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
id	ДА	число, 0–255	Код способа оплаты.
name	ДА	строка, до 255 символов	Название способа оплаты.

Справочник станций метро

Только для курьерской доставки по Москве.

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

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

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
id	ДА	число, 1–255	Код станции метро.
station	ДА	строка, до 50 символов	Название станции метро.
line	ДА	строка, до 50 символов	Название линии метро.
rgb	ДА	строка, 6 HEX-символов, пример: «9CB5FF»	RGB-цвет линии метро.

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

Используется только для доставки «Почтой России», а также при выборе любого из способов предоплаты.

Источник данных – сайт «Почты Росси»: http://info. russianpost. ru/database/ops. html

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

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

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
zip_code	ДА	код из 6 цифр	Индекс (код) отделения почтовой связи (ОПС).
region	ДА	строка, до 255 символов	Наименование области, края, республики, в которой находится ОПС.
autonom	нет	строка, до 255 символов	Наименование автономной области, в которой находится ОПС.
area	нет	строка, до 255 символов	Наименование района, в котором находится ОПС.
city	ДА	строка, до 255 символов	Наименование населенного пункта, в котором находится ОПС.

Справочник ограничений на пересылку

Используется только для доставки «Почтой России».

Источник данных – сайт «Почты Росси»: http://info. russianpost. ru/database/dlimits. html

В My-shop. ru указанные ограничения начинают применяться за 7 дней до дат, указанных в справочнике.

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

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

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
zip_code	ДА	код из 6 цифр	Индекс (код) отделения почтовой связи (ОПС).
date_1	ДА	2000-MM-DD	Дата начала действия ограничения по приему посылок и бандеролей (приведена к високосному 2000-му году).
date_2	ДА	2000-MM-DD	Дата окончания действия ограничения по приему посылок и бандеролей (приведена к високосному 2000-му году).
type	ДА	«0» или «1»	Тип ограничения: 0 – доставка запрещена, 1 – обязательна доставка авиапочтой (увеличивает стоимость доставки).

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

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

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

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
error_code	ДА	число	Код ошибки, возвращаемый данным API в параметре «error».
error_text	ДА	строка	Текстовое описание ошибки.

Ошибки, коды которых начинаются с «1», касаются общих параметров запроса. Клиентам такие ошибки не стоит показывать ни при каких обстоятельствах!

Ошибки, коды которых начинаются с «2», касаются состава заказа.

Ошибки, коды которых начинаются с «3», касаются основных параметров доставки и оплаты заказа.

Ошибки, коды которых начинаются с «4» – прочие ошибки, специфичные для конкретных типов запросов.

Прочие запросы

Поиск товаров

Возвращает список id найденных товаров, отсортированных по соответствию запросу.

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«list_search»
search	ДА	строка	Строка поискового запроса. Поиск осуществляется по названиям товаров, по фамилиям авторов, составителей и редакторов книг, а также по кодам ISBN, EAN и артикулам товаров (некоторые артикулы могут не учитываться в поиске).
availability	нет	«0», «1» или «2»	Значение фильтра по наличию товаров: «0» – все товары; «1» – только товары, которые есть в наличии + товары «под заказ» (по умолчанию); «2» – только товары, которые есть в наличии.
sale	нет	«1»	Признак того, что поиск нужно осуществлять только среди товаров в распродаже / в акциях со снижением цены.
catalogue_id	нет	число	Идентификатор раздела каталога, в котором нужно осуществлять поиск.
__page	нет	число	Номер отображаемой страницы результатов (по умолчанию – «1»).
__onpage	нет	число	Количество отображаемых результатов (по умолчанию – «25»).

Параметры ответа (для каждого элемента «item»):

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

Дополнительные параметры ответа (не относящиеся к элементам «item»):

Имя параметра	Обязательный	Формат, допустимые значения	Описание
results	ДА	число	Количество найденных товаров (3000 – искусственное ограничение количества результатов).
corrected	нет	строка	Исправленная строка запроса (только для случаев, когда поиск по исходной строке запроса не дал результатов, а поиск по исправленной строке оказался результативным).