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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«order_cancel»
id	ДА	число	Номер заказа.
cause	ДА	«1» или «2»	Код причины аннулирования заказа: 1 – тестовый заказ, 2 – аннулирован по просьбе клиента.

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

См. общие параметры ответа. Если значение параметра «error» равно нулю, заказ успешно аннулирован.

Переписка клиента с операторами My-shop.ru: новое сообщение клиента

В сочетании со следующим запросом («Переписка клиента с операторами My-shop. ru: список сообщений») позволяет реализовать переписку клиента с операторами My-shop. ru на странице заказа в партнерском магазине. Имеет смысл, когда в партнерском магазине используется регистрация клиента и хранится история заказов. Подробнее см. в описании следующего запроса.

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«message_new»
id	ДА	число	Номер заказа.
text	ДА	текст	Текст сообщения клиента.

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
message_id	ДА	число	Идентификатор сохраненного сообщения.

Переписка клиента с операторами My-shop.ru: список сообщений

В сочетании с предыдущим запросом («Переписка клиента с операторами My-shop. ru: новое сообщение клиента») позволяет реализовать переписку клиента с операторами My-shop. ru на странице заказа в партнерском магазине. Имеет смысл, когда в партнерском магазине используется регистрация клиента и хранится история заказов.

Данный запрос позволяет получить полный архив переписки по конкретному заказу (список сообщений клиента и операторов My-shop. ru), либо только последние ответы операторов My-shop. ru (подробнее см. ниже). Рекомендуется отображать список сообщений так же, как это делается на страницах заказов в My-shop. ru – самые последние сообщения сверху (сортировка по идентификаторам сообщений по убыванию).

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

В партнерском магазине могут использоваться различные варианты оповещения клиентов о новых сообщениях:

1)  Пассивное – список сообщений загружается и отображается на страницах партнерского магазина, когда туда заходит клиент.

2)  Активное – программное обеспечение партнерского магазина с какой-то периодичностью (см. наши рекомендации в разделе «Популярные вопросы. Рекомендации My-shop. ru») проверяет, не появилось ли новых сообщений, а при появлении новых сообщений пересылает их по электронной почте клиентам.
Начиная с сентября 2013 г., мы не рекомендуем использовать подобный способ оповещения, т. к. предоставляем всем клиентам, оформившим заказ в партнерском магазине, доступ к странице заказа на сайте Интернет-магазина My-shop. ru. На этой странице клиент может проверять состояние заказа, вносить изменения в заказ и вести переписку с операторами магазина. Кроме того, таким клиентам отправляются SMS-уведомления о ходе выполнения заказа.

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«list_messages»
id	ДА	число	Номер заказа.
light	нет	«0» или «1»	Значение «0» – режим по умолчанию, при котором в ответ включаются все сообщения клиента и операторов My-shop. ru, относящиеся к этому заказу. Значение «1» – «лайт-режим», при использовании которого в ответ включаются только сообщения операторов My-shop. ru, добавленные после последнего сообщения клиента (последние ответы).

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
message_id	ДА	число	Идентификатор сообщения.
message_datetime	ДА	дата и время в формате YYYY-MM-DD HH:MM:SS	Дата и время сообщения. Время московское.
operator_id	ДА	число	Идентификатор оператора, добавившего сообщение. Значение «0» означает, что сообщение добавлено клиентом.
text	ДА	текст	Текст сообщения.

Краткий отчет об оформленных заказах

Позволяет получить информацию обо всех заказах, оформленных с участием партнера, идентификатор которого указан в параметре «partner» (не только о заказах, оформленных через данный API).

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

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«list_orders»
filter	ДА	см. описание	Допустимые форматы: §  NNN – номер заказа (пример: "123456"); §  KKK, MMM, NNN… – список номеров заказов через запятую без пробелов (пример: "123456,123459"); §  KKK-NNN – диапазон номеров заказов (пример: "123456-123470"), в качестве разделителя допускается только символ «-» (минус), без пробелов; §  KKK - – все заказы, номера которых больше или равны KKK (пример: "123456-"); §  - MMM – все заказы, номера которых меньше или равны MMM (пример: "-123456"); §  YYYY-MM – месяц оформления заказов (пример: "2010-03"); §  YYYY-MM-DD – дата оформления заказов (пример: "2010-03-23"); §  YYYY-MM-DD-YYYY-MM-DD – диапазон дат оформления заказов (пример: "2010-03-18-2010-03-23"); §  YYYY-MM-DD HH:MM-SS-YYYY-MM-DD HH:MM-SS – диапазон дат оформления заказов с указанием времени (пример: "2010-03-18 01:00:00-2010-03-23 13:30:00").
fee	нет	«0», «1» или «2»	«0» (по умолчанию) – без вычисления размера партнёрского вознаграждения (работает быстрее); «1» – включать в ответ одноименные параметры с суммой вознаграждения за каждый заказ, находящийся в состоянии «отправлен и оплачен» (начисленное вознаграждение); для остальных заказов будет указано нулевое вознаграждение; «2» – то же, но для всех заказов, независимо от их состояния.

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
id	ДА	число	Номер заказа.
order_datetime	ДА	дата и время в формате YYYY-MM-DD HH:MM:SS	Дата и время оформления заказа. Время московское.
sum_cart	ДА	число	Стоимость товаров в заказе, руб.
sum_discount	ДА	число	Скидка, руб.
discount	ДА	число	Скидка, %. Устаревший параметр: в настоящее время соответствует скидке на заказ в условиях, когда все товары в нём относятся к основной системе скидок. Не рекомендуется использовать. Может быть удалён.
status	ДА	число, 0–9	Код текущего состояния заказа: 0 – заказ аннулирован, 2 – ожидание предоплаты, 3 – комплектуется, ожидает отправки или находится в пункте выдачи, 4 – заблокирован в ожидании ответа клиента, 5 – отправлен, но не оплачен (только для наложенного платежа), 6 – отправлен и оплачен.
status_0_cause	Только для аннулированных заказов	число, 1–99	Код причины аннулирования заказа: 1 – тестовый заказ (тестирование или чья-то неудачная шутка), 2 – аннулирован по просьбе клиента, 3 – закончился товар (клиент отказался от оставшихся товаров), 4 – почтовый возврат (отказ клиента или ошибка Почты России), 5 – объединен с другим заказом клиента, 6 – истек срок ожидания товара для предварительного заказа, 7 – истек срок ожидания предоплаты, 8 – истек срок ожидания ответа клиента, 9 – невозможно выполнить пожелание клиента, 10 – истек срок ожидания наложенного платежа (вероятно, ошибка Почты России).
product_id	Только в случае оформления заказа после перехода по прямой ссылке	число	Код товара, на который был осуществлен переход по прямой ссылке (этого товара может не быть в составе заказа).
pin	нет	число	Значение одноименного параметра, указанное при оформлении заказа. Подробнее см. в описании запроса «Оформление нового заказа».
fee	В соответствии с запросом (см. выше)	число	Сумма партнёрского вознаграждения за заказ, руб.

Справочная информация