shop.order.action

Выполняет действие с заказом.

Параметры

  • id POST

    ID заказа.

  • action POST

    Строковый идентификатор действия.

  • text POST Необязательно

    Комментарий, который можно сохранить в историю обработки заказа при выполнении действий 'comment', 'message', 'delete', 'pay', 'capture', 'refund'.

  • return_stock POST Необязательно

    Для действия 'capture': ID склада, на который нужно вернуть остатки товаров, для которых не выполняется списание средств при частичном списании. Пустое значение обозначает возврат остатков на тот склад, с которого они были списаны во время обработки заказа.

    Для действия 'delete': ID склада, на который нужно вернуть остатки заказанных товаров. Пустое значение обозначает возврат остатков на тот склад, с которого они были списаны во время обработки заказа.

    Для действия 'refund': ID склада, на который нужно вернуть остатки товаров при возврате заказа. Пустое значение обозначает возврат остатков на тот склад, с которого они были списаны во время обработки заказа.

  • capture_mode POST Необязательно

    Строка 'partial', если необходимо выполнить частичное списание при выполнении действия 'capture'.

  • capture_items POST Необязательно

    Массив информации о товарах, для которых выполняется частичное списание при выполнении действия 'capture' со структурой вида [item_id]['quantity'], где item_id — ID элементов заказа, являющихся модификациями товаров, а значения — количество каждой модификации.

  • capture_shipping_cost POST Необязательно

    Флаг (0 или 1), обозначающий необходимость списания стоимости доставки во время частичного списания при выполнении действия 'capture'. Значение по умолчанию — 0.

  • code POST Необязательно

    Массив с информацией о товарных кодах заказанных товаров, введённых при выполнении действия 'editcode', со структурой вида [code_id][item_id][], где code_id — ID товарного кода, настроенного в магазине, item_id — ID элемента заказа, являющегося модификацией товара, а значения — товарные коды.

  • shipping_date POST Необязательно

    Дата доставки заказа курьером в формате 'гггг-мм-дд', которую можно указать при выполнении действий 'ship' и 'editshippingdetails'.

  • shipping_time_from POST Необязательно

    Начало диапазона времени доставки заказа курьером, который можно указать при выполнении действий 'ship' и 'editshippingdetails', в формате 'чч:мм'.

  • shipping_time_to POST Необязательно

    Конец диапазона времени доставки заказа курьером, который можно указать при выполнении действий 'ship' и 'editshippingdetails', в формате 'чч:мм'.

  • tracking_number POST Необязательно

    Идентификатор отправления, который можно указать при выполнении действий 'ship' и 'editshippingdetails'.

  • courier_id POST Необязательно

    ID курьера, который можно указать при выполнении действий 'ship' и 'editshippingdetails'.

  • transport POST Необязательно

    Обозначение транспорта для отправки сообщения, которое можно указать при выполнении действия 'message': 'email' или 'sms'.

  • sender POST Необязательно

    Обозначение отправителя, которое можно указать при выполнении действия 'message': email-адрес либо номер телефона. Если для отправки email-сообщения не указано значение 'sender', то в качестве адреса отправителя используется основой email-адрес из настроек магазина.

  • refund POST Необязательно

    Флаг (0 или 1), обозначающий необходимость обработать возврат заказа платёжным плагином при выполнении действия 'refund'.

  • refund_mode POST Необязательно

    Строка 'partial', если необходим частичный возврат при выполнении действия 'refund'.

  • refund_items POST Необязательно

    Массив информации о товарах в заказе, для которого выполняется возврат при выполнении действия 'refund', со структурой вида [item_id]['quantity'], где item_id — ID элементов заказа, являющихся модификациями товаров, а значения — количество модификаций.

  • master_id POST Необязательно

    ID главного заказа, с которым нужно объединить подвешенный заказ при выполнении действия 'settle'.

  • master_id_custom POST Необязательно

    ID главного заказа, с которым нужно объединить подвешенный заказ при выполнении действия 'settle'. Используется, если в параметре 'master_id' указана строка 'custom' (в случае, если вместо автоматически подобранных заказов необходимо вручную указать другой номер заказа).

  • access_token GET

    Токен авторизации, полученный при подключении к API.

  • format GET Необязательно

    Устанавливает формат ответа. Возможные значения: json (по умолчанию), xml.

mixed Содержимое, которое возвращает метод run() PHP-класса действия.