Estimates

Create estimates for a delivery

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

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

Authorization

ApiKeyAuth

Query parameters

Body

application/json

Bulk Delivery Estimate Body Sample And Schema

delivery_list*array of Estimate (object)

Array of deliveries to create an estimate for

Response

200400500

Delivery Estimates Found

Body

application/json

successboolean

status of request true for success and false for failed request

codeinteger (int32)

code for reason for failure

messagestring

responsesall of

Request

JavaScriptCurl

const response = await fetch('https://test.swooveapi.com/bulk-estimate/create-bulk-estimate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "delivery_list": [
        {
          "pickup": {
            "type": "text",
            "contact": {
              "mobile": "text"
            },
            "country_code": "GH"
          },
          "dropoff": {
            "type": "text",
            "contact": {
              "mobile": "text"
            },
            "country_code": "GH"
          }
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "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": 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
              }
            }
          ],
          "price_details": {
            "discount": 0,
            "value": 0,
            "currency_code": "GHS",
            "currency_symbol": "₵",
            "currency_name": "Ghanaian cedi"
          }
        }
      ]
    },
    "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": 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
                }
              }
            ],
            "price_details": {
              "discount": 0,
              "value": 0,
              "currency_code": "GHS",
              "currency_symbol": "₵",
              "currency_name": "Ghanaian cedi"
            }
          }
        ]
      }
    ]
  }
}