# List Notifications

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/products/notifications/:
    get:
      summary: List Notifications
      deprecated: false
      description: |-
        Retrieve a list of availability notifications.

        <Accordion title="🔑Scopes" defaultOpen>
            
          `products.read` - Products Read
         
        </Accordion>
      operationId: get-products-notifications
      tags:
        - >-
          Default module/Apps/Merchant APIs/Products/Product Availability
          Notifications
        - Product Notifications
      parameters:
        - name: q
          in: query
          description: >-
            This parameter is used for searching by product name. It allows
            partial or full matches with the product name in the specified
            language.
          required: false
          schema:
            type: string
            examples:
              - سينامون كيك
        - name: product_id
          in: query
          description: >-
            This parameter filters the results to include only those
            notifications related to the specified product ID.
          required: false
          schema:
            type: string
            examples:
              - b1804aca-0adf-4eb1-bb43-8b8625c87bd4
        - name: created_at__gte
          in: query
          description: >-
            This parameter filters the results to include only those
            notifications created on or after the specified datetime.
          required: false
          schema:
            type: string
            examples:
              - '2024-02-15T21:00:52Z'
        - name: created_at__lte
          in: query
          description: >-
            This parameter filters the results to include only those
            notifications created on or before the specified datetime.
          required: false
          schema:
            type: string
            examples:
              - '2024-02-16T21:00:52Z'
        - name: page
          in: query
          description: >-
            This parameter specifies the page number of the results to retrieve.
            It is used for pagination purposes.
          required: false
          example: '1'
          schema:
            type: string
            examples:
              - '1'
        - name: page_size
          in: query
          description: >-
            This parameter specifies the number of results to include per page.
            It is used for pagination purposes.
          required: false
          example: '15'
          schema:
            type: string
            examples:
              - '10'
        - name: Access-Token
          in: header
          description: >-
            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](docs/Migrate-to-OAUTH-2.0.md) on how to obtain the
            `Access-Token`.
          required: true
          example: '{{Access-Token}}'
          schema:
            type: string
        - name: Store-Id
          in: header
          description: ''
          required: true
          example: '{{StoreId}}'
          schema:
            type: number
            examples:
              - 37213
        - name: Accept-Language
          in: header
          description: ''
          required: false
          example: en
          schema:
            type: string
            enum:
              - ar
              - en
            x-apidog-enum:
              - value: ar
                name: ''
                description: ''
              - value: en
                name: ''
                description: ''
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                email:
                  type: string
                  x-stoplight:
                    id: 53rp1dxsljxdf
                  description: Email address of the customer.
                  examples:
                    - test@test.com
                  example: test@test.com
                language:
                  type: string
                  x-stoplight:
                    id: hvrxa43vtw0cc
                  description: Language preference of the customer.
                  examples:
                    - ar
                  example: ar
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: Total number of availability notifications.
                    examples:
                      - 10
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProductNotification'
                    description: List of availability notification objects.
                required:
                  - count
                  - next
                  - previous
                  - results
                x-apidog-orders:
                  - count
                  - next
                  - previous
                  - results
                x-apidog-ignore-properties: []
              example:
                count: 1
                next: null
                previous: null
                results:
                  - id: 0d8f7dc9-423d-4e54-ab47-6c170f4c0d84
                    product_id: a7ad89d0-03e2-430f-b6e4-0624ef05e571
                    product_name:
                      ar: لوحة
                      en: 'voucher-no1 & small size '
                    customer:
                      id: 1
                      name: مازن الضراب
                      email: test@test.com
                      phone_number: '+966501234567'
                    language: ar
                    is_notified: false
                    image:
                      full_size: >-
                        https://media.zid.store/d297fb8b-c322-412e-a2f4-ffa96dc57022/52e4613d-6576-484d-b6f1-f43f8bc20b88.png
                      thumbnail: >-
                        https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/52e4613d-6576-484d-b6f1-f43f8bc20b88-thumbnail-370x370.png
                      large: >-
                        https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/52e4613d-6576-484d-b6f1-f43f8bc20b88-thumbnail-1000x1000.png
                      medium: >-
                        https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/52e4613d-6576-484d-b6f1-f43f8bc20b88-thumbnail-770x770.png
                      small: >-
                        https://media.zid.store/thumbs/d297fb8b-c322-412e-a2f4-ffa96dc57022/52e4613d-6576-484d-b6f1-f43f8bc20b88-thumbnail-500x500.png
                    created_at: '2026-02-04T11:10:41.514985Z'
                    updated_at: '2026-02-04T11:11:13.666533Z'
                    code: 5XRDXCSL
                    is_purchased: false
                    purchased_total: 0
          headers: {}
          x-apidog-name: OK
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Response returned when the request cannot be authenticated
                  because the required credentials are missing, invalid, or
                  expired.
                properties:
                  status:
                    type: string
                    description: Indicates the overall status of the API response.
                    examples:
                      - error
                  message:
                    type: object
                    description: >-
                      Contains structured details explaining why the request
                      could not be authenticated.
                    properties:
                      type:
                        type: string
                        description: Indicates the category of the response message.
                        examples:
                          - error
                      code:
                        type: string
                        description: >-
                          A machine-readable code identifying the authentication
                          error. Returns null when no specific code is
                          available.
                        examples:
                          - UNAUTHORIZED
                        nullable: true
                      name:
                        type: string
                        description: >-
                          A short, human-readable title describing the
                          authentication error. Returns null when no title is
                          available.
                        examples:
                          - Unauthorized
                        nullable: true
                      description:
                        type: string
                        description: >-
                          A human-readable explanation of why the request could
                          not be authenticated. Returns null when no detailed
                          explanation is available.
                        examples:
                          - >-
                            Authentication credentials are missing, invalid, or
                            expired.
                        nullable: true
                    required:
                      - type
                      - code
                      - name
                      - description
                    x-apidog-orders:
                      - type
                      - code
                      - name
                      - description
                    x-apidog-ignore-properties: []
                required:
                  - status
                  - message
                x-apidog-orders:
                  - status
                  - message
                examples:
                  - status: error
                    message:
                      type: error
                      code: UNAUTHORIZED
                      name: Unauthorized
                      description: >-
                        Authentication credentials are missing, invalid, or
                        expired.
                x-apidog-ignore-properties: []
              examples:
                '2':
                  summary: Example 1
                  value:
                    status: error
                    message:
                      type: error
                      code: ERROR_SESSION_MISSING
                      name: Sorry
                      description: Please login first.
                '3':
                  summary: Example 2
                  value:
                    status: error
                    message:
                      type: error
                      code: ERROR_SESSION_INVALID
                      name: Sorry
                      description: Login session expired. Please login again.
                '4':
                  summary: Example 3
                  value:
                    status: error
                    message:
                      type: error
                      code: ERROR_SESSION_INVALID
                      name: Sorry
                      description: Invalid authentication
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Status of the error.
                  message:
                    $ref: '#/components/schemas/ResponseEnvelopMessage'
                required:
                  - status
                  - message
                x-apidog-orders:
                  - status
                  - message
                x-apidog-ignore-properties: []
              example:
                status: error
                message:
                  type: error
                  code: MSG_HIDDEN
                  name: Error
                  description: Internal Server Error
          headers: {}
          x-apidog-name: Internal Server error
      security: []
      x-apidog-folder: >-
        Default module/Apps/Merchant APIs/Products/Product Availability
        Notifications
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9148665-run
components:
  schemas:
    ProductNotification:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the availability notification.
          examples:
            - '"8e4a8335-2338-4bc7-9a66-8551719eac14"'
        product_id:
          type: string
          description: Unique identifier for the product related to the notification.
          examples:
            - '"a4dcde12-dc23-4339-aa00-bc66d4cda6fd"'
        product_name:
          type: object
          properties:
            ar:
              type: string
              description: Product name in Arabic.
              examples:
                - '"2test"'
            en:
              type: string
          required:
            - ar
            - en
          x-apidog-orders:
            - ar
            - en
          description: Localized names of the product.
          x-apidog-ignore-properties: []
        customer:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
              description: Name of the customer.
              examples:
                - '"test"'
            email:
              type: string
              description: Email address of the customer.
              examples:
                - ' "m.basideq@test.com"'
            phone_number:
              type: string
          required:
            - id
            - name
            - email
            - phone_number
          x-apidog-orders:
            - id
            - name
            - email
            - phone_number
          description: Information about the customer who subscribed to the notification.
          x-apidog-ignore-properties: []
        language:
          type: string
          description: Language preference of the customer.
          examples:
            - ar
        is_notified:
          type: boolean
          description: Indicates whether the customer has been notified.
        image:
          type: object
          properties:
            full_size:
              type: string
            thumbnail:
              type: string
            large:
              type: string
            medium:
              type: string
            small:
              type: string
          required:
            - full_size
            - thumbnail
            - large
            - medium
            - small
          x-apidog-orders:
            - full_size
            - thumbnail
            - large
            - medium
            - small
          x-apidog-ignore-properties: []
        created_at:
          type: string
          description: Timestamp when the notification was created.
          examples:
            - '"2024-07-16T10:22:52.919750Z"'
        updated_at:
          type: string
          description: Timestamp when the notification was last updated.
          examples:
            - '"2024-08-16T10:22:52.919750Z"'
        code:
          type: string
        is_purchased:
          type: boolean
        purchased_total:
          type: integer
      x-apidog-orders:
        - id
        - product_id
        - product_name
        - customer
        - language
        - is_notified
        - image
        - created_at
        - updated_at
        - code
        - is_purchased
        - purchased_total
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    ResponseEnvelopMessage:
      type: object
      properties:
        type:
          type: string
          description: Type of response message returned by the API.
          examples:
            - success
        code:
          type: string
          description: Response code returned by the API, if available.
          examples:
            - MSG_POPUP_OK
          nullable: true
        name:
          type: string
          description: Name or title of the response message, if available.
          examples:
            - Coupons
          nullable: true
        description:
          type: string
          description: Detailed description of the response message, if available.
          examples:
            - Coupons created successfully
          nullable: true
      required:
        - type
        - code
        - name
        - description
      description: Additional response metadata.
      x-apidog-orders:
        - type
        - code
        - name
        - description
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.zid.sa/
    description: Prod Env
security: []

```