Business Delivery

Create a delivery request

post

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

/delivery/create-delivery

Create a new delivery. If a callback URL was provided, delivery status updates will be sent to that URL. See CallbackDeliveryPayload for the structure of the data sent.

Authorizations

ApiKeyAuth

app_keystringRequired

Query parameters

app_keystringRequired

Body

application/json

Delivery Request Structure

vehicle_typestringOptionalDeprecated

Type of vehicle wanted for the delivery

• MOTORCYCLE - Normal last-mile bikes

Default: MOTORCYCLE

instructionsstringOptional

Any extra notes rider should be mindful of for the delivery.

Default: null

referencestringRequired

Can be set to the id of some data in your system that needs to know about this delivery.

estimate_idstringRequired

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

Responses

200

Success Responses On Delivery Creation Request

application/json

successbooleanOptional

status of request true for success and false for failed request

Default: true

codeinteger · int32Optional

code for reason for failure

Default: 200

messagestringOptionalDefault: Estimate completed

400

Validation Error

application/json

500

Requesting Delivery Failed

post

/delivery/create-delivery

HTTPcURLJavaScriptPython

POST /delivery/create-delivery?app_key=text HTTP/1.1
Host: test.swooveapi.com
Content-Type: application/json
Accept: */*
Content-Length: 593

{
  "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"
}

{
  "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",
        "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",
    "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"
    }
  }
}

Create Bulk Delivery Request

post

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

/bulk-delivery/create-bulk-delivery

Authorizations

ApiKeyAuth

app_keystringRequired

Query parameters

app_keystringRequired

Body

application/json

Bulk Delivery Request Structure

estimate_idstringRequired

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

individual_pricing_idstringOptional

This is an optional paramater to create a delviery for only one individual pricing that is returned in a bulk estimate. Note that creating one will require all others to be created individually

Responses

200

Bulk Delivery Created

application/json

successbooleanOptional

status of request true for success and false for failed request

Default: true

codeinteger · int32Optional

code for reason for failure

Default: 200

messagestringOptionalDefault: Estimate completed

400

Validation Error

application/json

500

Getting Estimates Failed

post

/bulk-delivery/create-bulk-delivery

HTTPcURLJavaScriptPython

POST /bulk-delivery/create-bulk-delivery?app_key=text HTTP/1.1
Host: test.swooveapi.com
Content-Type: application/json
Accept: */*
Content-Length: 645

{
  "delivery_list": [
    {
      "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
          }
        }
      ],
      "contacts": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "instructions": "text",
      "reference": "text"
    }
  ],
  "estimate_id": "text",
  "individual_pricing_id": "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",
          "itemImages": [
            "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
    }
  ]
}