Contrato histórico: POST create-delivery-zone
Contrato histórico de API. Esta página describe un contrato anterior. Los métodos, las rutas y las respuestas pueden diferir de la API vigente.
Significado histórico
Crear zona de entrega del negocio
Este endpoint de la API se utiliza para crear una zona de entrega.
API vigente
Para desarrollar una integración nueva, consulta la referencia o guía vigente enlazada.
Ver la referencia de la API vigenteParámetros
[
{
"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": "api_version",
"in": "path",
"schema": {
"type": "string",
"default": "v400"
},
"required": true
}
]
Cuerpo de solicitud
{
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"type",
"price",
"minimum"
],
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32"
},
"address": {
"type": "string"
},
"data": {
"type": "string",
"format": "json"
},
"dropdown_option_id": {
"type": "integer",
"format": "int32"
},
"price": {
"type": "number",
"format": "float"
},
"minimum": {
"type": "number",
"format": "float"
},
"schedule": {
"type": "string",
"format": "json"
},
"enabled": {
"type": "boolean",
"default": true
},
"businesses": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
Respuestas
{
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": false,\n \"result\": {\n \"business_id\": \"<redacted-id>\",\n \"name\": \"<redacted-personal>\",\n \"minimum\": 1,\n \"price\": 1,\n \"type\": \"1\",\n \"data\": {\n \"center\": {\n \"lat\": 40.801915118240785,\n \"lng\": -73.94572904232791\n },\n \"radio\": 0.34316055458809697\n },\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 \"updated_at\": \"2018-11-24 15:03:55\",\n \"created_at\": \"2018-11-24 15:03:55\",\n \"id\": 43\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": false,
"default": true
},
"result": {
"type": "object",
"properties": {
"business_id": {
"type": "string",
"example": "<redacted-id>"
},
"name": {
"type": "string",
"example": "<redacted-personal>"
},
"minimum": {
"type": "integer",
"example": 1,
"default": 0
},
"price": {
"type": "integer",
"example": 1,
"default": 0
},
"type": {
"type": "string",
"example": "1"
},
"data": {
"type": "object",
"properties": {
"center": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"example": 40.801915118240785,
"default": 0
},
"lng": {
"type": "number",
"example": -73.94572904232791,
"default": 0
}
}
},
"radio": {
"type": "number",
"example": 0.34316055458809697,
"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": 23,
"default": 0
},
"minute": {
"type": "integer",
"example": 59,
"default": 0
}
}
}
}
}
}
}
}
},
"updated_at": {
"type": "string",
"example": "2018-11-24 15:03:55"
},
"created_at": {
"type": "string",
"example": "2018-11-24 15:03:55"
},
"id": {
"type": "integer",
"example": 43,
"default": 0
}
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"error\": true,\n \"result\": [\n \"The Name field is required.\",\n \"The Type field is required.\",\n \"The Price field is required.\",\n \"The Minimum field is required.\",\n \"The Schedule field is required.\"\n ]\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "boolean",
"example": true,
"default": true
},
"result": {
"type": "array",
"items": {
"type": "string",
"example": "The Name field is required."
}
}
}
}
}
}
},
"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."
}
}
}
}
}
}
}
}