Delivery

The POST API is used to create new resources, the GET API is used to retrieve existing resources, the DELETE API is used to remove resources, and the UPDATE API is used to modify existing resources.

Create Delivery Request

POSThttps://test.swooveapi.com/bulk-delivery/create-bulk-delivery

Authorization

ApiKeyAuth

Query parameters

Body

application/json

Bulk Delivery Request Body Sample and Schema

delivery_listarray of all of

estimate_idstring

The estimate id of the selected estimate that was returned during the create delivery estimate request

Response

200400500

Bulk Delivery Created

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

responsesBulkDeliveryResponses (array of all of)

Bulk Delivery(s) Details

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/bulk-delivery/create-bulk-delivery', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Estimate completed",
  "responses": [
    {
      "pickup": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "GH",
        "lat": 0,
        "lng": 0,
        "location": "text"
      },
      "dropoff": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "GH",
        "lat": 0,
        "lng": 0,
        "location": "text"
      },
      "items": [
        {
          "itemName": "text",
          "itemQuantity": 0,
          "itemCost": 0,
          "description": "text",
          "itemWeight": 0,
          "is_fragile": false,
          "dimensions": {
            "x": 0,
            "y": 0,
            "z": 0
          }
        }
      ],
      "contacts": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "status": "AGENCY_ASSIGNED",
      "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"
    }
  ]
}

Get Delivery By Delivery Code

GEThttps://test.swooveapi.com/delivery/get-delivery/{delivery-code}

Authorization

ApiKeyAuth

Path parameters

delivery-code*string

Delivery Code

Query parameters

Response

200404500

Delivery Found

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

messagestring

responsesall of

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/delivery/get-delivery/{delivery-code}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Delivery Found",
  "responses": {
    "pickup": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "GH",
      "lat": 0,
      "lng": 0,
      "location": "text"
    },
    "dropoff": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "GH",
      "lat": 0,
      "lng": 0,
      "location": "text"
    },
    "items": [
      {
        "itemName": "text",
        "itemQuantity": 0,
        "itemCost": 0,
        "description": "text",
        "itemWeight": 0,
        "is_fragile": false,
        "dimensions": {
          "x": 0,
          "y": 0,
          "z": 0
        }
      }
    ],
    "contact": {
      "name": "text",
      "mobile": "text",
      "email": "text"
    },
    "instructions": "text",
    "reference": "text",
    "estimate_id": "text",
    "agent_details": {
      "agent_first_name": "text",
      "agent_last_name": "text",
      "agent_mobile": "text",
      "agent_picture": "text",
      "license_type": "text",
      "license_number": "text",
      "license_expiry": 0
    },
    "agency_details": {
      "name": "Agency Name",
      "mobile_number": 23350484565,
      "logo": "text",
      "rating": 0,
      "location": {
        "country_code": "GH",
        "latitude": 0,
        "longitude": 0,
        "city": "text",
        "country": "text"
      }
    },
    "vehicle_details": {
      "brand": "text",
      "model": "text",
      "color": "text",
      "picture": "text",
      "license_plate_number": "text",
      "insurance_provider": "text"
    },
    "status": "AGENCY_ASSIGNED",
    "delivery_code": "text",
    "secret_code": "text",
    "timestamp": 0,
    "full_price": {
      "discount": 0,
      "value": 0,
      "currency_code": "GHS",
      "currency_symbol": "₵",
      "currency_name": "Ghanaian cedi"
    }
  }
}

Get Delivery By reference

GEThttps://test.swooveapi.com/delivery/single/get-by-reference/{reference}

Authorization

ApiKeyAuth

Path parameters

reference*string

Reference submitted during delivery creation

Query parameters

Response

200400500

Delivery Found

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

messagestring

responsesDeliveryResponses (all of)

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/delivery/single/get-by-reference/{reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Delivery Found",
  "responses": {
    "pickup": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "GH",
      "lat": 0,
      "lng": 0,
      "location": "text"
    },
    "dropoff": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "GH",
      "lat": 0,
      "lng": 0,
      "location": "text"
    },
    "items": [
      {
        "itemName": "text",
        "itemQuantity": 0,
        "itemCost": 0,
        "description": "text",
        "itemWeight": 0,
        "is_fragile": false,
        "dimensions": {
          "x": 0,
          "y": 0,
          "z": 0
        }
      }
    ],
    "instructions": "text",
    "reference": "text",
    "status": "text",
    "delivery_code": "text",
    "secret_code": "text",
    "end_time": 0,
    "full_price": {
      "discount": 0,
      "value": 0,
      "currency_code": "GHS",
      "currency_symbol": "₵",
      "currency_name": "Ghanaian cedi"
    }
  }
}

Get Bulk Delivery By reference

GEThttps://test.swooveapi.com/delivery/bulk/get-by-reference/{reference}

Authorization

ApiKeyAuth

Path parameters

reference*string

Reference submitted during delivery creation

Query parameters

Response

200404500

Delivery Found

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

messagestring

responsesarray of DeliveryResponses (all of)

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/delivery/bulk/get-by-reference/{reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Delivery Found",
  "responses": [
    {
      "pickup": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "GH",
        "lat": 0,
        "lng": 0,
        "location": "text"
      },
      "dropoff": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "GH",
        "lat": 0,
        "lng": 0,
        "location": "text"
      },
      "items": [
        {
          "itemName": "text",
          "itemQuantity": 0,
          "itemCost": 0,
          "description": "text",
          "itemWeight": 0,
          "is_fragile": false,
          "dimensions": {
            "x": 0,
            "y": 0,
            "z": 0
          }
        }
      ],
      "instructions": "text",
      "reference": "text",
      "status": "text",
      "delivery_code": "text",
      "secret_code": "text",
      "end_time": 0,
      "full_price": {
        "discount": 0,
        "value": 0,
        "currency_code": "GHS",
        "currency_symbol": "₵",
        "currency_name": "Ghanaian cedi"
      }
    }
  ]
}

Cancel a delivery

NB: Only deliveries that are not running can be canncelled. That is deliveries with status PENDING,AGENCY_ASSIGNED,REASSIGNED and PICKUP

PUThttps://test.swooveapi.com/delivery/cancel-delivery

Authorization

ApiKeyAuth

Query parameters

Response

200400500

Delivery Cancelled

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

messagestring

responsesDeliveryResponses (all of)

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/delivery/cancel-delivery', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true,
  "message": "Delivery Cancelled",
  "responses": {
    "pickup": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "GH",
      "lat": 0,
      "lng": 0,
      "location": "text"
    },
    "dropoff": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "GH",
      "lat": 0,
      "lng": 0,
      "location": "text"
    },
    "items": [
      {
        "itemName": "text",
        "itemQuantity": 0,
        "itemCost": 0,
        "description": "text",
        "itemWeight": 0,
        "is_fragile": false,
        "dimensions": {
          "x": 0,
          "y": 0,
          "z": 0
        }
      }
    ],
    "instructions": "text",
    "reference": "text",
    "status": "text",
    "delivery_code": "text",
    "secret_code": "text",
    "end_time": 0,
    "full_price": {
      "discount": 0,
      "value": 0,
      "currency_code": "GHS",
      "currency_symbol": "₵",
      "currency_name": "Ghanaian cedi"
    }
  }
}

Simulate a delivery action in test enviroment only.

Note that the actions need to be triggered in this order

1. ASSIGNED
2. PICKUP
3. PICKEDUP
4. DROPOFF
5. DROPEDOFF
6. ENDED

POSThttps://test.swooveapi.com/delivery/simulate-action

Query parameters

Body

application/json

Simulate Action For Deliveries

delivery_code*string

simulate_status*enum

ASSIGNEDPICKUPPICKEDUPDROPOFFDROPEDOFFENDED

secret_code*string

delivery secret code to be used in triggering ENDED status

Response

200400500

Success Responses On Delivery Simulation

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

messagestring

Deliveries assigned to agent, trip created

responsesstring

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/delivery/simulate-action', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "delivery_code": "The delivery code from the delivery that you want to simulate the action for. The delivery should already be created for this to happen",
      "simulate_status": "ASSIGNED",
      "secret_code": "text"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "message": "text",
  "responses": "text"
}