shop.settings.get

Возвращает значения настроек магазина.

Параметры

  • access_token GET

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

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

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

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

  • address_fields array Массив идентификаторов полей адреса, доступных в настройках пошагового оформления заказа.
  • currencies array Список всех настроенных валют. Ключи массива — идентификаторы валют в формате ISO 4217. Подмассив каждой валюты содержит значения со следующими ключами:
    • currencies[]['code'] string Идентификатор валюты в формате ISO 4217.
    • currencies[]['frac_name'] array Список обозначений дробной части валюты. В каждом подмассиве содержится список обозначений дробной части: для единственного и множественного числа.
    • currencies[]['is_primary'] bool Флаг, обозначающий, является ли валюта основной.
    • currencies[]['iso4217'] int Числовой код валюты в формате ISO 4217.
    • currencies[]['name'] array Массив названий валюты.
    • currencies[]['precision'] int Количество десятичных знаков для обозначения дробной части сумм в данной валюте.
    • currencies[]['rate'] float Курс обмена по отношению к основной валюте магазина.
    • currencies[]['round_up_only'] int Флаг (0 или 1), обозначающий значение настройки «Округлять только вверх».
    • currencies[]['rounding'] float Значение настройки округления.
    • currencies[]['sign'] string Символ валюты в виде текста.
    • currencies[]['sign_delim'] string Строка, отделяющая символ валюты от числа.
    • currencies[]['sign_html'] string Символ валюты с использованием HTML-тегов.
    • currencies[]['sign_position'] int|null Обозначение места расположения символа валюты при отображении денежной суммы.
    • currencies[]['sort'] int Значение сортировки.
    • currencies[]['title'] string Локализованное название валюты.
  • debug_mode bool Флаг, обозначающий, включён ли режим отладки.
  • default_currency string ID основной валюты.
  • ignore_stock_count int Флаг (0 или 1), обозначающий, включён ли параметр «Заказ → Покупатель может оформить заказ, даже если товара нет в наличии» в разделе «Настройки → Склады».
  • order_states array Массив информации обо всех статусах заказов. Подмассив каждого статуса содержит значения со следующими ключами:
    • order_states['available_actions'] array Массив строковых идентификаторов действий с заказами, доступных в данном статусе.
    • order_states['id'] string Строковый идентификатор статуса.
    • order_states['name'] string Название статуса.
    • order_states['options'] array Массив параметров статуса со следующими ключами:
      • order_states['options']['icon'] string CSS-класс иконки.
      • order_states['options']['style'] array Ассоциативный массив CSS-свойств иконки.
  • server_time datetime Текущие дата и время сервера.
  • settings array Значения общих настроек магазина:
    • settings['allow_image_upload'] int Значение настройки «Разрешать покупателям загружать изображения к отзывам» (0 или 1).
    • settings['country'] string 3-буквенное обозначение страны, выбранной в настройке «Страна».
    • settings['email'] string Значение настройки «Основной email-адрес».
    • settings['gravatar_default'] string Значение настройки «Если у покупателя не загружен юзерпик в сервисе Gravatar».
    • settings['merge_carts'] int Значение настройки «Синхронизировать товары в корзине авторизованного покупателя на всех устройствах» (0 или 1).
    • settings['moderation_reviews'] int Значение настройки «Публиковать отзывы только после проверки» (0 или 1).
    • settings['name'] string Значение настройки «Название магазина».
    • settings['order_format'] string Значение настройки «Формат номеров заказов».
    • settings['phone'] string Значение настройки «Телефон».
    • settings['require_authorization'] int Значение настройки «Отзывы: Отзывы о товарах могут оставлять только зарегистрированные пользователи» (0 или 1).
    • settings['require_captcha'] int Значение настройки «Отзывы: Защитить форму добавления отзыва о товаре с помощью капчи» (0 или 1).
    • settings['review_service_agreement'] string Значение настройки «Отзывы: Обработка персональных данных» (пустая строка, 'notice' или 'checkbox').
    • settings['review_service_agreement_hint'] string Текстовая подсказка, используемая настройкой «Отзывы: Обработка персональных данных».
    • settings['sort_order_items'] string Значение настройки «Сортировка товаров в заказе» ('user_cart' — «по времени добавления в корзину», 'sku_name' — «по наименованию», 'sku_code' — «по коду артикула»).
    • settings['use_gravatar'] int Значение настройки «Показывать юзерпики Gravatar» (0 или 1).
    • settings['workhours'] array Значение настройки «Режим работы: Время приема и обработки заказов» в вида массива со следующими ключами:
      • settings['workhours']['days'] array Массив сокращённых локализованных названий дней недели.
      • settings['workhours']['days_from_to'] string Локализованная строка с обозначением диапазона рабочих дней.
      • settings['workhours']['hours_from'] string Минимальное значение в столбце настроек «Часы работы: от».
      • settings['workhours']['hours_to'] string Максимальное значение в столбце настроек «Часы работы: до».
  • stock_counting_action string Значение параметра «Обновление склада» в разделе «Настройки → Склады».
  • storefronts array Массив витрин магазина. Подмассив с данными каждой витрины содержит значения со следующими ключами:
    • storefronts[]['domain'] string Доменное имя.
    • storefronts[]['url'] string URL главной страницы витрины без обозначения протокола.
    • storefronts[]['url_decoded'] string URL главной страницы витрины без обозначения протокола, перекодированный из формата Punycode.
    • storefronts[]['route'] array Массив настроек витрины со следующими ключами:
      • storefronts[]['route']['checkout_storefront_id'] string ID настроек оформления заказа в корзине.
      • storefronts[]['route']['checkout_version'] int Режим оформления заказа (1 — пошаговый, 2 — в корзине).
      • storefronts[]['route']['currency'] string Основная валюта витрины в 3-буквенном формате ISO 4217.
      • storefronts[]['route']['drop_out_of_stock'] int Значение настройки «Нет на складе» (0 — «Показывать как есть», 1 — «Автоматически перемещать вниз списка все товары, которых нет на складе», 2 — «Скрыть все товары, которых нет на складе»).
      • storefronts[]['route']['locale'] string Локаль витрины.
      • storefronts[]['route']['meta_description'] string Значение настройки «META Description главной страницы».
      • storefronts[]['route']['meta_keywords'] string Значение настройки «META Keywords главной страницы».
      • storefronts[]['route']['og_description'] string Значение настройки «Описание (og:description)».
      • storefronts[]['route']['og_image'] string Значение настройки «Изображение (og:image)».
      • storefronts[]['route']['og_title'] string Значение настройки «Заголовок (og:title)».
      • storefronts[]['route']['og_type'] string Значение настройки «Тип страницы (og:type)».
      • storefronts[]['route']['og_url'] string Значение настройки «Ссылка для соцсетей (og:url)».
      • storefronts[]['route']['og_video'] string Значение настройки «Видео (og:video)».
      • storefronts[]['route']['payment_id'] int|array Значение настройки «Способы оплаты» (0 — «Все доступные способы оплаты», массив — ID выбранных способов оплаты).
      • storefronts[]['route']['products_per_page'] int Значение настройки «Количество товаров на странице».
      • storefronts[]['route']['public_stocks'] int Значение настройки «Показывать склады» (0 — «Все склады, видимые покупателям», массив — ID выбранных складов).
      • storefronts[]['route']['shipping_id'] int|array Значение настройки «Способы доставки» (0 — «Все доступные способы доставки», массив — ID выбранных способов доставки).
      • storefronts[]['route']['stock_id'] int|string Значение настройки «Основной склад» (int — обычный склад, string — виртуальный склад).
      • storefronts[]['route']['theme'] string Значение настройки «Тема оформления».
      • storefronts[]['route']['theme_mobile'] string Значение настройки «Мобильная тема оформления».
      • storefronts[]['route']['title'] string Значение настройки «Заголовок главной страницы <title>».
      • storefronts[]['route']['type_id'] int|array Значение настройки «Опубликованные товары» (0 — «Все типы товаров», массив — ID выбранных типов товаров).
      • storefronts[]['route']['url'] string Маска адреса витрины.
      • storefronts[]['route']['url_type'] string Значение настройки «URL страниц» (0 — «Смешанный», 1 — «Плоский», 2 — «Естественный»).
  • user_info array Массив данных авторизованного пользователя со следующими ключами:
    • user_info['id'] int ID контакта.
    • user_info['name'] string Полное имя.
    • user_info['photo'] string Относительный URL изображения из профиля пользователя размером 50х50 пикселей.
  • version string Номер версии Shop-Script.

Пример

https://demo1-ru.webasyst.com/api.php/shop.settings.get?