Rider Equipment List API Documentation

This document provides the necessary details to interact with the Rider Equipment List API endpoint. The API allows users to retrieve assigned equipment for riders, with filtering options for status, 3PL, and pagination.

Base URL

https://talabatkw.wearyourebrand.com/api/v2

Endpoints

GET /rider-equipment-list

Retrieve a paginated list of riders with their assigned or returned equipment, including related product and variation information.

Query Parameters

Parameter	Type	Description
rider_id	bigint	(optional) Filter by rider ID.
3pl_name	text	(optional) Filter by third-party logistics (3PL) name.
active	0 or 1	(optional) Filter by assignment status: 1 = active, 0 = returned.
per_page	int	(optional) Number of results per page (default: 100).

Response

The response will be a JSON array of rider equipment details. Each object in the array contains the following fields:

Field	Description
rider_id	(bigint) ID of the rider.
3pl_name	(text) Name of the third-party logistics company.
country_code	(text) Country code for the rider’s site.
products	(array) List of product assignments with their metadata.

Each product in the products array contains:

Field	Description
equipment_id	(bigint) ID of the product.
variation_id	(bigint or null) ID of the variation (e.g. size).
equipment_name	(text) Name of the product.
equipment_variation_name	(text or null) Name of the variation, if available.
assign_date	(datetime or null) Date of assignment.
assign_type	(text or null) Assignment type (e.g. assign, auto_return).
return_date	(datetime or null) Date of return (if applicable).
active	(boolean) Whether the item is currently assigned (true) or returned.

Caution

Retrieving an equipment record returns every field; empty values are returned as null. For example, don’t rely solely on the presence of “assign_date” to determine assignment — check if it is not null.

Example Request

GET GET /rider-equipment-list?rider_id=28367&active=1&per_page=10

Example Response

[
  {
    "current_page": 1,
    "data": [
      {
        "rider_id": "28367",
        "3pl_name": "Delivery Express 2",
        "country_code": "kw",
        "products": [
          {
            "equipment_id": 52,
            "variation_id": null,
            "equipment_name": "Thermal Bag (OLD)",
            "equipment_variation_name": null,
            "assign_date": "2023-06-29 00:00:00",
            "assign_type": "assign",
            "return_date": null,
            "active": true
          }
        ]
      }
    ],
    "total": 1,
    "per_page": 10,
    "last_page": 1
  }
]

Notes

The active flag is determined by whether the product has a deleted_at value. 3pl_name is case-sensitive. Pagination is supported via per_page. If no filters are applied, the endpoint returns all riders with their full equipment lists.

Example

Scenario: Get returned equipment for rider 28367.

GET /rider-equipment-list?rider_id=28367&active=0

Response

[
  {
    "current_page": 1,
    "data": [
      {
        "rider_id": "28367",
        "3pl_name": "Delivery Express 2",
        "country_code": "kw",
        "products": [
          {
            "equipment_id": 52,
            "variation_id": null,
            "equipment_name": "Thermal Bag (OLD)",
            "equipment_variation_name": null,
            "assign_date": "2023-06-29 00:00:00",
            "assign_type": "assign",
            "return_date": "2024-03-05T07:51:40.000000Z",
            "active": false
          }
        ]
      }
    ],
    "total": 1,
    "per_page": 10,
    "last_page": 1
  }
]