List Category Products

This endpoint allows you to list all the products and their sort order that are related in a specified category by passing the id as a path parameter..

Scopes

categories.read - Categories Read Only

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

status

integer

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

array [object {4}]

required

integer

optional

Product ID

name

string

optional

Product Name

image

string

optional

Product Image in URL format

sort

integer

optional

Sort order of the product viewed inside a category

pagination

object (Pagination)

required

For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Examples

SuccessSuccess

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1616381492,
      "name": "iPhone 16 Pro",
      "image": "https://salla-dev.s3.eu-central-1.amazonaws.com/Mvyk/1b333d84-4a80-49fc-9fb1-6565aa44045e-500x333.33333333333-omJjjLFh9HqShwJa7O4YD904Q2mfXLqKy0wcLVJE.jpg",
      "sort": 1
    },
    {
      "id": 388819608,
      "name": "أقراط الياقوت",
      "image": "https://cdn.salla.sa/nzvOE/a2f5abed-2e38-479e-a4ff-4e442508935c-500x500-y5Wuuum0SgGrYfYHbpKPunlapp0BXVXeaT413.jpg",
      "sort": 2
    }
  ],
  "pagination": {
    "count": 2,
    "total": 2,
    "perPage": 15,
    "currentPage": 1,
    "totalPages": 1,
    "links": []
  }
}

🟠401Unauthorized

🟠404Record Not Found

List Category Products

Request

Request samples

Responses