shop.order.getInfo

Приложения » Shop-Script » API »

Возвращает информацию о заказе.

Параметры

  • id GET

    ID заказа.

  • access_token GET

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

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

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

Массив с информацией о заказе со следующими ключами:

  • id int ID заказа.
  • contact_id int ID контакта покупателя.
  • create_datetime datetime Дата и время создания заказа.
  • update_datetime datetime Дата и время последнего обновления заказа.
  • state_id string Идентификатор статуса заказа.
  • total float Стоимость заказа, выраженная в валюте заказа, в формате decimal(15,4).
  • currency string Идентификатор валюты заказа в формате ISO 4217.
  • rate float Курс валюты заказа по отношению к основной валюте магазина.
  • tax float Размер применённого налога, выраженный в валюте заказа, в формате decimal(15,4).
  • shipping float Стоимость доставки, выраженная в валюте заказа, в формате decimal(15,4).
  • discount float Размер скидки, выраженный в валюте заказа, в формате decimal(15,4).
  • paid_year int Номер года из даты оплаты заказа.
  • paid_quarter int Номер квартала года из даты оплаты заказа.
  • paid_month int Номер месяца года из даты оплаты заказа.
  • paid_date date Дата оплаты заказа в формате yyyy-mm-dd.
  • auth_date date Дата блокировки средств для оплаты заказа в формате yyyy-mm-dd.
  • is_first int Флаг (0 или 1), обозначающий первый оплаченный заказ покупателя.
  • unsettled int Флаг (0 или 1), обозначающий, является ли заказ подвешенным.
  • comment string Комментарий к заказу, оставленный покупателем.
  • shipping_datetime datetime Дата и время, соответствующие концу периода времени, выбранному в поле «Доставка курьером» при выполнении действия «Изменить параметры доставки».
  • params array Массив дополнительных параметров заказа.
    • params['shipping_id'] int ID выбранного варианта доставки.
    • params['payment_id'] int ID выбранного варианта оплаты.
    • params['referer_host'] string Домен сайта-реферера, с которого покупатель перешёл в магазин.
    • params['departure_datetime'] datetime Дата и время, начиная с которого заказ считается готовым к отправке.
    • params['coupon_id'] int ID применённого купона на скидку.
    • params['sales_channel'] string Обозначение канала продаж: 'backend:' (заказ создан администратором в панели управления магазина), 'storefront:...' (заказ оформлен на витрине магазина), 'buy_button:' (заказ оформлен через виджет товара «Купить»).
    • params['shipping_address...'] string Поля адреса доставки.
    • params['shipping_name'] string Название способа доставки.
    • params['payment_plugin'] string Идентификатор плагина оплаты.
    • params['payment_name'] string Название способа оплаты.
    • params['shipping_currency'] string Идентификатор валюты, в которой выражена стоимость доставки, в формате ISO 4217.
    • params['reduced'] int Флаг (0 или 1), обозначающий, что остатки заказанных товаров списывались со склада в ходе обработки заказа.
    • params['reduce_times'] int Количество раз, когда остатки заказанных товаров списывались со склада в ходе обработки заказа.
  • contact array Массив свойств покупателя со следующими ключами:
    • contact['id'] int ID контакта.
    • contact['name'] string Полное имя.
    • contact['email'] string Email-адрес.
    • contact['phone'] string Номер телефона.
    • contact['registered'] bool Признак регистрации покупателя для входа в личный кабинет с паролем.
    • contact['photo_50x50'] string URL фотографии покупателя либо ссылка на его юзерпик в сервисе Gravatar.
  • items array Массив со списком заказанных товаров и услуг:
    • items[]['id'] int ID элемента заказа.
    • items[]['order_id'] string ID заказа.
    • items[]['name'] string Название элемента заказа.
    • items[]['product_id'] int ID товара, которому соответствует элемент заказа.
    • items[]['sku_id'] int ID заказанной модификации товара.
    • items[]['sku_code'] string Код заказанного артикула.
    • items[]['type'] string Обозначение типа элемента заказа: 'product' (модификация товара) или 'service' (услуга).
    • items[]['service_id'] int ID услуги, если элемент заказа является услугой.
    • items[]['service_variant_id'] int ID варианта услуги, если элемент заказа является услугой.
    • items[]['price'] float Цена элемента заказа, выраженная в валюте заказа, в формате decimal(15,4).
    • items[]['quantity'] float Количество элемента заказа в формате в формате decimal(15,3).
    • items[]['quantity_denominator'] int Доступная точность указания складских остатков товара: 1 (целые штуки), 10 (точность до десятых), 100 (точность до сотых), 1000 (точность до тысячных).
    • items[]['stock_id'] int ID склада, выбранного в свойствах заказа для списания остатков модификации товара.
    • items[]['virtual_stock_id'] int ID виртуального склада, с которого должно выполняться списание остатков заказанной модификации товара.
    • items[]['purchase_price'] float Закупочная цена элемента заказа, выраженная в валюте заказа, в формате decimal(15,4).
    • items[]['total_discount'] float Размер скидки, рассчитанный для всего количества заказанной модификации товара, выраженный в валюте заказа, в формате decimal(15,4).
    • items[]['tax_percent'] float Количество процентов применённого налога в формате decimal(15,4).
    • items[]['tax_included'] int Флаг (0 или 1), означающий, включён ли размер налога в цену заказанного товара.
    • items[]['stock_unit_id'] int ID складской единицы измерения количества заказанной модификации товара.
    • items[]['image_id'] int ID изображения товара из свойств заказанной модификации товара.

Пример

https://demo1-ru.webasyst.com/api.php/shop.order.getInfo?