ms.settings

This property of ms global object contains the store settings information.


Variables

Value Description
_id It is the unique identifier of the settings for the store.
admin_email It contains the email id of the admin of the store.
availability_criteria It tells whether the delivery availability is checked according to the pin codes or the area.
base_currency It contains the name of the default currency of the store.
check_availablity It is an array which contains the payment modes (COD, Offline, Online) for which the delivery availability is to be checked.
contact_email It contains the email id of the point of contact of the store.
contact_phone It contains the phone number of the point of contact/admin of the store.
default_language It contains the name of the default language of the store.
default_theme It contains the unique identifier of default theme of the store.
default_weight_units It contains the default weight unit used in the store.
generate_invoice It tells whether the invoice is to be generated manually or automatically (while placing the order).
generate_invoice_for_unpaid_orders If enabled, it generates the invoice of COD orders.
invoice_number It contains the last generated invoice number.
invoice_number_prefix It is used to define a prefix for the order invoice numbers.
logo It contains the path of the image used as logo of the store.
physical_location It contains the address of the admin.
served_countries It is an array of the countries served by the store.
store_title It contains the title of the store.
under_maintenance To show the site under maintenance, this field is enabled. Also, an image can also be uploaded to show under maintenance.
payment_methods It is an array containing information about all the payment methods used in the store.