shop.settings.get

Apps » Shop-Script » API »

Returns store settings values.

Parameters

  • access_token GET

    API auth token obtained during the API authorization.

  • format GET Optional

    Sets response format. Available options: json (default), xml.

Store settings array with the following keys:

  • address_fields array IDs of address fields available for multi-step checkout setup.
  • currencies array List of all configured currencies. Array keys are 3-letter ISO 4217 currency codes. The sub-array of each currency contains values with the following keys:
    • currencies[]['code'] string 3-letter ISO 4217 currency code.
    • currencies[]['frac_name'] array List of currency’s fractional unit names. Each sub-array contains a singular and a plural form of a fractional unit name version.
    • currencies[]['is_primary'] bool Flag denotig whether a currency is the main store currency.
    • currencies[]['iso4217'] int Numeric currency code by ISO 4217.
    • currencies[]['name'] array List of currency names.
    • currencies[]['precision'] int Number of decimal digits used to write amounts in a particular currency.
    • currencies[]['rate'] float Exchange rate towards the main store currency.
    • currencies[]['round_up_only'] int Value of the Round fractions up only setting (0 or 1).
    • currencies[]['rounding'] float Rounding setting value.
    • currencies[]['sign'] string Currency symbol as plain text.
    • currencies[]['sign_delim'] string String used to separate the currency symbol from the numeric part of an amount.
    • currencies[]['sign_html'] string Currency symbol containing HTML tags.
    • currencies[]['sign_position'] int|null Currency symbol position in written amounts.
    • currencies[]['sort'] int Sort value.
    • currencies[]['title'] string Localized currency name.
  • debug_mode bool Flag denoting whether the debug mode is on.
  • default_currency string Main store currency ID.
  • ignore_stock_count int Flag (0 or 1) denoting whether the Order → Ordering is not limited by stock levels parameter in the Settings → Stocks section is enabled.
  • order_states array Order states data array. The sub-array of each status data contains contains values with the following keys:
    • order_states['available_actions'] array String IDs of all order actions available in a particular state.
    • order_states['id'] string Status ID.
    • order_states['name'] string Status name.
    • order_states['options'] array Status parameters array with the following keys:
      • order_states['options']['icon'] string CSS class for an icon.
      • order_states['options']['style'] array CSS properties for a button.
  • server_time datetime Current server date and time.
  • settings array General store settings values:
    • settings['allow_image_upload'] int Value of the Allow customers to attach images to their reviews setting (0 or 1).
    • settings['country'] string 3-digit ID of the country selected in the Country setting.
    • settings['email'] string Value of the Primary email setting.
    • settings['gravatar_default'] string Value of the In case there were no Gravatar userpic uploaded setting.
    • settings['merge_carts'] int Value of the Sync shopping cart items on all devices for authorized customers setting (0 or 1).
    • settings['moderation_reviews'] int Value of the Publish reviews only after moderation setting (0 or 1).
    • settings['name'] string Value of the Store name setting.
    • settings['order_format'] string Value of the Order ID format setting.
    • settings['phone'] string Value of the Phone setting.
    • settings['require_authorization'] int Value of the Reviews: Only authorized users can post reviews setting (0 or 1).
    • settings['require_captcha'] int Value of the Reviews: Protect product review form with CAPTCHA setting (0 or 1).
    • settings['review_service_agreement'] string Value of the Reviews: Personal data processing setting (empty string, 'notice' or 'checkbox').
    • settings['review_service_agreement_hint'] string Text hint used for the Reviews: Personal data processing setting.
    • settings['sort_order_items'] string Value of the Sort order items setting ('user_cart' — “as added to the shopping cart”, 'sku_name' — “by item name”, 'sku_code' — “by SKU code”).
    • settings['use_gravatar'] int Value of the Display Gravatar userpics setting (0 or 1).
    • settings['workhours'] array Value of the Working schedule: Order processing schedule setting as an array with the following keys:
      • settings['workhours']['days'] array Brief localized days of the week.
      • settings['workhours']['days_from_to'] string Localized string denoting the range of working days in a week.
      • settings['workhours']['hours_from'] string Minimum value in the Business hours: from settings column.
      • settings['workhours']['hours_to'] string Maximum value in the Business hours: to settings column.
  • stock_counting_action string Value of the Update stock parameter in the Settings → Stocks section.
  • storefronts array Storefronts data array. Each storefront’s array contains values with the following keys:
    • storefronts[]['domain'] string Domain name.
    • storefronts[]['url'] string Home page URL without the protocol part.
    • storefronts[]['url_decoded'] string Home page URL without the protocol part, decoded from the Punycode format.
    • storefronts[]['route'] array Storefront settings array with the following keys:
      • storefronts[]['route']['checkout_storefront_id'] string In-cart checkout settings ID.
      • storefronts[]['route']['checkout_version'] int Checkout mode (1 — multi-step, 2 — in-cart).
      • storefronts[]['route']['currency'] string Main storefront currency’s 3-letter ISO 4217 code.
      • storefronts[]['route']['drop_out_of_stock'] int Value of the Out-of-stock products setting (0 — “Display as is”, 1 — “Force drop out-of-stock products to the bottom of all lists”, 2 — “Hide out-of-stock products”).
      • storefronts[]['route']['locale'] string Storefront locale ID.
      • storefronts[]['route']['meta_description'] string Value of the Homepage META Description setting.
      • storefronts[]['route']['meta_keywords'] string Value of the Homepage META Keywords setting.
      • storefronts[]['route']['og_description'] string Value of the Social sharing Description (og:description) setting.
      • storefronts[]['route']['og_image'] string Value of the Social sharing Image URL (og:image) setting.
      • storefronts[]['route']['og_title'] string Value of the Social sharing Title (og:title) setting.
      • storefronts[]['route']['og_type'] string Value of the Social sharing Type (og:type) setting.
      • storefronts[]['route']['og_url'] string Value of the Social sharing URL (og:url) setting.
      • storefronts[]['route']['og_video'] string Value of the Social sharing Video URL (og:video) setting.
      • storefronts[]['route']['payment_id'] int|array Value of the Payment options setting (0 — “All available payment options”, array — selected payment option IDs).
      • storefronts[]['route']['products_per_page'] int Value of the Number of products per page setting.
      • storefronts[]['route']['public_stocks'] int Value of the Visible stocks setting (0 — “All public stocks”, array — selected stock IDs).
      • storefronts[]['route']['shipping_id'] int|array Value of the Shipping methods setting (0 — “All available shipping options”, array — selected shipping method IDs.
      • storefronts[]['route']['stock_id'] int|string Value of the Default stock setting (int — ordinary stock, string — virtual stock).
      • storefronts[]['route']['theme'] string Value of the Design theme setting.
      • storefronts[]['route']['theme_mobile'] string Value of the Mobile design theme setting.
      • storefronts[]['route']['title'] string Value of the Homepage title <title> setting.
      • storefronts[]['route']['type_id'] int|array Value of the Published products setting (0 — “All product types”, array — selected product type IDs).
      • storefronts[]['route']['url'] string Storefront address mask.
      • storefronts[]['route']['url_type'] string Value of the URLs setting (0 — “Mixed”, 1 — “Plain”, 2 — “Natural”).
  • user_info array Authorized user data array with the following keys:
    • user_info['id'] int Contact ID.
    • user_info['name'] string Full name.
    • user_info['photo'] string Relative URL of the user profile image with the 50x50 pixels dimensions.
  • version string Shop-Script version number.
  • server_timezone string Name of the default time zone used on the server.
  • server_timezone_shift int Offset of the default time zone used on the server relative to UTC.
  • onboarding_passed bool Flag denoting whether the quick store setup interface has been show to the user.
  • frac_enabled bool Flag denoting whether support for fractional product quantities is enabled in the store settings.
  • stock_units_enabled bool Flag denoting whether support for products’ stock quantity units is enabled in the store settings.
  • base_units_enabled bool Flag denoting whether support for products’ base quantity units is enabled in the store settings.

Example

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