This API endpoint allows you to calculate the price for delivering items from a pickup center to one or more destinations.
pickup_origin
(object)
state_code
(string, optional): The state code of the pickup origin.
country_code
(string, optional): The country code of the pickup origin.
centre_code
(string): The code of the pickup center.
address
(string, optional): The address of the pickup origin.
destinations
(array)
country_code
(string): The country code of the destination.
state_code
(string): The state code of the destination.
city
(string, optional): The city of the destination.
region
(object)
latitude
(number): The latitude of the destination.
longitude
(number): The longitude of the destination.
item_weight
(number): The weight of the item to be delivered.
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"pickup_origin": {
"type": "object",
"properties": {
"state_code": { "type": ["string", "null"] },
"country_code": { "type": ["string", "null"] },
"centre_code": { "type": "string" },
"address": { "type": ["string", "null"] },
"pickup_centre": {
"type": "object",
"properties": {
"centre_code": { "type": "string" },
"centre_name": { "type": "string" }
}
}
}
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country_code": { "type": "string" },
"state_code": { "type": "string" },
"city": { "type": ["string", "null"] },
"region": {
"type": "object",
"properties": {
"latitude": { "type": "number" },
"longitude": { "type": "number" }
}
},
"item_weight": { "type": "number" },
"dropoff_centre": {
"type": "object",
"properties": {
"centre_code": { "type": "string" },
"centre_name": { "type": "string" }
}
},
"price": {
"type": "object",
"properties": {
"amount": { "type": "number" },
"discount_amount": { "type": "number" },
"amount_payable": { "type": "number" },
"discount_type": { "type": "string" },
"discount_description": { "type": "string" },
"distance": { "type": "string" },
"duration": { "type": "string" },
"weight": { "type": "string" }
}
}
}
}
},
"total_amount": { "type": "number" },
"total_discount_amount": { "type": "number" },
"total_amount_payable": { "type": "number" },
"discount_type": { "type": "string" },
"discount_description": { "type": "string" }
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
"no-cache"
"<calculated when request is sent>"
"<calculated when request is sent>"
"<calculated when request is sent>"
"PostmanRuntime/7.39.1"
"gzip, deflate, br"
"keep-alive"
success
The response is of type object
.
This API endpoint allows you to calculate the price for delivering items from a pickup center to one or more destinations.
pickup_origin
(object)
state_code
(string, optional): The state code of the pickup origin.
country_code
(string, optional): The country code of the pickup origin.
centre_code
(string): The code of the pickup center.
address
(string, optional): The address of the pickup origin.
destinations
(array)
country_code
(string): The country code of the destination.
state_code
(string): The state code of the destination.
city
(string, optional): The city of the destination.
region
(object)
latitude
(number): The latitude of the destination.
longitude
(number): The longitude of the destination.
item_weight
(number): The weight of the item to be delivered.
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"pickup_origin": {
"type": "object",
"properties": {
"state_code": { "type": ["string", "null"] },
"country_code": { "type": ["string", "null"] },
"centre_code": { "type": "string" },
"address": { "type": ["string", "null"] },
"pickup_centre": {
"type": "object",
"properties": {
"centre_code": { "type": "string" },
"centre_name": { "type": "string" }
}
}
}
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country_code": { "type": "string" },
"state_code": { "type": "string" },
"city": { "type": ["string", "null"] },
"region": {
"type": "object",
"properties": {
"latitude": { "type": "number" },
"longitude": { "type": "number" }
}
},
"item_weight": { "type": "number" },
"dropoff_centre": {
"type": "object",
"properties": {
"centre_code": { "type": "string" },
"centre_name": { "type": "string" }
}
},
"price": {
"type": "object",
"properties": {
"amount": { "type": "number" },
"discount_amount": { "type": "number" },
"amount_payable": { "type": "number" },
"discount_type": { "type": "string" },
"discount_description": { "type": "string" },
"distance": { "type": "string" },
"duration": { "type": "string" },
"weight": { "type": "string" }
}
}
}
}
},
"total_amount": { "type": "number" },
"total_discount_amount": { "type": "number" },
"total_amount_payable": { "type": "number" },
"discount_type": { "type": "string" },
"discount_description": { "type": "string" }
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
"no-cache"
"<calculated when request is sent>"
"<calculated when request is sent>"
"<calculated when request is sent>"
"PostmanRuntime/7.39.1"
"gzip, deflate, br"
"keep-alive"
success
The response is of type object
.