Get Order Detail

Call the following endpoint in order to get the order details.

The order details include:

1: Pickup and Dropoff details including description

2: Driver details including name, phone number, avatar and vehicle information

3: Order price and payment details

4: Order statuses

5: Share URL. A tool which you can use to share a link with your clients to view the live driver status.

---

HTTP Request

GET

https://api.pass.qa/business/v1/orders/{ORDER_ID}

---

Sample Request

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL            => "https://api.pass.qa/business/v1/orders/{ORDER_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING       => "",
  CURLOPT_MAXREDIRS      => 10,
  CURLOPT_TIMEOUT        => 30,
  CURLOPT_HTTP_VERSION   => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST  => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer ".$token,//$token is your token created in dashboard.
    "Content-Type: application/json; charset=utf-8",
    "Accept: application/json"
  ],
]);

$response = curl_exec($curl);
$err      = curl_error($curl);

curl_close($curl);

if ($err) {
  echo 'cURL Error #:' . $err;
} else {
  echo $response;
}

Node.js

var request = require("request");
var token = 'mytokenvalue' //token value to be placed here;
var baseURL = 'https://api.pass.qa/business';

var options = { method: 'GET',
  url: baseURL+'/v1/orders/{ORDER_ID}',
  headers: 
   { Accept: 'application/json',
     Authorization: 'Bearer '+token,
     'Content-Type': 'application/json' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);
  console.log(body);
});

Python

import requests
token = 'your token'
baseUrl ='https://api.pass.qa/business'
headers = {'Authorization': 'Bearer '+token,'Accept':'application/json','Content-Type':'application/json'}
response = requests.get(baseUrl+'/v1/orders/{ORDER_ID}', headers=headers)
print(response.json())

---

Response Descriptions

Attribute	Description
status	Indicates whether the progress has been successful or not.
driver[name]	Driver's name
driver[mobile]	Driver's phone number
driver[avatar]	Driver's avatar i.e. profile photo
driver[plate]	Driver's vehicle plate
pickup[lat]	Sender latitude
pickup[long]	Sender longitude
pickup[name]	Sender name
pickup[phone]	Sender phone
pickup[address]	Sender address
pickup[description]	Sender description
dropoffs	An array of objects that each one is like a pickup object. The maximum length of the array is 3 and the minimum is 1. Please see the sample response at the end of this page.
price	Order's price
in_progress	Indicates that the order is in progress or not
date	Date of the order creation
payment_type	"wallet" or "cash on delivery"
order_status	There are 7 steps in each order that is explained in the table below
share_url	Link of the order information and tracking to sharing with others

Order Status Responses	Description
searching	Searching for drivers
accept	Driver has accepted the order and is on the way to the pickup
arrive	The driver has arrived to the pickup location and is waiting to pickup the package
pickup	The driver has picked up the package and is driving towards the dropoff.
dropoff	The driver has reached the drop off point. Kindly note that this step can be responded as 'dropoff1. dropoff2. dropoff3' if the order is a multiple drop off order. View example in the sample code.
complete	The order has been completed.
cancel	The order has been cancelled. This can be because of a cancellation from the driver, from the customer, from a pass agent or even as a result of an order expiry.

SAMPLE RESPONSE

{
    "status": "success",
    "message": "success",
    "data": {
        "id": 13198,
        "driver": {
            "name": "Muhammad Saeed",
            "mobile": "[phone]",
            "avatar": "https://pass-space.fra1.cdn.digitaloceanspaces.com/drivers/YORaFadtNJakaP1zlGJ6jljNYl7xPnAx7FVtmO0c.jpg",
            "plate": "408612"
        },
        "pickup": {
            "lat": "25.275047",
            "lng": "51.535141",
            "name": "Greg Beahan",
            "phone": "[phone]",
            "address": "505 Laura Drives",
            "description": "it is a sample description"
        },
        "dropoffs": [
            {
                "lat": "25.277007",
                "lng": "51.530034",
                "name": "Sharon Dicki",
                "phone": "[phone]",
                "address": "18383 Frank River",
                "description": "Global"
            },
            {
                "lat": "25.277007",
                "lng": "51.530034",
                "name": "Jana Hane",
                "phone": "[phone]",
                "address": "227 Parker Ford",
                "description": "Forward"
            },
            {
                "lat": "25.277007",
                "lng": "51.530034",
                "name": "Lynn Macejkovic",
                "phone": "[phone]",
                "address": "1389 Mittie Islands",
                "description": "Principal"
            }
        ],
        "price": 11.04,
        "in_progress": true,
        "date": "14/02/2023 15:42:12",
        "payment_type": "wallet",
        "status": "accept",
        "share_url": "https://api.pass.qa/safe-url/MTMxOTg="
    }
}