Business Estimates

Check Delivery Estimate

post

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

/estimates/create-estimate

Authorizations

ApiKeyAuth

app_keystringRequired

Query parameters

app_keystringRequired

Body

application/json

Delivery Estimate Request Structure

vehicle_typestringOptionalDeprecated

Type of vehicle wanted for the delivery

• MOTORCYCLE - Normal last-mile bikes

Default: MOTORCYCLE

Responses

200

Delivery Estimates Found

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

/estimates/create-estimate

HTTPcURLJavaScriptPython

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

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

{
  "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
        }
      }
    ],
    "timestamp": 1,
    "optimal_estimate": {
      "estimate_id": "text",
      "selected_estimate_link": "text",
      "estimate_type_details": {
        "name": "Today",
        "icon": "text"
      },
      "discount": 0,
      "currency_code": "GHS",
      "currency_symbol": "₵",
      "currency_name": "Ghanaian cedi",
      "full_price": 1,
      "time_string": "text",
      "end_time": 1
    },
    "estimates": [
      {
        "estimate_id": "text",
        "selected_estimate_link": "text",
        "estimate_type_details": {
          "name": "Today",
          "icon": "text"
        },
        "discount": 0,
        "currency_code": "GHS",
        "currency_symbol": "₵",
        "currency_name": "Ghanaian cedi",
        "full_price": 1,
        "time_string": "text",
        "end_time": 1
      }
    ]
  }
}

Check Estimate for a bulk delivery that is multiple pick up and drop offs

post

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

/bulk-estimate/create-bulk-estimate

Authorizations

ApiKeyAuth

app_keystringRequired

Query parameters

app_keystringRequired

Body

application/json

Bulk Delivery Estimate Structure

Responses

200

Delivery Estimates Found

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-estimate/create-bulk-estimate

HTTPcURLJavaScriptPython

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

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

{
  "success": true,
  "code": 200,
  "message": "Estimate completed",
  "responses": {
    "optimal_estimate": {
      "estimate_type_details": {
        "name": "Today",
        "icon": "text"
      },
      "total_pricing": {
        "discount": 0,
        "value": 0,
        "currency_code": "GHS",
        "currency_symbol": "₵",
        "currency_name": "Ghanaian cedi"
      },
      "time_string": "Pickup and Delivery Tomorrow (8:00am - 04:00pm)",
      "estimate_id": "text",
      "selected_estimate_link": "text",
      "individual_pricing": [
        {
          "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
              }
            }
          ],
          "price_details": {
            "discount": 0,
            "value": 0,
            "currency_code": "GHS",
            "currency_symbol": "₵",
            "currency_name": "Ghanaian cedi"
          },
          "_id": "text"
        }
      ]
    },
    "estimates": [
      {
        "estimate_type_details": {
          "name": "Today",
          "icon": "text"
        },
        "total_pricing": {
          "discount": 0,
          "value": 0,
          "currency_code": "GHS",
          "currency_symbol": "₵",
          "currency_name": "Ghanaian cedi"
        },
        "time_string": "Pickup and Delivery Tomorrow (8:00am - 04:00pm)",
        "estimate_id": "text",
        "selected_estimate_link": "text",
        "individual_pricing": [
          {
            "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
                }
              }
            ],
            "price_details": {
              "discount": 0,
              "value": 0,
              "currency_code": "GHS",
              "currency_symbol": "₵",
              "currency_name": "Ghanaian cedi"
            },
            "_id": "text"
          }
        ]
      }
    ]
  }
}