Delivery API | SHiiP
  • Home
  • The Guide
  • Getting Started
    • Authentication
    • Request Format & Responses
    • Errors & Status Codes
    • Rate Limits
    • Wallet Funding
    • Webhook
  • API references
    • Get User Profile
    • International HsCode
    • Get Shipment Rates
    • Get Single Rate
    • Get Available Couriers
    • Book Shipment
    • Assign Shipment
    • Get All Shipments
    • Cancel Shipment
    • Track Shipment
  • Extras
    • Promotions & Discount
Powered by GitBook
On this page
  • Request Sample
  • Response Sample
  1. API references

Get All Shipments

This is used to get all shipments booked with us.

This endpoint retrieves all booked orders, returning results in a paginated format. It accepts an optional status parameter to filter shipments based on their current status. Available status filters include pending, in progress, picked up, and delivered.

Request Sample

curl --location 'https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?status=pending' \
--header 'Authorization: Bearer Secret Key'
import requests

url = "https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?status=pending"

payload = {}
headers = {
  'Authorization': 'Bearer Secret Key'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
require "uri"
require "net/http"

url = URI("https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?status=pending")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer Secret Key"

response = https.request(request)
puts response.read_body
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?status=pending',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer Secret Key'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer Secret Key");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?status=pending", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?status=pending"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer Secret Key")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Response Sample

{
    "status": false,
    "message": "Invalid route or endpoint not found",
    "status_code": 404
}
{
    "data": {
        "total_order": 18,
        "order": {
            "current_page": 1,
            "data": [
                {
                    "id": 21749,
                    "reference": "72d4iejm4lg0",
                    "user_id": 96,
                    "carrier": "Dellyman",
                    "shipment_type": "intrastate",
                    "amount": "2473",
                    "dropoff_address": "Lekki phase 1, Lekki, Nigeria",
                    "pickup_address": "Victoria island, Lagos, Nigeria",
                    "statusBreakdown": null,
                    "status": "pending",
                    "current_location": "processing",
                    "items": [
                        {
                            "name": "item 1",
                            "description": "item 1",
                            "weight": "506.0",
                            "category": "beauty",
                            "amount": "46000000.0",
                            "quantity": "23"
                        }
                    ],
                    "created_at": "2024-09-17T13:32:02.000000Z",
                    "updated_at": "2024-09-17T13:32:02.000000Z",
                    "processor": "Dellyman",
                    "assigned_by": null,
                    "assigned_on": null,
                    "platform": "WEB",
                    "platform_ref": null,
                    "isCancelled": 0,
                    "actual_amount": "0",
                    "deliveryDate": "-",
                    "image": null,
                    "podAmount": "0.00",
                    "podStatus": "pending",
                    "eta_in_days": 5,
                    "podCourierId": 0,
                    "podRiderId": null,
                    "userReadyForShipping": 0,
                    "promotion": null,
                    "rated": 0,
                    "rating": "0.00",
                    "delivery_note": null,
                    "currency": "NGN",
                    "senderPhoneNumber": "8131628736",
                    "weight": {
                        "id": 1,
                        "weight": "0.5"
                    },
                    "logo": "https://delivery-staging.apiideraos.com/partners/shiip.png",
                    "numberOfDaysToDeliver": 0,
                    "estimated_days_of_delivery": "-",
                    "formatted_delivery_date": "-",
                    "how_many_days_left": "-",
                    "pod_payment_link": null,
                    "pod_amount_total": null,
                    "carrier_info": {
                        "name": "Dellyman",
                        "email": "support@dellyman.com",
                        "phone": "23470033559626",
                        "logo": null
                    },
                    "tracking_link": "https://shiip-landing-new.netlify.app/shipment/track/?reference=72d4iejm4lg0",
                    "company": null
                },
                {
                    "id": 21748,
                    "reference": "7q4ms8job720",
                    "user_id": 96,
                    "carrier": "Dane",
                    "shipment_type": "intrastate",
                    "amount": "3227",
                    "dropoff_address": "Lekki phase 1, Lekki, Nigeria",
                    "pickup_address": "Victoria island, Lagos, Nigeria",
                    "statusBreakdown": null,
                    "status": "pending",
                    "current_location": "processing",
                    "items": [
                        {
                            "name": "item 1",
                            "description": "item 1",
                            "weight": "506.0",
                            "category": "beauty",
                            "amount": "46000000.0",
                            "quantity": "23"
                        }
                    ],
                    "created_at": "2024-09-17T13:29:38.000000Z",
                    "updated_at": "2024-09-17T13:29:38.000000Z",
                    "processor": "Dane",
                    "assigned_by": null,
                    "assigned_on": null,
                    "platform": "WEB",
                    "platform_ref": null,
                    "isCancelled": 0,
                    "actual_amount": "0",
                    "deliveryDate": "-",
                    "image": null,
                    "podAmount": "0.00",
                    "podStatus": "pending",
                    "eta_in_days": 1,
                    "podCourierId": 0,
                    "podRiderId": null,
                    "userReadyForShipping": 0,
                    "promotion": null,
                    "rated": 0,
                    "rating": "0.00",
                    "delivery_note": null,
                    "currency": "NGN",
                    "senderPhoneNumber": "8131628736",
                    "weight": {
                        "id": 1,
                        "weight": "0.5"
                    },
                    "logo": "https://delivery-staging.apiideraos.com/partners/shiip.png",
                    "numberOfDaysToDeliver": 0,
                    "estimated_days_of_delivery": "-",
                    "formatted_delivery_date": "-",
                    "how_many_days_left": "-",
                    "pod_payment_link": null,
                    "pod_amount_total": null,
                    "carrier_info": {
                        "name": "Dane",
                        "email": "oladetountemitayo@gmail.com",
                        "phone": "2349026554054",
                        "logo": {
                            "url": "https://res.cloudinary.com/ideraos-com/image/upload/v1728554068/delivery-images/wbyv4cnunmkjqnb3qd1l.jpg"
                        }
                    },
                    "tracking_link": "https://shiip-landing-new.netlify.app/shipment/track/?reference=7q4ms8job720",
                    "company": null
                },
                {
                    "id": 21447,
                    "reference": "6qujq5abu2n0",
                    "user_id": 96,
                    "carrier": "Jand2Gidi",
                    "shipment_type": "international",
                    "amount": "10000",
                    "dropoff_address": "51 Itire St, Ikate 101241, Lagos, Nigeria",
                    "pickup_address": "8600 COMMERCE PARK DRIVE, houston texas",
                    "statusBreakdown": null,
                    "status": "pending",
                    "current_location": "processing",
                    "items": [
                        {
                            "pickup_date": "2024-03-22T10:49",
                            "weight": "1",
                            "quantity": "1",
                            "name": "Consectetur earum et",
                            "amount": "12",
                            "description": "Excepturi facilis qu",
                            "category": "beauty",
                            "weight_id": 1,
                            "height": 17.1,
                            "width": 17.1,
                            "length": 17.1
                        }
                    ],
                    "created_at": "2024-03-22T10:50:37.000000Z",
                    "updated_at": "2024-09-06T12:02:25.000000Z",
                    "processor": "Jand2Gidi",
                    "assigned_by": null,
                    "assigned_on": null,
                    "platform": "WEB",
                    "platform_ref": null,
                    "isCancelled": 0,
                    "actual_amount": "0",
                    "deliveryDate": "-",
                    "image": null,
                    "podAmount": null,
                    "podStatus": "pending",
                    "eta_in_days": 15,
                    "podCourierId": 0,
                    "podRiderId": null,
                    "userReadyForShipping": 0,
                    "promotion": null,
                    "rated": 0,
                    "rating": "0.00",
                    "delivery_note": null,
                    "currency": "USD",
                    "senderPhoneNumber": "8131628736",
                    "weight": {
                        "id": 1,
                        "weight": "0.5"
                    },
                    "logo": "https://delivery-staging.apiideraos.com/partners/jand2gidi.png",
                    "numberOfDaysToDeliver": 15,
                    "estimated_days_of_delivery": "-",
                    "formatted_delivery_date": "-",
                    "how_many_days_left": "-",
                    "pod_payment_link": null,
                    "pod_amount_total": null,
                    "carrier_info": {
                        "name": "Jand2gidi",
                        "email": "jand@gidi.com",
                        "phone": "2348022828833",
                        "logo": null
                    },
                    "tracking_link": "https://shiip-landing-new.netlify.app/shipment/track/?reference=6qujq5abu2n0",
                    "company": null
                }
            ],
            "first_page_url": "https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?page=1",
            "from": 1,
            "last_page": 1,
            "last_page_url": "https://delivery-staging.apiideraos.com/api/v2/token/user/allorders?page=1",
            "next_page_url": null,
            "path": "https://delivery-staging.apiideraos.com/api/v2/token/user/allorders",
            "per_page": 50,
            "prev_page_url": null,
            "to": 18,
            "total": 18
        }
    },
    "status": true,
    "message": "OK",
    "status_code": 200
}

PreviousAssign ShipmentNextCancel Shipment

Last updated 6 months ago