api/v1/customer/online-order/settings

POST

/api/v1/customer/online-order/settings

This API method will return online order settings for account.

Request Parameters

Parameter

Value / Type

Required

account_id

STRING

true

Sample Response

{
    "status": true,
    "items": {
        "allow_pickup": 1,
        "allow_dine_in": 1,
        "allow_delivery": 1,
        "ordering_max_radius": 15,
        "delivery_fee": "15.00",
        "delivery_free_within": 15,
        "delivery_delay_time": "03:50:00",
        "enable_workflow": 1,
        "section_order": [
            "LZWBJx0PmYkEwjGdr2vO",
            "bZ6xBGP2mdPm3R8VX17L",
            "QD59AxOJm2MenXb14Pw7"
        ],
        "tax_group_id": 3,
        "tax_rates": [
            {"tax_rate_id": "bZ6xBGP2mdPm3R8VX17L", "value": "20.00"}
            {"tax_rate_id": "nK8oWGj0zxqELP1A53ak", "value": "77.00"}
        ],
        "delivery_areas": {
            "California": [
                {
                    "city_id": "xyQPkGvEjyXYzWla8OXV",
                    "city_name": "Acton"
                },
                {
                    "city_id": "ZXOYVd4E090Ye9Dxy0Bp",
                    "city_name": "Adin"
                }
            ],
            "New York": [
                {
                    "city_id": "BRQqA81eppjYedWnwlOX",
                    "city_name": "Acra"
                }
            ],
            "Texas": [
                {
                    "city_id": "AdWoD5km30gKz13wXyPO",
                    "city_name": "Alpine"
                },
                {
                    "city_id": "D59AxOJm2045EnXb14Pw",
                    "city_name": "Altair"
                },
                {
                    "city_id": "K8oWGj0zxRkLeLP1A53a",
                    "city_name": "Alto"
                },
                {
                    "city_id": "Z6xBGP2mdlrGm3R8VX17",
                    "city_name": "Alvarado"
                },
                {
                    "city_id": "ZWBJx0PmYDrBewjGdr2v",
                    "city_name": "Alvin"
                },
                {
                    "city_id": "y7bXBgZeMRLxmN391JoV",
                    "city_name": "Alvord"
                }
            ]
        }
    }
}
{
    "status": false,
    "errorCode": "VALIDATION_EXCEPTION",
    "messages": {
        "account_id": [
            "The account id field is required."
        ]
    }
}