API Documentation

All API endpoints require authentication. You must use the X-API-TOKEN header, set to your API token.

A good place to start is the Team Information endpoint, to verify that you can authenticate to the API correctly.

Send a GET request to https://deliversmartly.com/api/v1/team

The response will be something like this:

{
  "timezone": "Pacific\/Auckland",
  "name": "Mobilenet",
  "address": "56 Waiwarawara Drive, Ruakaka, Whangarei, New Zealand"
}

Send a POST request to https://deliversmartly.com/api/v1/task

You can include the following information:

• address required the pickup/delivery address
• contact name of the contact person
• phone phone number for the contact person
• title your identifier for the task

The 200 response will have this structure:

{
  "address": "56 Waiwarawara Drive, Ruakaka, Whangarei 0171, New Zealand",
  "contact": "DeliverSmartly HQ",
  "phone": "+6497770063",
  "title": "Online Order #42",
  "id": 45611,
}

The 400 response will have this structure:

{
  "error": "Address field is required"
}