Deliveries API
Search
K
Comment on page

Request Quotes

List the quotes available for a given delivery(or set of deliveries).

Endpoint

POST /v2/pricing/quotes/available

Request

For the request, you can send one or more deliveries in an array to list the quotes available for them. For more details on the delivery structure, you can see here Delivery

Headers

Property
Type
Description
Example value
Content-Type
string
"application/json"
Authorization
string
Company basic auth
"Basic XXXXXXXXXXXXXXXXXXXXXXXX"

Body

Property
Type
Description
Required
Constraints
companyId
string
In the case of having daughter companies, you can query each of them with the same auth but changing this field. In case of having only one associated company, this field is not necessary.
NO
deliveries
array of Delivery
Arrangement of deliveries which requires consulting fees.
YES

Response

After a Quote is retrieved, the following payload is received and you can use the `deliveryQuoteId` in order to create a delivery. For more details on quote structure, you can see here Quote
Property
Type
Description
data.quotes
array of Quote
Arrangement of quotas available for the deliveries consulted.

Example

Request
200 Success
400 Bad Request
500 Internal Server Error
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": "[email protected]",
"phonenumber": "+5511961234567"
},
"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": "[email protected]",
"phonenumber": "+5511961234567"
},
"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": "-"
}
]
}
]
}'
{
"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"
}
]
}
}
{
message: "Bad Request",
payload: { }
}
{
message: "Error while retrieving the quote",
payload: { }
}