Delivery Information

PreviousDelivery NextUpdate Delivery

Was this helpful?

Get Delivery By Delivery Code

get

Authorizations

Path parameters

delivery-codestringRequired

Delivery Code

Query parameters

app_keystringRequired

Responses

Responseall of

get

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

{
  "success": true,
  "code": 1,
  "message": "text",
  "responses": {
    "pickup": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "text",
      "lat": 1,
      "lng": 1,
      "location": "text"
    },
    "dropoff": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "text",
      "lat": 1,
      "lng": 1,
      "location": "text"
    },
    "items": [
      {
        "itemName": "text",
        "itemQuantity": 1,
        "itemCost": 1,
        "description": "text",
        "itemWeight": 1,
        "is_fragile": true,
        "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": "text",
      "mobile_number": "text",
      "logo": "text",
      "rating": 1,
      "location": {
        "country_code": "text",
        "latitude": 1,
        "longitude": 1,
        "city": "text",
        "country": "text"
      }
    },
    "vehicle_details": {
      "brand": "text",
      "model": "text",
      "color": "text",
      "picture": "text",
      "license_plate_number": "text",
      "insurance_provider": "text"
    },
    "status": "PENDING",
    "delivery_code": "text",
    "secret_code": "text",
    "timestamp": 1,
    "full_price": {
      "discount": 1,
      "value": 1,
      "currency_code": "text",
      "currency_symbol": "text",
      "currency_name": "text"
    },
    "time_completed": 1
  }
}

Get Delivery By reference

get

Authorizations

Path parameters

referencestringRequired

Reference submitted during delivery creation

Query parameters

app_keystringRequired

Responses

Responseall of

get

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

{
  "success": true,
  "code": 1,
  "message": "text",
  "responses": {
    "pickup": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "text",
      "lat": 1,
      "lng": 1,
      "location": "text"
    },
    "dropoff": {
      "type": "text",
      "value": "text",
      "contact": {
        "name": "text",
        "mobile": "text",
        "email": "text"
      },
      "country_code": "text",
      "lat": 1,
      "lng": 1,
      "location": "text"
    },
    "items": [
      {
        "itemName": "text",
        "itemQuantity": 1,
        "itemCost": 1,
        "description": "text",
        "itemWeight": 1,
        "is_fragile": true,
        "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": 1,
      "value": 1,
      "currency_code": "text",
      "currency_symbol": "text",
      "currency_name": "text"
    },
    "time_completed": 1
  }
}

Get Bulk Delivery By reference

get

Authorizations

Path parameters

referencestringRequired

Reference submitted during delivery creation

Query parameters

app_keystringRequired

Responses

Responseall of

get

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

{
  "success": true,
  "code": 1,
  "message": "text",
  "responses": [
    {
      "pickup": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "text",
        "lat": 1,
        "lng": 1,
        "location": "text"
      },
      "dropoff": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "text",
        "lat": 1,
        "lng": 1,
        "location": "text"
      },
      "items": [
        {
          "itemName": "text",
          "itemQuantity": 1,
          "itemCost": 1,
          "description": "text",
          "itemWeight": 1,
          "is_fragile": true,
          "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": 1,
        "value": 1,
        "currency_code": "text",
        "currency_symbol": "text",
        "currency_name": "text"
      },
      "time_completed": 1
    }
  ]
}

Get deliveries

get

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

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

Responseall of

get

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

{
  "success": true,
  "code": 1,
  "message": "text",
  "responses": [
    {
      "pickup": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "text",
        "lat": 1,
        "lng": 1,
        "location": "text"
      },
      "dropoff": {
        "type": "text",
        "value": "text",
        "contact": {
          "name": "text",
          "mobile": "text",
          "email": "text"
        },
        "country_code": "text",
        "lat": 1,
        "lng": 1,
        "location": "text"
      },
      "items": [
        {
          "itemName": "text",
          "itemQuantity": 1,
          "itemCost": 1,
          "description": "text",
          "itemWeight": 1,
          "is_fragile": true,
          "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": 1,
        "value": 1,
        "currency_code": "text",
        "currency_symbol": "text",
        "currency_name": "text"
      },
      "time_completed": 1
    }
  ]
}