Category purchase
List Category Purchases
List all category purchases with pagination and filtering options.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Query Parameters
page?|
Page number for pagination. Must be at least 1.
per_page?|
Number of items per page. Must be at least 1.
search?|
Search in name_en or name_ar.
sort?|
Sort field and direction (e.g., name_en, -created_at).
key_by?|
Key the results by this field.
includes*array<>
filter?object
filter.categories_ids*array<>
The id of an existing record in the category_purchases table.
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:8000/api/v2/categories/purchase?page=1&per_page=20&search=electronics&sort=-created_at&key_by=id&includes=nihil&filter.categories_ids=cumque" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Category purchases retrieved successfully."
},
"data": {
"current_page": 1,
"data": [
{
"id": "cbfef808-5b87-4daf-90fe-1c27a3734636",
"name_en": "aut ut vitae",
"name_ar": "aut ut vitae",
"created_at": 1782824834921,
"updated_at": 1782824834921,
"deleted_at": null
},
{
"id": "9cbc3668-1166-43af-be07-69726fe74cb5",
"name_en": "eius voluptatibus qui",
"name_ar": "eius voluptatibus qui",
"created_at": 1782824834921,
"updated_at": 1782824834921,
"deleted_at": null
},
{
"id": "119f2bcd-b21d-4791-808d-a5b54e3a2da4",
"name_en": "inventore vel ipsum",
"name_ar": "inventore vel ipsum",
"created_at": 1782824834921,
"updated_at": 1782824834921,
"deleted_at": null
}
],
"first_page_url": "http://localhost:8000/api/v2/categories/purchase?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v2/categories/purchase?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"page": null,
"active": false
},
{
"url": "http://localhost:8000/api/v2/categories/purchase?page=1",
"label": "1",
"page": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"page": null,
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/v2/categories/purchase",
"per_page": 20,
"prev_page_url": null,
"to": 3,
"total": 3
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}