Sendstack APIs
  • Introduction
  • The Basics
    • Set up your account
    • Base URLs
    • Authentication
    • Postman
    • Responses and Errors
    • Webhook Verification
    • Pagination
    • Rate Limiting
    • Session
  • Guides
    • Integrated Partners
    • Manual Partners
    • Connected Partners
    • Connected Platforms
    • Payments
    • Addresses and Locations
    • Delivery Statuses
    • Order Tracking
    • Common Terminology
    • Packaging
    • Pay on Delivery
    • Roles and Permissions
      • Associates
      • Operators
      • Admins
      • Super Admins
      • Tabular presentation
    • Websockets
  • Delivery Management APIs
    • Wallet
      • Get Wallet Balance
      • Get Wallet Transactions
    • Locations
      • Get Mapped Locations
      • Get Countries
    • Estimates
      • Get Delivery Price Estimate
    • Partners
      • Get Partners
      • Get Partner
      • Update Partner Profile
      • Add Partner Off Days
      • Delete Partner Off Day
    • Packaging
    • Categories
    • Bookings
      • New Booking
      • Generate POD account number
      • Fetch Deliveries
      • Update Delivery Details
      • Update Drop Statuses
      • Cancel Drops
      • Reschedule Delivery
      • Update Delivery Window
      • Assign Drop
    • Status Tracking
      • Track Delivery Status
    • Messaging
      • Send Customer Message
      • Add Private Note
      • Update note status
    • Sample Webhook Payloads
      • New delivery
      • Updated delivery status
      • New internal note
      • New customer message
      • Pickup attempt
      • Dropoff attempt
      • Pickup window updated
      • Delivery window updated
  • Live Tracking APIs
    • Devices
      • Get Devices
    • Positions
      • Get All Positions
      • Get Device Position History
      • Stream Positions
    • Geofences
      • Create Geofence
      • Update Geofence
      • Fetch Geofences
      • Fetch Single Geofence
    • Events
      • Create Events
        • Overspeed Event
        • Low Battery Event
        • No Movement Event
        • No Signal Event
        • Geofence In Event
        • Geofence Out Event
      • Update Events
        • Overspeed Event
        • Low Battery Event
        • No Movement Event
        • No Signal Event
        • Geofence In Event
        • Geofence Out Event
      • Fetch Events
      • Fetch Single Event
    • Sample Wehook Payloads
      • Overspeed Event
      • Low Battery Event
      • No Movement Event
      • No Signal Event
      • Geofence In Event
      • Geofence Out Event
Powered by GitBook
On this page
  1. The Basics

Responses and Errors

Sendstack's API is RESTful and as such, uses conventional HTTP response codes to indicate the success or failure of requests.

NOTE: Fields marked with an asterisk (*) in the request parameter are required.

HTTP Status Code

Description

200

Request was successful and intended action was carried out.

201

A resource has successfully been created.

400

A validation or client side error occurred and the request was not fulfilled.

401

The request was not authorized. This can be triggered by passing an app_id or app_secret in the request headers or the lack of one.

404

Request could not be fulfilled as the request resource does not exist.

5xx

Request could not be fulfilled due to an error on Sendstack's end. This shouldn't happen so please report as soon as you encounter any instance of this.

Sample success response

// Successful Reponse - 200 OK
{
    "status": true,
    "message": "Partners fetched successfully",
    "data": {
        "partners": [
            {
                "type": "deliveryCompany"
            }
        ],
        "page": 1,
        "totalPages": 1,
        "totalCount": 1
    }
}

Sample Error Response

// Error Reponse - 401 unauthorized
{
    "status": false,
    "message": "Invalid app_id or app_secret"
}
PreviousPostmanNextWebhook Verification

Last updated 1 year ago