Business Delivery Information

Get Delivery By Delivery Code

get

https://test.swooveapi.comhttps://live.swooveapi.com

/delivery/get-delivery/{delivery-code}

Authorizations

ApiKeyAuth

app_keystringRequired

Path parameters

delivery-codestringRequired

Delivery Code

Query parameters

app_keystringRequired

Responses

200

Delivery Found

application/json

Responseall of

404

Delivery not found

500

Get Delivery Failed

get

/delivery/get-delivery/{delivery-code}

HTTPcURLJavaScriptPython

GET /delivery/get-delivery/{delivery-code}?app_key=text HTTP/1.1
Host: test.swooveapi.com
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Delivery Found",
  "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",
        "itemImages": [
          "text"
        ],
        "itemWeight": 1,
        "is_fragile": false,
        "dimensions": {
          "x": 1,
          "y": 1,
          "z": 1
        }
      }
    ],
    "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": 1
    },
    "agency_details": {
      "name": "Agency Name",
      "mobile_number": 23350484565,
      "logo": "text",
      "rating": 1,
      "location": {
        "country_code": "GH",
        "latitude": 0,
        "longitude": 0,
        "city": "text",
        "country": "text"
      }
    },
    "vehicle_details": {
      "_id": "67c849c22096cfb0aae13cdf",
      "assigned_agent_id": "text",
      "brand": "FORD",
      "model": "FOCUS gps",
      "color": "#edb6b6",
      "picture": "https://example.com",
      "vehicle_type": "CAR",
      "license_plate_number": "GT-1234-2025",
      "latest_location": {
        "latitude": 1,
        "longitude": 1,
        "coordinates": [
          -0.342392,
          5.549658
        ],
        "time": 1,
        "location": "WEIJA GBAWE MUNICIPAL, GREATER ACCRA",
        "state": "STOPPED",
        "direction": 204,
        "speed": 0
      }
    },
    "status": "AGENCY_ASSIGNED",
    "delivery_code": "text",
    "secret_code": "text",
    "timestamp": 1,
    "full_price": {
      "discount": 0,
      "value": 0,
      "currency_code": "GHS",
      "currency_symbol": "₵",
      "currency_name": "Ghanaian cedi"
    },
    "time_completed": 1
  }
}

Get Delivery By reference

get

https://test.swooveapi.comhttps://live.swooveapi.com

/delivery/single/get-by-reference/{reference}

Authorizations

ApiKeyAuth

app_keystringRequired

Path parameters

referencestringRequired

Reference submitted during delivery creation

Query parameters

app_keystringRequired

Responses

200

Delivery Found

application/json

Responseall of

400

Delivery not found

500

Get Delivery Failed

get

/delivery/single/get-by-reference/{reference}

HTTPcURLJavaScriptPython

GET /delivery/single/get-by-reference/{reference}?app_key=text HTTP/1.1
Host: test.swooveapi.com
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Delivery Found",
  "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",
        "itemImages": [
          "text"
        ],
        "itemWeight": 1,
        "is_fragile": false,
        "dimensions": {
          "x": 1,
          "y": 1,
          "z": 1
        }
      }
    ],
    "instructions": "text",
    "reference": "text",
    "status": "PENDING",
    "delivery_code": "text",
    "secret_code": "text",
    "end_time": 1,
    "full_price": {
      "discount": 0,
      "value": 0,
      "currency_code": "GHS",
      "currency_symbol": "₵",
      "currency_name": "Ghanaian cedi"
    },
    "time_completed": 1
  }
}

Get Delivery Timeline By Delivery Code

get

https://test.swooveapi.comhttps://live.swooveapi.com

/delivery/get-delivery-timeline/{delivery-code}

Authorizations

ApiKeyAuth

app_keystringRequired

Path parameters

delivery-codestringRequired

Delivery Code

Query parameters

app_keystringRequired

Responses

200

Delivery Timeline Found

application/json

Responseall of

404

Delivery Timeline not found

500

Get Delivery Timeline Failed

get

/delivery/get-delivery-timeline/{delivery-code}

HTTPcURLJavaScriptPython

GET /delivery/get-delivery-timeline/{delivery-code}?app_key=text HTTP/1.1
Host: test.swooveapi.com
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Delivery Found",
  "responses": {
    "0": {
      "_id": "text",
      "delivery_id": "text",
      "trip_id": "text",
      "agent_id": "text",
      "agency_id": "text",
      "status": "PENDING",
      "action": "text",
      "type": "PRIMARY",
      "timestamp": 1,
      "trip_details": {
        "_id": "text",
        "type": "SHARED",
        "trip_code": "text",
        "name": "text"
      },
      "agency_details": {
        "_id": "text",
        "name": "text"
      },
      "agent_details": {
        "_id": "text",
        "agent_first_name": "text",
        "agent_last_name": "text",
        "agent_mobile": "text"
      }
    }
  }
}

Get Bulk Delivery By reference

get

https://test.swooveapi.comhttps://live.swooveapi.com

/delivery/bulk/get-by-reference/{reference}

Authorizations

ApiKeyAuth

app_keystringRequired

Path parameters

referencestringRequired

Reference submitted during delivery creation

Query parameters

app_keystringRequired

Responses

200

Delivery Found

application/json

Responseall of

404

Delivery not found

500

Get Delivery Failed

get

/delivery/bulk/get-by-reference/{reference}

HTTPcURLJavaScriptPython

GET /delivery/bulk/get-by-reference/{reference}?app_key=text HTTP/1.1
Host: test.swooveapi.com
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Delivery Found",
  "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",
          "itemImages": [
            "text"
          ],
          "itemWeight": 1,
          "is_fragile": false,
          "dimensions": {
            "x": 1,
            "y": 1,
            "z": 1
          }
        }
      ],
      "instructions": "text",
      "reference": "text",
      "status": "PENDING",
      "delivery_code": "text",
      "secret_code": "text",
      "end_time": 1,
      "full_price": {
        "discount": 0,
        "value": 0,
        "currency_code": "GHS",
        "currency_symbol": "₵",
        "currency_name": "Ghanaian cedi"
      },
      "time_completed": 1
    }
  ]
}

Get deliveries

get

https://test.swooveapi.comhttps://live.swooveapi.com

/delivery/get-deliveries

This api allows you to fetch deliveries created by your api key. This route is paginated and defaults to 10 per page startiong from 0. It also allows a from and to date filter

Authorizations

ApiKeyAuth

app_keystringRequired

Query parameters

app_keystringRequired

pagenumbernumberOptional

This is the page number for the deliveries returned. It starts and defaults to 0

Default: 0

limitsnumber · min: 1Optional

This is the number of deliveries to return. It defaults to 10

Default: 10

from_datenumberOptional

This is used to add the start date when fetching the delivery data. The from_date value should be the date and time in milliseconds.

Default: 0

to_datenumberOptional

This is used to add the end date when fetching the delivery data. The to_date value should be the date and time in milliseconds.

Default: 0

statusstring · enumOptional

This is used to filter the deliveries returned by status. By default all deliveries are returned

Possible values:

Responses

200

Delivery Found

application/json

Responseall of

404

Delivery not found

500

Get Delivery Failed

get

/delivery/get-deliveries

HTTPcURLJavaScriptPython

GET /delivery/get-deliveries?app_key=text HTTP/1.1
Host: test.swooveapi.com
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Delivery Found",
  "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",
          "itemImages": [
            "text"
          ],
          "itemWeight": 1,
          "is_fragile": false,
          "dimensions": {
            "x": 1,
            "y": 1,
            "z": 1
          }
        }
      ],
      "instructions": "text",
      "reference": "text",
      "status": "PENDING",
      "delivery_code": "text",
      "secret_code": "text",
      "end_time": 1,
      "full_price": {
        "discount": 0,
        "value": 0,
        "currency_code": "GHS",
        "currency_symbol": "₵",
        "currency_name": "Ghanaian cedi"
      },
      "time_completed": 1
    }
  ]
}