Historical contract: Find Business Delivery Zone
Historical API contract. This page describes an earlier API contract. Methods, paths, and responses may differ from the current API.
Historical meaning
Find Business Delivery Zone
This API endpoint is used to obtain a specific delivery zone.
Current API
For new integrations, use the linked current API reference or guide.
View the current API referenceParameters
[
{
"name": "language",
"in": "path",
"schema": {
"type": "string",
"default": "en"
},
"required": true
},
{
"name": "project",
"in": "path",
"schema": {
"type": "string",
"default": "<redacted-personal>"
},
"required": true
},
{
"name": "business_id",
"in": "path",
"schema": {
"type": "integer",
"format": "int32"
},
"required": true
},
{
"name": "deliveryzone_id",
"in": "path",
"schema": {
"type": "integer",
"format": "int32"
},
"required": true
},
{
"name": "params",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "api_version",
"in": "path",
"schema": {
"type": "string",
"default": "v400"
},
"required": true
}
]
Request body
null
Responses
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": {\n \"id\": 15,\n \"business_id\": 0,\n \"name\": \"<redacted-personal>\",\n \"type\": 1,\n \"address\": \"<redacted-personal>\",\n \"data\": {\n \"center\": {\n \"lat\": 40.43394756583168,\n \"lng\": -73.46213756796874\n },\n \"radio\": 20034.6144285728\n },\n \"dropdown_option_id\": null,\n \"price\": 2,\n \"minimum\": 1,\n \"schedule\": [\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 0,\n \"minute\": 0\n }\n }\n ]\n }\n ],\n \"enabled\": true,\n \"business\": {\n \"id\": 22,\n \"name\": \"<redacted-personal>\",\n \"email\": \"<redacted-email>\",\n \"slug\": \"thelaundryhome\",\n \"schedule\": [\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n },\n {\n \"enabled\": true,\n \"lapses\": [\n {\n \"open\": {\n \"hour\": 0,\n \"minute\": 0\n },\n \"close\": {\n \"hour\": 23,\n \"minute\": 59\n }\n }\n ]\n }\n ],\n \"description\": \"\",\n \"about\": \"\",\n \"logo\": \"https://example.com/ordering/image/upload/v1534196763/lmp3g6yipooxaihqzy8g.jpg\",\n \"header\": \"https://example.com/ordering/image/upload/v1534196750/ikb2motaoq97cu4avfrl.jpg\",\n \"phone\": \"<redacted-personal>\",\n \"cellphone\": \"<redacted-personal>\",\n \"owner_id\": 1,\n \"city_id\": 1,\n \"address\": \"<redacted-personal>\",\n \"address_notes\": null,\n \"zipcode\": null,\n \"location\": {\n \"lat\": 40.717664000000006,\n \"lng\": -73.99222789999999,\n \"zipcode\": -1,\n \"zoom\": 15\n },\n \"featured\": true,\n \"timezone\": \"America/New_York\",\n \"currency\": \"USD\",\n \"food\": false,\n \"alcohol\": false,\n \"groceries\": false,\n \"laundry\": true,\n \"use_printer\": false,\n \"printer_id\": null,\n \"minimum\": 0,\n \"delivery_price\": 0,\n \"always_deliver\": false,\n \"tax_type\": 2,\n \"tax\": 0,\n \"delivery_time\": \"0:0\",\n \"pickup_time\": \"0:0\",\n \"service_fee\": 0,\n \"fixed_usage_fee\": 0,\n \"percentage_usage_fee\": 0,\n \"enabled\": true\n }\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 15,
"default": 0
},
"business_id": {
"type": "integer",
"example": 0,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"type": {
"type": "integer",
"example": 1,
"default": 0
},
"address": {
"type": "string",
"example": "<redacted-personal>"
},
"data": {
"type": "object",
"properties": {
"center": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 40.43394756583168,
"default": 0
},
"lng": {
"type": "number",
"example": -73.46213756796874,
"default": 0
}
}
},
"radio": {
"type": "number",
"example": 20034.6144285728,
"default": 0
}
}
},
"dropdown_option_id": {},
"price": {
"type": "integer",
"example": 2,
"default": 0
},
"minimum": {
"type": "integer",
"example": 1,
"default": 0
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"lapses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 0,
"default": 0
},
"minute": {
"type": "integer",
"example": 0,
"default": 0
}
}
},
"close": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 0,
"default": 0
},
"minute": {
"type": "integer",
"example": 0,
"default": 0
}
}
}
}
}
}
}
}
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"business": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 22,
"default": 0
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"email": {
"type": "string",
"example": "<redacted-email>"
},
"slug": {
"type": "string",
"example": "thelaundryhome"
},
"schedule": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"default": true
},
"lapses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"open": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 0,
"default": 0
},
"minute": {
"type": "integer",
"example": 0,
"default": 0
}
}
},
"close": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"example": 23,
"default": 0
},
"minute": {
"type": "integer",
"example": 59,
"default": 0
}
}
}
}
}
}
}
}
},
"description": {
"type": "string",
"example": ""
},
"about": {
"type": "string",
"example": ""
},
"logo": {
"type": "string",
"example": "https://example.com/ordering/image/upload/v1534196763/lmp3g6yipooxaihqzy8g.jpg"
},
"header": {
"type": "string",
"example": "https://example.com/ordering/image/upload/v1534196750/ikb2motaoq97cu4avfrl.jpg"
},
"phone": {
"type": "string",
"example": "<redacted-personal>"
},
"cellphone": {
"type": "string",
"example": "<redacted-personal>"
},
"owner_id": {
"type": "integer",
"example": 1,
"default": 0
},
"city_id": {
"type": "integer",
"example": 1,
"default": 0
},
"address": {
"type": "string",
"example": "<redacted-personal>"
},
"address_notes": {},
"zipcode": {},
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 40.717664000000006,
"default": 0
},
"lng": {
"type": "number",
"example": -73.99222789999999,
"default": 0
},
"zipcode": {
"type": "integer",
"example": -1,
"default": 0
},
"zoom": {
"type": "integer",
"example": 15,
"default": 0
}
}
},
"featured": {
"type": "boolean",
"example": true,
"default": true
},
"timezone": {
"type": "string",
"example": "America/New_York"
},
"currency": {
"type": "string",
"example": "USD"
},
"food": {
"type": "boolean",
"example": false,
"default": true
},
"alcohol": {
"type": "boolean",
"example": false,
"default": true
},
"groceries": {
"type": "boolean",
"example": false,
"default": true
},
"laundry": {
"type": "boolean",
"example": true,
"default": true
},
"use_printer": {
"type": "boolean",
"example": false,
"default": true
},
"printer_id": {},
"minimum": {
"type": "integer",
"example": 0,
"default": 0
},
"delivery_price": {
"type": "integer",
"example": 0,
"default": 0
},
"always_deliver": {
"type": "boolean",
"example": false,
"default": true
},
"tax_type": {
"type": "integer",
"example": 2,
"default": 0
},
"tax": {
"type": "integer",
"example": 0,
"default": 0
},
"delivery_time": {
"type": "string",
"example": "0:0"
},
"pickup_time": {
"type": "string",
"example": "0:0"
},
"service_fee": {
"type": "integer",
"example": 0,
"default": 0
},
"fixed_usage_fee": {
"type": "integer",
"example": 0,
"default": 0
},
"percentage_usage_fee": {
"type": "integer",
"example": 0,
"default": 0
},
"enabled": {
"type": "boolean",
"example": true,
"default": true
}
}
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"The delivery zone does not exist.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "The delivery zone does not exist."
}
}
}
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"You do not have permission.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "You do not have permission."
}
}
}
}
}
}
}
}