Comprobar Método de Entrega

Este endpoint permite verificar si un método de entrega específico puede enviar tickets a una dirección determinada, además de proporcionar una estimación del tiempo de entrega y los costos asociados.

1. Método de Acceso

Parámetro

Descripción

URL (Versión por defecto 3.21)

{baseurl}/api/deliverymethodcheck?PartnerId={partnerId}

URL (Versión 3.60)

{baseurl}/api/deliverymethodcheck?PartnerId={partnerId}&api-version=3.60

Verbo HTTP

GET

Formato de Envío

application/json

 

2. Datos de Envío

Para comprobar un método de entrega, se deben enviar los siguientes parámetros:

Campo

Descripción

PartnerId

Identificador único del colaborador.

ReservationId

Identificador de la reserva obtenida en Reserva de Productos.

DeliveryMethodId

Identificador del método de entrega obtenido en Métodos de Entrega.

CountryCode

Código Alpha-2 del país (ISO 3166).

ZipCode

Código postal de la dirección de entrega.

api-version

Versión de la API a utilizar (por defecto 3.21).

 

3. Ejemplo de Petición

curl -X GET "{baseurl}/api/deliverymethodcheck?PartnerId={partnerId}&ReservationId=zp83haxd5ucwn&DeliveryMethodId=hen3s1e7ao4ch&CountryCode=es&ZipCode=46001" \

     -H "Content-Type: application/json"

También puedes hacer la solicitud desde un navegador o Postman con la siguiente URL:

{baseurl}/api/deliverymethodcheck?PartnerId={partnerId}&ReservationId=zp83haxd5ucwn&DeliveryMethodId=hen3s1e7ao4ch&CountryCode=es&ZipCode=46001

4. Estructura de la Respuesta

La API devuelve información sobre los costos y el tiempo estimado de entrega del método de entrega consultado.

Campo

Descripción

ShippingCosts

Coste del envío en la moneda configurada.

DeliveryDays

Tiempo estimado de entrega en días.

Success

true si la consulta fue exitosa.

Timestamp

Hora en la que se procesó la solicitud.

ErrorMessage

Mensaje de error en caso de falla.

ErrorCodes

Códigos de error, si los hay.

 

5. Ejemplo de Respuesta Exitosa

{

    "ShippingCosts": 30,

    "DeliveryDays": 20,

    "Success": true,

    "Timestamp": "2025-02-05T15:30:00.000Z"

}

 

6. Ejemplo de Respuesta con Error

Si el método de entrega no es válido o no es compatible con la dirección ingresada, la API devuelve un mensaje de error:

{

    "Success": false,

    "ErrorMessage": "El método de entrega no está disponible para la dirección proporcionada.",

    "Timestamp": "2025-02-05T15:32:00.000Z"

}

7. Consideraciones Finales

  • Este paso es necesario si el ticket tiene RequiresDeliveryManagement = true.
  • Si el ShippingCosts es 0, puede indicar que el envío es gratuito o no está disponible.
  • El DeliveryMethodId debe ser obtenido previamente de la consulta a métodos de entrega.
  • Si DeliveryDays no está presente en la respuesta, significa que la entrega no tiene una fecha estimada definida.
  • Es importante validar el país (CountryCode) y código postal (ZipCode) para asegurarse de que el método de entrega está disponible para la ubicación especificada.

¿Te ha parecido útil este artículo?