Overview

Utilize the potential of Swoove's API to develop robust connections with your preferred tools and services.

If there are any queries or concerns, please feel free to ask or bring them up.

API Basics

Before you begin!

You should create a free Swoove account to test the API against. We will provide you with test keys you can use to make API calls.

With the Swoove API, you can access all the features on our dashboard and expand them for use in your application. Our system is designed to be RESTful and well-organized around the primary resources you'll use, with only a few exceptions.

HTTP Methods

Post - This request creates a new resource, such as a new estimate, delivery, etc.
Get - A get request is used to retrieve data or information about a resource, such as get service zone and get delivery code.
Put -To modify a resource, like updating the status of a delivery route, a put request is employed.

You can use Postman to test through our APIs to understand how they APIs work.

Postman is an easy-to-use API development and testing platform.

Requests and Response

Both request body data and response data are formatted as JSON.

Response Format

{
  "success": boolean,  //Only true if the details provided could be processed and no error occurred while processing
  "code": number // only numbers will be returned which represent the status code
  "message": string, //Explains why success is false... Entirely informational.
  "responses": object or array //contains actionable result of processing if present
}

The content type for responses will always be application/json. Generally, all responses will be in the following format:

Keys	descriptions
success - boolean	After making a request, this will inform you whether it was successful or not. It is advisable to use this in conjunction with HTTP status codes to ascertain the outcome of an API call.
code - number	The code assists in determining the success of a request made and its resulting output.
message - string	This is a summary of the response and its status. For instance, when trying to create a list of an estimate made, a message might read “Estimate Completed.” In the event of an error, the message key will describe the error. This is the only key that is universal across requests.
responses - object or array	The response can either be an object or an array, depending on the type of request made. If you request a single delivery by reference, the response key will contain a delivery object. On the other hand, if you request a list of deliveries, the response key will contain an array of delivery objects.

Keys

descriptions

success - boolean

After making a request, this will inform you whether it was successful or not. It is advisable to use this in conjunction with HTTP status codes to ascertain the outcome of an API call.

code - number

The code assists in determining the success of a request made and its resulting output.

message - string

This is a summary of the response and its status. For instance, when trying to create a list of an estimate made, a message might read “Estimate Completed.” In the event of an error, the message key will describe the error. This is the only key that is universal across requests.

responses - object or array

The response can either be an object or an array, depending on the type of request made. If you request a single delivery by reference, the response key will contain a delivery object. On the other hand, if you request a list of deliveries, the response key will contain an array of delivery objects.

About & API Reference

About

Descriptons about swoove api

API reference

Learn more about the available endpoint in swoove open api

Authentication & Errors

Authentication

Create an API access token to authenticate your API request

Errors

Learn about API errors, how they are structured and how to handle them

NextAbout

Last updated 7 months ago