Get Quick Order Settings

The Get Quick Order Settings endpoint retrieves the configuration settings for a merchant's quick order feature, including the title, sub-title, thanks message, order button text, email requirement, agreement requirement, allowed countries, custom styling options, confirmation button text, and the agreement text. These settings determine the behavior and appearance of the quick order feature on the merchant's store.

Response

Success

Error

cart.getQuickOrder.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

required

Data is available when the success is true

title

string

required

Short descriptive text for the quick order setting page

sub_title

string

required

Additional information or instructions for the quick order setting page

thanks_message

string

required

Message displayed after a successful quick order submission

order_now_button

string

required

Text displayed on the button to submit a quick order

is_email_required

boolean

required

Flag indicating whether an email is required for quick order submission.

show_agreement

boolean

required

Flag indicating whether an agreement is required for quick order submission.

allowed_countries

array[string]

required

List of countries where quick orders are allowed.

style

enum<string>

required

Custom styling options for the quick order setting page.

Allowed values:

defaultwhitegray

confirm_button

string

required

Text displayed on the button to confirm the quick order submission.

agreement

string

required

Text of the agreement required for quick order submission.

Usage

To perform the action of getting the setting of a quick order, the developer may call the getQuickOrderSettings() as shown below.

Events

This endpoint may trigger two events, the onQuickOrderSettingFetched and onQuickOrderSettingFailed events.

onQuickOrderSettingFetched

This event is triggered when getting the setting of a quick order is done without having any errors coming back from the backend.

onQuickOrderSettingFailed

This event is triggered when getting the setting of a quick order is not completed and an error has occurred.

Response#

Usage#

Events#

onQuickOrderSettingFetched#

onQuickOrderSettingFailed#

Response

Usage

Events

onQuickOrderSettingFetched

onQuickOrderSettingFailed