Solicitar Cuotas

Listar las cuotas disponibles para una entrega (o conjunto de entregas) determinada.

Endpoint

POST {{SHIPPIFY_API_URL}}/v2/pricing/quotes/available

Request

Para el request, puedes enviar una o más entregas en un array para listar las cuotas disponibles para ellas. Para más detalles sobre la estructura de las entregas, puedes consultar aquí: Entrega

Headers

Propiedad	Tipo	Descripción	Valor de ejemplo
Content-Type	string		"application/json"
Authorization	string	Autenticación básica de la empresa	"Basic XXXXXXXXXXXXXXXXXXXXXXXX"

Body

Propiedad	Tipo	Descripción	Obligatorio	Restricciones
companyId	string	En el caso de tener empresas hijas, puedes consultar cada una de ellas con el mismo auth pero cambiando este campo. En caso de tener una sola empresa asociada, este campo no es necesario.	NO
deliveries	arreglo de Entrega	Arreglo de entregas que requiere honorarios de consultoría.	SI

Response

Después de obtener una cuota, se recibe el siguiente payload y se puede utilizar el deliveryQuoteId para crear una entrega. Para más detalles sobre la estructura de una cuota, puedes ver aquí Cuota

Propiedad	Tipo	Descripción
data.quotes	arreglo de Cuota	Arreglo de las cuotas disponibles para las entregas consultadas.

Ejemplo

Request

curl --location --request POST 'https://api.shippify.co/v2/pricing/quotes/available' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXX' \
--header 'Cookie: locale=en' \
--data-raw '{
    "deliveries": [
        {
            "pickup": {
                "contact": {
                    "name": "jus",
                    "clientId": 422197,
                    "email": "[e-mail]",
                    "phonenumber": "[phone]"
                },
                "location": {
                    "address": "R4W6+522, 3º Callejón 14 NE, Guayaquil 090513, Ecuador",
                    "lat": -2.1554118300130938,
                    "lng": -79.88941404843996,
                    "instructions": "nuevo"
                },
                "date": 1678211269182
            },
            "dropoff": {
                "contact": {
                    "name": "jus",
                    "clientId": 422197,
                    "email": "[e-mail]",
                    "phonenumber": "[phone]"
                },
                "location": {
                    "address": "Gral. Julio Andrade Rodriguez, 502, Febrés Cordero,     Guayaquil-Guayas, 090414, Ecuador",
                    "lat": -2.198311566902902,
                    "lng": -79.92514860845964,
                    "instructions": "atras de la casa"
                }
            },
            "tags": ["PRIME"],
            "tagsToShow": [],
            "packages": [
                {
                    "name": "-",
                    "qty": "1",
                    "size": 2,
                    "price": 0,
                    "weight": 0,
                    "id": "-"
                }
            ]
        }
    ]
}'

200 Success

{
    "data": {
        "quotes": [
            {
                "name": "Flex Guayquil",
                "quoteId": 5383,
                "timeWindows": [
                    {
                        "pickupStart": 1678298400182,
                        "pickupEnd": 1678305600182,
                        "dropoffStart": 1678305600182,
                        "dropoffEnd": 1678312800182
                    }
                ],
                "totalPrice": 2.75,
                "deliveries": [
                    {
                        "index": 0,
                        "price": 2.75,
                        "quoteIdReference": 5383,
                        "currencySign": "$",
                        "distance": 9.2,
                        "deliveryQuoteId": "scopes:1:SSQ:1698359885910"
                    }
                ],
                "type": "flex"
            },
            {
                "name": "Express Guayaquil",
                "quoteId": 5384,
                "timeWindows": [
                    {
                        "pickupStart": 1678214869182,
                        "pickupEnd": 1678218469182,
                        "dropoffStart": 1678218469182,
                        "dropoffEnd": 1678222069182
                    }
                ],
                "totalPrice": 18.44,
                "deliveries": [
                    {
                        "index": 0,
                        "price": 18.44,
                        "quoteIdReference": 5384,
                        "currencySign": "$",
                        "distance": 9.2,
                        "deliveryQuoteId": "scopes:2:SSQ:1698359885910"
                    }
                ],
                "type": "express"
            },
            {
                "name": "Regular Guayaquil",
                "quoteId": 5385,
                "timeWindows": [
                    {
                        "pickupStart": 1678214869182,
                        "pickupEnd": 1678218469182,
                        "dropoffStart": 1678218469182,
                        "dropoffEnd": 1678222069182
                    },
                    {
                        "pickupStart": 1678218469182,
                        "pickupEnd": 1678222069182,
                        "dropoffStart": 1678222069182,
                        "dropoffEnd": 1678225669182
                    },
                    {
                        "pickupStart": 1678222069182,
                        "pickupEnd": 1678225669182,
                        "dropoffStart": 1678225669182,
                        "dropoffEnd": 1678229269182
                    },
                    {
                        "pickupStart": 1678225669182,
                        "pickupEnd": 1678229269182,
                        "dropoffStart": 1678229269182,
                        "dropoffEnd": 1678232869182
                    },
                    {
                        "pickupStart": 1678229269182,
                        "pickupEnd": 1678232869182,
                        "dropoffStart": 1678232869182,
                        "dropoffEnd": 1678236469182
                    }
                ],
                "totalPrice": 18.44,
                "deliveries": [
                    {
                        "index": 0,
                        "price": 18.44,
                        "quoteIdReference": 5385,
                        "currencySign": "$",
                        "distance": 9.2,
                        "deliveryQuoteId": "scopes:3:SSQ:1698359885910"
                    }
                ],
                "type": "slot"
            }
        ]
    }
}

400 Bad Request

{
    message: "Bad Request",
    payload: { }
}

500 Internal Server Error

{
    message: "Error while retrieving the quote",
    payload: { }
}