Retrieve the assigned online store

GET

/api/method/public/online-ordering/get-store

Returns a curated subset of the Online Store configuration tied to the access token. Only the storefront-facing settings are included.

Request

Authorization

Add parameter in header

X-Access-Token

Example:

X-Access-Token: ********************

Responses

🟢200OK

application/json

Selected online store fields needed to render the storefront.

Body

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/method/public/online-ordering/get-store' \
--header 'X-Access-Token: <api-key>'

Response Example

200 - Example 1

{
    "message": {
        "name": "string",
        "title": "string",
        "enabled": 0,
        "vendor_name": "string",
        "vendor_tagline": "string",
        "company": "string",
        "restaurant_brand": "string",
        "currency": "string",
        "abbreviation": "string",
        "icon": "string",
        "image": "string",
        "cover": "string",
        "allow_users_to_select_their_address_from_map": 0,
        "automatically_fetch_address_from_geolocation": 0,
        "default_map_lat": "string",
        "default_map_lon": "string",
        "allow_order_outside_delivery_zone": 0,
        "location_service": "string",
        "country": "string",
        "phone_regex": "string",
        "default_language": "string",
        "default_delivery_time": 0,
        "facebook_link": "http://example.com",
        "instagram_link": "http://example.com",
        "website_link": "http://example.com",
        "meta_pixel_id": "string",
        "google_analytics_id": "string",
        "show_promotion_list": 0,
        "order_types": [
            {
                "order_type": "string"
            }
        ],
        "allowed_menus": [
            {
                "menu": "string"
            }
        ],
        "mode_of_payments": [
            {
                "mode_of_payment": "string"
            }
        ]
    }
}

Fetch a single menu product

Add a menu product to the cart