Agency Delivery
This endpoint is used by the agency to create a bulk delivery request internally from one locaton, mostly the agency/warehouse location to multiple drop off locations. It is not meant for external use.
Authorizations
Body
Request body schema for agencies to bulk create deliveries
sender_namestringRequired
sender_numberstringRequired
sender_emailstringRequired
delivery_datenumberRequired
Responses
200
Bulk Delivery Created
application/json
Responseall of
400
Validation Error
application/json
401
Unauthorized
500
Getting Estimates Failed
post
POST /agency/delivery/create-multiple-dropoffs HTTP/1.1
Host: test.swooveapi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 636
{
"sender_name": "text",
"sender_number": "text",
"sender_email": "text",
"delivery_date": 1,
"sender_location": {
"lat": 1,
"lng": 1,
"location": "text",
"country_code": "text"
},
"deliveries": [
{
"delivery_name": "text",
"delivery_number": "text",
"delivery_email": "text",
"delivery_date": 1,
"delivery_fee": "text",
"discount": "text",
"payment_method": "text",
"order_number": "text",
"package_size": "text",
"package_value": "text",
"instructions": "text",
"is_paid": true,
"assigned_agent_id": "text",
"mark_as_paid": true,
"delivery_location": {
"lat": 1,
"lng": 1,
"location": "text",
"country_code": "text"
},
"items": [
{
"item_name": "text",
"item_quantity": "text",
"item_weight": "text"
}
]
}
]
}{
"success": true,
"code": 200,
"message": "Estimate completed",
"responses": [
{
"pickup": {
"type": "text",
"value": "text",
"contact": {
"name": "text",
"mobile": "text",
"email": "text"
},
"country_code": "GH",
"lat": 1,
"lng": 1,
"location": "text"
},
"dropoff": {
"type": "text",
"value": "text",
"contact": {
"name": "text",
"mobile": "text",
"email": "text"
},
"country_code": "GH",
"lat": 1,
"lng": 1,
"location": "text"
},
"items": [
{
"itemName": "text",
"itemQuantity": 1,
"itemCost": 1,
"description": "text",
"itemWeight": 1,
"is_fragile": false,
"dimensions": {
"x": 1,
"y": 1,
"z": 1
}
}
],
"contacts": {
"name": "text",
"mobile": "text",
"email": "text"
},
"status": "PENDING",
"delivery_code": "text",
"secret_code": "text",
"instructions": "text",
"reference": "text",
"full_price": {
"discount": 0,
"value": 0,
"currency_code": "GHS",
"currency_symbol": "₵",
"currency_name": "Ghanaian cedi"
},
"waybill_link": "text",
"tracking_link": "text",
"time_completed": 1
}
]
}Create multiple deliveries with both pickup and dropoff info (used by agency)
Authorizations
Body
delivery_dateinteger · int64Required
Responses
200
Bulk deliveries created successfully
application/json
Responseall of
400
Validation Error
application/json
401
Unauthorized
500
Something went wrong
post
POST /agency/delivery/create-multi-route HTTP/1.1
Host: test.swooveapi.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 612
{
"delivery_date": 1,
"deliveries": [
{
"pickup": {
"type": "text",
"value": "text",
"contact": {
"name": "text",
"mobile": "text",
"email": "text"
},
"country_code": "GH",
"lat": 1,
"lng": 1,
"location": "text"
},
"dropoff": {
"type": "text",
"value": "text",
"contact": {
"name": "text",
"mobile": "text",
"email": "text"
},
"country_code": "GH",
"lat": 1,
"lng": 1,
"location": "text"
},
"items": [
{
"item_name": "text",
"item_quantity": 1,
"item_weight": "text"
}
],
"order_number": "text",
"delivery_fee": 1,
"discount": 1,
"payment_method": "text",
"package_value": 1,
"package_size": "text",
"assigned_agent_id": "text",
"mark_as_paid": true,
"instructions": "text",
"delivery_date": 1
}
]
}{
"success": true,
"code": 200,
"message": "Estimate completed",
"responses": [
{
"pickup": {
"type": "text",
"value": "text",
"contact": {
"name": "text",
"mobile": "text",
"email": "text"
},
"country_code": "GH",
"lat": 1,
"lng": 1,
"location": "text"
},
"dropoff": {
"type": "text",
"value": "text",
"contact": {
"name": "text",
"mobile": "text",
"email": "text"
},
"country_code": "GH",
"lat": 1,
"lng": 1,
"location": "text"
},
"items": [
{
"itemName": "text",
"itemQuantity": 1,
"itemCost": 1,
"description": "text",
"itemWeight": 1,
"is_fragile": false,
"dimensions": {
"x": 1,
"y": 1,
"z": 1
}
}
],
"contacts": {
"name": "text",
"mobile": "text",
"email": "text"
},
"status": "PENDING",
"delivery_code": "text",
"secret_code": "text",
"instructions": "text",
"reference": "text",
"full_price": {
"discount": 0,
"value": 0,
"currency_code": "GHS",
"currency_symbol": "₵",
"currency_name": "Ghanaian cedi"
},
"waybill_link": "text",
"tracking_link": "text",
"time_completed": 1
}
]
}Was this helpful?