[lightMode]

Settings List

GET/settings

[updatedIn] a month ago

This endpoint allows you to fetch the list of the main settings associated with the store to enable / disable / show / hide store features based on a specific entity

:::info[Read More]
For more on Store Settings, check the Merchant's Help Desk article here.
:::

`store-settings.read`- Settings Read Only

Request

Authorization: OAuth 2.0

Add the parameter

Authorization

to [header]，whose value is to concatenate the Token after the Bearer.

[api.label.example]

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

[message.queryParameter]

entity

enum<string>

required

Choose which entity to fetch the related settings

Allowed values:

productsorderscustomersreportsblogsmahallyfeedbacksshipping

Example:

orders

Request samples

[api.label.responses]

Success(200)

error_unauthorized_401(401)

error_validation_422(422)

HTTP Code: 200

Content Type : JSONapplication/json

status

integer

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array[object (Settings) {3}]

optional

slug

string

required

A unique identifier used to reference a specific setting or configuration within a system or application.

type

enum<string>

required

Settings type enum values

Allowed values:

formobjectstringbooleanintegerdropdown

value

required

The type's value, which changes based on the settings type

{
  "status": 200,
  "success": true,
  "data": [
    {
      "slug": "orders.receive_orders",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.receiving_times",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.order_notes",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.cancel_order",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.auto_complete",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.auto_return_stock",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.disable_bank_transfer_payment_period",
      "type": "boolean",
      "value": false
    },
    {
      "slug": "orders.shipping_indicator",
      "type": "boolean",
      "value": true
    },
    {
      "slug": "orders.price_quote",
      "type": "boolean",
      "value": false
    },
    {
      "slug": "orders.reorder",
      "type": "boolean",
      "value": true
    },
    {
      "slug": "orders.agreement",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.complete_customization",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.invoices_customization",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.shipping_policy_deduction",
      "type": "form",
      "value": null
    },
    {
      "slug": "orders.minimum_amount",
      "type": "string",
      "value": "123.23"
    },
    {
      "slug": "orders.attache_note_notify_status",
      "type": "boolean",
      "value": true
    },
    {
      "slug": "orders.status_notifications",
      "type": "dropdown",
      "value": [
        "email"
      ]
    },
    {
      "slug": "orders.digital_products_notify",
      "type": "dropdown",
      "value": [
        "email",
        "sms"
      ]
    }
  ]
}

[updatedIn] a month ago