List Availability Notifications

Request

Query Params

q

string

optional

This parameter is used for searching by product name. It allows partial or full matches with the product name in the specified language.

Example:

سينامون كيك

product_id

string

optional

This parameter filters the results to include only those notifications related to the specified product ID.

Example:

b1804aca-0adf-4eb1-bb43-8b8625c87bd4

created_at__gte

string

optional

This parameter filters the results to include only those notifications created on or after the specified datetime.

Example:

2024-02-15T21:00:52Z

created_at__lte

string

optional

This parameter filters the results to include only those notifications created on or before the specified datetime.

Example:

2024-02-16T21:00:52Z

page

string

optional

This parameter specifies the page number of the results to retrieve. It is used for pagination purposes.

Example:

1

page_size

string

optional

This parameter specifies the number of results to include per page. It is used for pagination purposes.

Example:

10

Header Params

Access-Token

string

required

An Access Token is a unique string that represents the authorization granted to a client (Partner application) by a user (Merchant or Store Manager) to access their protected resources. It is part of the OAuth 2.0 standard and is used to authenticate API requests on behalf of the user. Access Tokens have a limited lifespan and must be used within their validity period. Once expired, a new Access Token can be obtained using a Refresh Token. Access Tokens should be treated as sensitive information and must be kept secure to prevent unauthorized access to the user's data. If you do not have an Access-Token, but have the older alternative instead, i.e., the X-Manager-Token, then see the instructions here on how to obtain the Access-Token.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Store-Id

number

required

Example:

37213

Role

enum<string>

required

Role of the user.

Allowed value:

Manager

Example:

Manager

Content-Type

enum<string>

required

The Media Type of the body of the request. This is used to describe the structure of the data in the body.

Allowed values:

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

Default:

application/json

Body Params multipart/form-data

email

string

optional

Email address of the customer.

Example:

test@test.com

language

string

optional

Language preference of the customer.

Example:

ar

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.zid.sa/v1/products/notifications/?q&product_id&created_at__gte&created_at__lte&page&page_size' \
--header 'Access-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Store-Id;' \
--header 'Role;' \
--form 'email="test@test.com"' \
--form 'language="ar"'

Responses

🟢200Successfully retrieved the details of the availability notification.

application/json

Body

count

integer

optional

Total number of availability notifications.

Example:

10

optional

URL to the next page of results, if applicable.

optional

URL to the previous page of results, if applicable.

results

array [object {9}]

optional

List of availability notification objects.

id

string

optional

Unique identifier for the availability notification.

Example:

"8e4a8335-2338-4bc7-9a66-8551719eac14"

product_id

string

optional

Unique identifier for the product related to the notification.

Example:

"a4dcde12-dc23-4339-aa00-bc66d4cda6fd"

product_name

object

optional

Localized names of the product.

customer

object

optional

Information about the customer who subscribed to the notification.

language

string

optional

Language preference of the customer.

Example:

ar

is_notified

boolean

optional

Indicates whether the customer has been notified.

Default:

false

image

null

optional

URL to the product image, if available.

created_at

string

optional

Timestamp when the notification was created.

Example:

"2024-07-16T10:22:52.919750Z"

updated_at

string

optional

Timestamp when the notification was last updated.

Example:

"2024-08-16T10:22:52.919750Z"

Example

{
  "count": 10,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "\"8e4a8335-2338-4bc7-9a66-8551719eac14\"",
      "product_id": "\"a4dcde12-dc23-4339-aa00-bc66d4cda6fd\"",
      "product_name": {
        "ar": "\"2test\""
      },
      "customer": {
        "id": null,
        "name": "\"test\"",
        "email": " \"m.basideq@test.com\"",
        "phone_number": null
      },
      "language": "ar",
      "is_notified": false,
      "image": null,
      "created_at": "\"2024-07-16T10:22:52.919750Z\"",
      "updated_at": "\"2024-08-16T10:22:52.919750Z\""
    }
  ]
}