List Reviews

GET

https://api.zid.sa/v1/managers/store/reviews/product/

This API endpoint retrieves a list of product reviews. It allows you to filter and paginate through reviews based on various query parameters such as the review status, date range, and customer ID.

🔑Scopes

products.read - Products Read

Request

Query Params

page

string

optional

The page number of the results.

Example:

page_size

string

optional

Number of results per page.

Example:

search_term

string

optional

A term to search within the review content.

Example:

حقيبة

status

string

optional

Filter reviews based on status.

Example:

approved

date_from

string

optional

Filter reviews starting from a specific date.

Example:

2021-01-17

date_to

string

optional

Filter reviews up to a specific date.

Example:

2021-01-20

customer_id

string

optional

Filter reviews by a specific customer ID.

Example:

sort_by

string

optional

Sort results in ascending (asc) or descending (desc) order.

Example:

desc

order_by

string

optional

The field by which the reviews should be ordered.

Example:

Header Params

string

optional

Specifies the Media Types acceptable for the client. In this case, it signals that the client expects a response in the JSON format.

Example:

application/json

Authorization

string

optional

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

User-Agent

string

optional

The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

X-Manager-Token

string

optional

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

aren

Default:

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/managers/store/reviews/product/?page=1&page_size=2&search_term=حقيبة&status=approved&date_from=2021-01-17&date_to=2021-01-20&customer_id=2&sort_by=desc&order_by=id' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Accept-Language: en'

Responses

🟢200Success

application/json

Body

status

string

required

Contains the overall status of the request.

pagination

object

required

Information about the paginated results.

page

integer

required

The current page number.

Example:

next_page

integer

required

The next page number.

Example:

last_page

integer

required

The total number of pages available.

Example:

result_count

integer

required

The total number of reviews returned in this response.

Example:

reviews

array [object {11}]

required

A list of review objects.

string

required

The unique identifier for the review.

Example:

a9083b5c-7eba-464a-9c9c-9c8c5d9f9e6f

customer

object

required

Details of the customer who submitted the review.

product

object

required

Information about the reviewed product.

status

string

required

The status of the review (e.g., approved, pending).

Example:

approved

is_anonymous

boolean

required

Indicates whether the review was submitted anonymously.

Default:

false

rating

integer

required

The rating given by the customer (1 to 5 stars).

Example:

comment

string

required

The content of the review comment.

Example:

Ahshssh

object

required

The reply to the review, if any.

images

array [object {1}]

required

List of image URLs associated with the review.

created_at

string

required

The date and time the review was created.

Example:

2024-08-05 20:25:38

updated_at

string

required

The date and time the review was last updated.

Example:

2024-10-07 06:12:49

message

object

required

Any messages related to the request.

type

string

required

The type of message.

code

null

required

A message code, if applicable.

name

null

required

The name associated with the message.

description

null

required

A detailed description of the message.

Example

{
  "status": "object",
  "pagination": {
    "page": 1,
    "next_page": 2,
    "last_page": 14,
    "result_count": 28
  },
  "reviews": [
    {
      "id": "a9083b5c-7eba-464a-9c9c-9c8c5d9f9e6f",
      "customer": {
        "id": 38990,
        "name": "check"
      },
      "product": {
        "id": "561c3fe5-a357-4973-9928-8a307f974dae",
        "name": "test22",
        "bought_this_item": false,
        "image": null
      },
      "status": "approved",
      "is_anonymous": false,
      "rating": 3,
      "comment": "Ahshssh",
      "reply": null,
      "images": [],
      "created_at": "2024-09-04 12:34:14",
      "updated_at": "2024-10-07 06:13:02"
    },
    {
      "id": "3adaa670-3278-4a27-a11c-9c48804ca207",
      "customer": {
        "id": 214,
        "name": "mohamed2"
      },
      "product": {
        "id": "f9d02d0d-ea79-4bf3-865e-a735826f14a0",
        "name": "test 55",
        "bought_this_item": true,
        "image": null
      },
      "status": "approved",
      "is_anonymous": false,
      "rating": 1,
      "comment": "test 2 images<br />test new",
      "reply": {
        "id": "c48a3ec2-d234-498f-9c83-e987f7563bec",
        "text": "dvxcvxcv 😂🤣🙃",
        "images": [
          {
            "path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/8c619c39-f803-4e60-9bf9-fdeacaf3319a.jpg"
          },
          {
            "path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/63ce6f77-c819-4c47-8c1c-6b2f2516a85c.jpg"
          },
          {
            "path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/b6894238-bc8f-43be-aaef-7579bef54a70.jpg"
          }
        ],
        "created_at": "2024-08-12 13:07:04",
        "updated_at": "2024-08-12 14:07:22"
      },
      "images": [
        {
          "path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/6da8a689-5536-46ff-8248-0afcd44af256.jpg"
        },
        {
          "path": "https://zid-testing-907587157081.s3.eu-west-1.amazonaws.com/52e981e7-7f49-441e-87ee-f4512bcf7121/d5eccda8-9fac-4ad3-a533-3cf681d2362b.jpg"
        }
      ],
      "created_at": "2024-08-05 20:25:38",
      "updated_at": "2024-10-07 06:12:49"
    }
  ],
  "message": {
    "type": "object",
    "code": null,
    "name": null,
    "description": null
  }
}

Modified at 2025-01-28 05:59:53

Product Reviews

New Reviews Total