Zid Docs

Availability Notifications Settings

GET

https://api.zid.sa/v1/products/notifications/settings/

Product Notifications

Retrieve current settings for availability notifications.

🔑Scopes

products.read - Products Read

Request

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 application/json

string

optional

Email address of the customer.

Example:

test@test.com

language

string

optional

Language preference of the customer.

Example:

Example

{
  "email": "test@test.com",
  "language": "ar"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/products/notifications/settings/' \
--header 'Access-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Store-Id;' \
--header 'Role;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "test@test.com",
    "language": "ar"
}'

Responses

🟢200Successfully retrieved availability notifications settings.

application/json

Body

settings

object

optional

delay_unit

string

optional

The unit of time used to define the delay before sending the availability notification.

Example:

minute

delay_value

integer

optional

The value of the delay time, combined with delay_unit, to define the total delay period before sending the availability notification.

Example:

email_text

object

optional

The content of the email notification to be sent to the customer when the product is back in stock.

email_title

object

optional

The title of the email notification to be sent to the customer when the product is back in stock.

coupon_code

null

optional

This parameter is used to specify any coupon code that might be included in the email. If there is no coupon code, it will be set to null.

Example

{
  "settings": {
    "delay_unit": "minute",
    "delay_value": 50,
    "email_text": {
      "ar": "عزيزنا {customer_name}، تم توفر {product_name} في المتجر، بإمكانك طلبه الآن \\n{product_url}",
      "en": "Dear {customer_name}، {product_name} is now back in stock, you can order it now \\n{product_url}"
    },
    "email_title": {
      "ar": "السلام عليكم",
      "en": "Hi"
    },
    "coupon_code": null
  }
}

Modified at 2025-01-22 08:04:11

Availability Notification Stats

List Availability Notifications