Door - Centre
Home Pickup to Cenntre (Hub)
The endpoint is used to calculate the price for delivering items from a pickup origin (home pickup) to one or more destinations, with a specific centre for the destination.
Request Payload
-
pickup_origin
(object): Contains the details of the pickup origin including the country code, state code, city, and region coordinates.-
country_code
(string): The country code of the pickup origin. -
state_code
(string): The state code of the pickup origin. -
city
(string): The city of the pickup origin. -
region
(object): The coordinates of the pickup origin region.-
latitude
(number): The latitude of the pickup origin. -
longitude
(number): The longitude of the pickup origin.
-
-
-
destinations
(array): Contains an array of destination details.-
state_code
(string): The state code of the destination. -
country_code
(string): The country code of the destination. -
centre_code
(string): The code of the destination centre. -
addresss
(string): The address of the destination. -
item_weight
(number): The weight of the item to be delivered to the destination.
-
Response
The response for this request can be represented as a JSON schema:
{
"type": "object",
"properties": {
"status": { "type": "boolean" },
"message": { "type": "string" },
"data": {
"type": "object",
"properties": {
"pickup_origin": {
"type": "object",
"properties": {
"country_code": { "type": "string" },
"state_code": { "type": "string" },
"city": { "type": "string" },
"region": {
"type": "object",
"properties": {
"latitude": { "type": "number" },
"longitude": { "type": "number" }
}
},
"pickup_centre": {
"type": "object",
"properties": {
"centre_code": { "type": "string" },
"centre_name": { "type": "string" }
}
}
}
},
"destinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"state_code": { "type": "string" },
"country_code": { "type": "string" },
"centre_code": { "type": "string" },
"addresss": { "type": "string" },
"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" }
}
}
}
}
This JSON schema represents the structure of the response data returned by the API endpoint.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
"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"
Body
Response
success
The response is of type object
.