# Loyalty Program Info
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/v1/managers/store/loyalty-program-info:
get:
summary: Loyalty Program Info
deprecated: false
description: >-
Retrieves information about the store's loyalty program info page
content.
`loyalty_program.read` - Loyalty Program Read
operationId: get-managers-store-loyalty-program-info
tags:
- Default module/Apps/Merchant APIs/Marketing/Loyalty Program
- Loyalty Program
parameters:
- name: Authorization
in: header
description: >-
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.
required: true
example: '{{Autherization}}'
schema:
type: string
- name: X-Manager-Token
in: header
description: >-
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.
required: false
example: '{{Access-Token}}'
schema:
type: string
- name: Accept
in: header
description: >-
Specifies the Media Types acceptable for the client. In this case,
it signals that the client expects a response in the JSON format.
required: true
example: application/json
schema:
type: string
default: application/json
- name: Accept-Language
in: header
description: >-
Preferred language for the response. Defaults to `en` if not
specified.
required: false
example: en
schema:
type: string
enum:
- en
- ar
examples:
- en
responses:
'200':
description: Store loyalty program info page content is retrieved successfully.
content:
application/json:
schema:
type: object
x-examples:
Example 1:
status: object
payload:
title_ar: مثال على عنوان الصفحة
title_en: Sample of page title
content_ar: مثال على محتوى الصفحة
content_en: Sample of page content
message:
type: object
code: null
name: null
description: null
properties:
status:
type: string
description: Indicates the overall status of the API response.
examples:
- '"success"'
payload:
type: object
description: Contains the main content or data returned by the API.
properties:
title_ar:
type: string
description: The title of the content in Arabic.
examples:
- '"برنامج الولاء"'
nullable: true
title_en:
type: string
description: The title of the content in English.
examples:
- '"Loyalty Program"'
nullable: true
content_ar:
type: string
description: The HTML-formatted content in Arabic.
examples:
- >-
"مرحبًا
بكم في برنامج الولاء الخاص بنا
نحن
نقدر ولاءكم ونقدم لكم مكافآت
حصرية.
"
nullable: true
content_en:
type: string
description: The HTML-formatted content in English.
examples:
- >-
"Welcome to our Loyalty
Program
We appreciate your loyalty and
offer you exclusive rewards.
"
nullable: true
x-apidog-orders:
- title_ar
- title_en
- content_ar
- content_en
x-apidog-ignore-properties: []
message: &ref_0
description: >-
Contains additional information or messages related to the
API response.
$ref: '#/components/schemas/ResponseEnvelopMessage'
x-apidog-orders:
- status
- payload
- message
x-apidog-ignore-properties: []
example:
status: object
payload:
title_ar: نقاط الولاء
title_en: null
content_ar: >-
10 نقاط يتم الحصول عليها مقابل كل 50 ريال تم الشراء
بها.
صالحة لمدة سنة كاملة.
والنقاط المكتسبة قابلة
للأستبدال بمقابل مبلغ مالي عند اتمام عملية الشراء
القادمة.
content_en: null
message:
type: object
code: null
name: null
description: null
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_0
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/Marketing/Loyalty Program
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9148640-run
components:
schemas:
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: []
```