Verificar Disponibilidad de Servicio

Descripción General

Estos endpoints permiten verificar la disponibilidad del servicio de Ridery en una ubicación específica o en múltiples ubicaciones simultáneamente. Esto es útil para determinar si Ridery ofrece servicios en las áreas donde se desea realizar envíos.

Verificación Individual

Endpoint

URL: baseURL/V2/corporate-api-partner/service-availability?lng=<lng>&lat=<lat>

Método: GET

Parámetros de Consulta

Parámetro	Descripción	Tipo	Requerido
lng	Longitud geográfica (entre -180 y 180, máx. 10 decimales)	Number	Sí
lat	Latitud geográfica (entre -90 y 90, máx. 10 decimales)	Number	Sí

Ejemplo de Solicitud

bash

GET baseURL/V2/corporate-api-partner/service-availability?lng=-66.862743&lat=10.4346014

Respuesta (verificación individual)

JSON

{
    "success": true,
    "code": "00",
    "msg": "ok",
    "data": {
        "city": {
            "_id": "6020ec4e01a03b0612ffa8f8",
            "is_business": 1,
            "cityname": "Caracas"
        },
        "city_types_active_in_coordinates": [
            {
                "type_id": "62bf17d17645af072a6e23f6",
                "type_name": "Envíos Moto"
            },
            {
                "type_id": "632dbb3adf8c257ccd0e4274",
                "type_name": "Envíos Ridery"
            },
            {
                "type_id": "63e1571a6c938a8313848633",
                "type_name": "Envios Ridery Max"
            },
            {
                "type_id": "63e158196c938a8313848720",
                "type_name": "Envios Pickup"
            },
            {
                "type_id": "6304ed4d0bb78f6407c7c8a3",
                "type_name": "Envíos Económico"
            },
            {
                "type_id": "66fd4e6ee43ae2cb56e453e0",
                "type_name": "Zupper Moto"
            },
            {
                "type_id": "67348a886accef7998804877",
                "type_name": "moto delivery"
            },
            {
                "type_id": "673b41d11585e7022161d8f9",
                "type_name": "Ridery Delivery"
            }
        ],
        "city_types_active_in_coordinates_for_api_partner": [
            {
                "type_id": "62bf17d17645af072a6e23f6",
                "type_name": "Envíos Moto"
            },
            {
                "type_id": "6304ed4d0bb78f6407c7c8a3",
                "type_name": "Envíos Económico"
            }
        ],
        "ridery_service_for_api_partner": true
    }
}

Descripción de la Respuesta

Campo	Descripción	Tipo
status	Indica si la solicitud fue exitosa	Boolean
data.city	Información de la ciudad encontrada en las coordenadas	Object
data.city_types_active_in_coordinates	Tipos de servicio disponibles en las coordenadas	Array
data.city_types_active_in_coordinates_for_api_partner	Tipos de servicio disponibles para el socio API en las coordenadas	Array
data.ridery_service_for_api_partner	Indica si el servicio de Ridery está disponible para el socio API en las coordenadas	Boolean

Códigos de Error (verificación individual)

Código HTTP	Descripción
404	No se encontró la ciudad con las coordenadas proporcionadas
421	Problema relacionado a algun campo que falla en la validacion de las respuestas (EJ: no se envio el campo lat o se envio con mas de 10 decimales)
500	Error interno del servidor

Caso de envio de token inadecuado

en caso de que el token no este siendo enviado correctamente, recibirá una respuesta como esta acompañada de un código http 401.

JSON

{
    "success": false,
    "error_description": "invalid api partner otp"
}

para evitar este error por favor refierase al documente Token y Autorización en la API

Verificación por Lotes

Endpoint

URL: baseURL/V2/corporate-api-partner/service-availability

Método: POST

Cuerpo de la Solicitud

json

{
  "coordinatesBatch": [
     {
        "lng": -68.0076500,
        "lat": 10.1620200,
        "location_id": "ejemplo-id-ubicacion-1",
        "location_name": "ejemplo-nombre-ubicacion-1",
        "location_address": "ejemplo-direccion-ubicacion-1"
    }, 
    {
        "lng": -66.862743,
        "lat": 10.4346014,
        "location_id": "ejemplo-id-ubicacion-2",
        "location_name": "ejemplo-nombre-ubicacion-2",
        "location_address": "ejemplo-direccion-ubicacion-2"
    },
    {
        "lng": -35.862743,
        "lat": 35.4346014,
        "location_id": "ejemplo-id-ubicacion-3",
        "location_name": "ejemplo-nombre-ubicacion-3",
        "location_address": "ejemplo-direccion-ubicacion-3"
    }, 
    {
        "lng": 100,
        "lat": 100,
        "location_id": "ejemplo-id-ubicacion-4",
        "location_name": "ejemplo-nombre-ubicacion-4",
        "location_address": "ejemplo-direccion-ubicacion-4"
    }
  ]
}

Descripción de los Campos

Campo	Descripción	Tipo	Requerido/Opcional
coordinatesBatch	Array de ubicaciones para verificar (máximo 50 elementos)	Array	Requerido
coordinatesBatch[].lng	Longitud geográfica	Number	Requerido
coordinatesBatch[].lat	Latitud geográfica	Number	Requerido
coordinatesBatch[].location_id	Identificador único de la ubicación	String	Opcional
coordinatesBatch[].location_name	Nombre de la ubicación	String	Opcional
coordinatesBatch[].location_address	Dirección de la ubicación	String	Opcional

Respuesta (verificación por lotes)

JSON

{
    "success": true,
    "code": "00",
    "msg": "ok",
    "data": {
        "coordinates_batch": [
            {
                "success": true,
                "coordinate_id": "ejemplo-id-ubicacion-1",
                "coordinate_name": "ejemplo-nombre-ubicacion-1",
                "coordinate_address": "ejemplo-direccion-ubicacion-1",
                "city": {
                    "_id": "60943cc540256e404847b3b6",
                    "is_business": 1,
                    "cityname": "Valencia"
                },
                "city_types_active_in_coordinates": [
                    {
                        "type_id": "62bf17d17645af072a6e23f6",
                        "type_name": "Envíos Moto"
                    }
                ],
                "city_types_active_in_coordinates_for_api_partner": [],
                "ridery_service_for_api_partner": false
            },
            {
                "success": true,
                "coordinate_id": "ejemplo-id-ubicacion-2",
                "coordinate_name": "ejemplo-nombre-ubicacion-2",
                "coordinate_address": "ejemplo-direccion-ubicacion-2",
                "city": {
                    "_id": "6020ec4e01a03b0612ffa8f8",
                    "is_business": 1,
                    "cityname": "Caracas"
                },
                "city_types_active_in_coordinates": [
                    {
                        "type_id": "62bf17d17645af072a6e23f6",
                        "type_name": "Envíos Moto"
                    },
                    {
                        "type_id": "632dbb3adf8c257ccd0e4274",
                        "type_name": "Envíos Ridery"
                    },
                    {
                        "type_id": "63e1571a6c938a8313848633",
                        "type_name": "Envios Ridery Max"
                    },
                    {
                        "type_id": "63e158196c938a8313848720",
                        "type_name": "Envios Pickup"
                    },
                    {
                        "type_id": "6304ed4d0bb78f6407c7c8a3",
                        "type_name": "Envíos Económico"
                    },
                    {
                        "type_id": "66fd4e6ee43ae2cb56e453e0",
                        "type_name": "Zupper Moto"
                    },
                    {
                        "type_id": "67348a886accef7998804877",
                        "type_name": "moto delivery"
                    },
                    {
                        "type_id": "673b41d11585e7022161d8f9",
                        "type_name": "Ridery Delivery"
                    }
                ],
                "city_types_active_in_coordinates_for_api_partner": [
                    {
                        "type_id": "62bf17d17645af072a6e23f6",
                        "type_name": "Envíos Moto"
                    },
                    {
                        "type_id": "6304ed4d0bb78f6407c7c8a3",
                        "type_name": "Envíos Económico"
                    }
                ],
                "ridery_service_for_api_partner": true
            },
            {
                "success": false,
                "coordinate_id": "ejemplo-id-ubicacion-3",
                "coordinate_name": "ejemplo-nombre-ubicacion-3",
                "coordinate_address": "ejemplo-direccion-ubicacion-3",
                "coordinates_received": {
                    "lat": 35.4346014,
                    "lng": -35.862743
                },
                "city": null,
                "city_types_active_in_coordinates": [],
                "city_types_active_in_coordinates_for_api_partner": [],
                "ridery_service_for_api_partner": false,
                "error_code": "421",
                "message": "No se encontró la ciudad con las coordenadas proporcionadas"
            },
            {
                "success": false,
                "coordinate_id": "ejemplo-id-ubicacion-4",
                "coordinate_name": "ejemplo-nombre-ubicacion-4",
                "coordinate_address": "ejemplo-direccion-ubicacion-4",
                "coordinates_received": {
                    "lat": 100,
                    "lng": 100
                },
                "city": null,
                "city_types_active_in_coordinates": [],
                "city_types_active_in_coordinates_for_api_partner": [],
                "ridery_service_for_api_partner": false,
                "error_code": "421",
                "message": "La latitud debe estar entre -90 y 90 grados"
            }
        ]
    }
}

Descripción de la Respuesta

Campo	Descripción	Tipo
status	Indica si la solicitud fue exitosa	Boolean
data.coordinates_batch	Array con los resultados de cada ubicación verificada	Array
data.coordinates_batch[].success	Indica si la verificación para esta ubicación fue exitosa	Boolean
data.coordinates_batch[].coordinate_id	Identificador único de la ubicación (si se proporcionó)	String
data.coordinates_batch[].coordinate_name	Nombre de la ubicación (si se proporcionó)	String
data.coordinates_batch[].coordinate_address	Dirección de la ubicación (si se proporcionó)	String
data.coordinates_batch[].coordinates_received	Coordenadas recibidas en la solicitud (solo aparece en caso de error)	Object
data.coordinates_batch[].city	Información de la ciudad encontrada en las coordenadas	Object
data.coordinates_batch[].city_types_active_in_coordinates	Tipos de servicio disponibles en las coordenadas	Array
data.coordinates_batch[].city_types_active_in_coordinates_for_api_partner	Tipos de servicio disponibles para el socio API	Array
data.coordinates_batch[].ridery_service_for_api_partner	Indica si el servicio está disponible para el socio
API	Boolean
data.coordinates_batch[].error_code	codigo de error (solo aparece en caso de error)	Number
data.coordinates_batch[].message	Mensaje de error (solo aparece en caso de error)	String

Consideraciones

El endpoint de verificación por lotes permite verificar hasta 50 ubicaciones en una sola solicitud.
Si una ubicación no puede ser verificada, se incluirá en la respuesta con success: false y un mensaje de error, mas no regresará un error en sí.
El campo ridery_service_for_api_partner es el indicador principal para determinar si el servicio está disponible para el socio API en una ubicación específica.

Verificar Disponibilidad de Servicio ​

Descripción General ​

Verificación Individual ​

Endpoint ​

Parámetros de Consulta ​

Ejemplo de Solicitud ​

Respuesta (verificación individual) ​

Descripción de la Respuesta ​

Códigos de Error (verificación individual) ​

Caso de envio de token inadecuado ​

Verificación por Lotes ​

Endpoint ​

Cuerpo de la Solicitud ​

Descripción de los Campos ​

Respuesta (verificación por lotes) ​

Descripción de la Respuesta ​

Consideraciones ​

Verificar Disponibilidad de Servicio

Descripción General

Verificación Individual

Endpoint

Parámetros de Consulta

Ejemplo de Solicitud

Respuesta (verificación individual)

Descripción de la Respuesta

Códigos de Error (verificación individual)

Caso de envio de token inadecuado

Verificación por Lotes

Endpoint

Cuerpo de la Solicitud

Descripción de los Campos

Respuesta (verificación por lotes)

Descripción de la Respuesta

Consideraciones