Solicitar cotações

Lista as cotações disponíveis para uma entrega específica (ou conjunto de entregas).

Endpoint

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

Request

Para o request , você pode enviar uma ou mais entregas em um array para listar as cotações disponíveis para elas. Para mais detalhes sobre a estrutura da entrega, você pode ver aqui. Entrega

Headers

Propriedade	Tipo	Descrição	Exemplo
Content-Type	string		"application/json"
Authorization	string	Autenticação básica da empresa	"Basic XXXXXXXXXXXXXXXXXXXXXXXX"

Body

Propriedade	Tipo	Descrição	Obrigatório	Constraints
companyId	string	No caso de ter empresas filiais, você pode consultar cada uma delas com a mesma autenticação, mas alterando este campo. No caso de ter apenas uma empresa associada, este campo não é necessário.	NÃO
deliveries	array of Entrega	Arranjo de entregas que requer taxas de consulta.	SIM

Response

Após uma Cotação ser recuperada, o seguinte payload é recebido e você pode usar o deliveryQuoteId para criar uma entrega. Para mais detalhes sobre a estrutura da cotação, você pode ver aqui. Cotas

Propriedade	Tipo	Descrição
data.quotes	array de Cotas	Arranjo de cotas disponíveis para as entregas consultadas.

Exemplo

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: { }
}