Pickup Requests

Introduction

This API fetches all current customer pickup requests.

Request and Response

This API only accepts GET requests.

Development API End Point URL

https://dev-api.aymakan.com.sa/v2/pickup_request/list

Production API End Point URL

https://api.aymakan.net/v2/pickup_request/list

Headers

The following headers should be sent along with the request:

  • Accept: application/json
  • Authorization: Your account security code / API Token

Response

Success Response

Upon successful request, the following response will be sent back with an HTTP status 200 OK.

{
  "success": true,
  "data": {
    "pickupRequests": {
      "current_page": 1,
      "data": [
        {
          "id": 479795,
          "parent_id": null,
          "pickup_code": "dp-479795",
          "customer_id": 2376, 
          "type": "daily",
          "contact_name": "Test",
          "contact_phone": "966555555555",
          "city": "Riyadh",
          "neighborhood": null,
          "zone_code": null,
          "notes": null,
          "address": "7915 Umar Al Waidh, Salahuddin, 2771, Riyadh 12434, Saudi Arabia",
          "lat_long": null,
          "shipments": 4,
          "picked_shipments": 0,
          "time_slot": "morning",
          "pickup_date": "2026-06-28",
          "driver_id": null,
          "dispatcher_id": null,
          "status": "cancelled",
          "reason_id": null,
          "reference": null,
          "warehouse_name": "RUH",
          "warehouse_id": 1,
          "proof": null,
          "assign_at": "2026-06-28 10:25:27",
          "completed_at": null,
          "is_time_met": 0,
          "started_scanning_at": "2026-06-28 10:25:27",
          "reached_location_at": null,
          "created_at": "2026-06-28T07:25:27.000000Z",
          "updated_at": "2026-06-28T07:25:27.000000Z"
        }
      ],
        "next_page_url": null,
        "path": "http://customers-api.test/api/pickup_request/list",
        "per_page": 20,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
  }
}

Error Response

If authentication fails, the API returns an HTTP status 401 Unauthorized.

{
  "error": true,
  "response": "Invalid Credentials"
}