openapi: 3.1.0
info:
  title: Loyalty APIs
  description: >-
    Customer loyalty drives successful enterprises, representing the trust and
    emotional connection consumers develop with brands over time. In today's
    competitive landscape with evolving customer expectations, retaining
    existing customers is as crucial as attracting new ones.

    Our Customer Loyalty API revolutionizes customer engagement by enabling
    seamless integration of loyalty programs into your applications, websites,
    and platforms. This solution empowers businesses of all sizes with
    personalized experiences, targeted rewards, and data-driven insights to
    enhance customer lifetime value.

    This documentation guides you through integration with detailed
    explanations, endpoints, examples, and best practices suitable for both
    newcomers and experienced developers.


    Key Features-


    Customer Enrollment - Easily register customers with minimal API calls


    Points and Rewards Management - Track points and incentivize engagement


    Personalized Promotions - Create targeted offers based on individual
    preferences


    Data Analytics - Gain insights into customer behavior for informed decisions


    Security and Compliance - Protect customer data with robust security
    measures


    Seamless Integration - Compatible with various platforms for hassle-free
    implementation
  version: 3.0.0
servers:
  - url: https://s15.socialannex.net/api/3.0
paths:
  /users:
    post:
      tags:
        - Users
      summary: Used to create a new loyalty member
      description: >-
        To create new loyalty members and enroll them in the loyalty program,
        use the POST method in the user API. A unique ID must be specified while
        creating a new member. All other additional fields in the request and
        response body are listed below.
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the unique ID of the loyalty member.
                  example: jacklee2023
                  type: string
                email:
                  description: Enter the email address of the loyalty member.
                  example: jacklee2023@gmail.com
                  type: string
                firstName:
                  description: Enter the first name of the loyalty member.
                  example: John
                  type: string
                lastName:
                  description: Enter the last name of the loyalty member.
                  example: Deo
                  type: string
                optInStatus:
                  description: >-
                    Enter the opt-in status as YES for opt-in or NO for opt-out.
                    The default opt-in status is YES.
                  example: 'YES'
                  type: string
                optInDate:
                  description: >-
                    Enter the loyalty member's opt-in date in
                    yyyy-MM-dd'T'HH:mm:ssZ format. If the opt-in date is not
                    provided, by default, the system takes the current date and
                    time automatically.
                  example: 2024-08-08T07:00:12+0000
                  type: string
                status:
                  description: >-
                    If the activity-based membership status flag is OFF- Enter
                    the loyalty member’s status as active or inactive. By
                    default, the status is active and can be changed to inactive
                    as per the client’s request.  If the activity-based
                    membership status flag is ON- Any values submitted in the
                    status parameter will be ignored. The system automatically
                    manages member status based on the defined activity-based
                    criteria.
                  example: ACTIVE
                  type: string
                phone:
                  description: Enter the loyalty member’s phone number.
                  example: 123-123-4567
                  type: string
                birthDate:
                  description: Enter the loyalty member's date of birth.
                  example: '1989-12-11'
                  type: string
                createDate:
                  description: >-
                    Enter the date when the loyalty member’s profile was created
                    in yyyy-MM-dd'T'HH:mm:ssZ format. If the date is not
                    provided, by default, the system takes the current date and
                    time automatically.
                  example: 2024-08-08T07:00:12+0000
                  type: string
                anniversaryDate:
                  description: >-
                    Enter the loyalty member's anniversary date in yyyy-MM-dd
                    format. This can be their birthdate, the date they joined
                    the loyalty program or marriage date.
                  example: '2023-12-11'
                  type: string
                userProfileImageUrl:
                  description: >-
                    Enter the image URL for the loyalty member’s profile
                    picture. Note - The image value should be in base64 encoded
                    format.
                  example: >-
                    aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
                  type: string
                zipcode:
                  description: Enter the zip code of the loyalty member's residence.
                  example: '517501'
                  type: string
                source:
                  description: >-
                    Enter the source of the loyalty member's profile creation.
                    For example, website, application, or in-store.
                  example: website
                  type: string
                optReason:
                  description: >-
                    Enter the reason for opting in or out of the loyalty
                    program. The default opt-in status is YES. Note - For
                    opt-in, the action ID is 149, while for opt-out, it is 150.
                  example: New member
                  type: string
                extendedAttribute:
                  type: object
                  description: >-
                    Enter the member attributes defined in your program
                    configuration. This can be customized according to
                    requirements. It accepts multiple parameters; however, these
                    parameters must be defined under Products > Additional
                    Loyalty Settings > Extended Attributes. Note - The extended
                    attributes listed below are examples only. All extended
                    attributes must be configured for the program as stated
                    above.
                  properties:
                    userType:
                      description: >-
                        Enter the employment status of the member as employed,
                        unemployed, or student.
                      example: Employed
                      type: string
                    userStatus:
                      description: >-
                        Enter the unique referrer code provided by the
                        Refer-a-Friend program (if applicable), when creating a
                        loyalty member profile.
                      example: Enabled
                      type: string
                raf:
                  type: object
                  description: >-
                    Enter the incentiveId and referrerCode. This functionality
                    is accessible to programs that have enabled the Refer a
                    Friend (RAF) module. Note 1- This module is only displayed
                    when new members sign up for the loyalty program using a
                    referrer code. Note2- This functionality is also applicable
                    to multi-template sites.
                  properties:
                    incentiveId:
                      description: Enter the incentive ID.
                      example: 936
                      type: integer
                    referrerCode:
                      description: >-
                        Enter the unique referrer code provided by the
                        Refer-a-Friend program (if applicable), when creating a
                        loyalty member profile.
                      example: 3bhqc5k
                      type: string
                heirarchyDetails:
                  type: object
                  description: >-
                    Enter the following information for the hierarchy management
                    group (if enabled in the program).
                  properties:
                    groupId:
                      description: >-
                        Enter the group ID for the group to which the loyalty
                        member is being added.
                      example: '91'
                      type: string
                    userType:
                      description: >-
                        Enter the role of the loyalty member within the group.
                        For example, administrator, primary member and secondary
                        member.
                      example: Administrator
                      type: string
                    addedBy:
                      description: >-
                        Enter the unique ID of the group administrator who added
                        the new loyalty member to the group.
                      example: jason.limit3@gmail.com
                      type: string
                    userGroupStatus:
                      description: >-
                        Enter the group status as active or inactive. The group
                        administrator has permission to change the status of the
                        group.
                      example: ACTIVE
                      type: string
              required:
                - id
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createUser'
            application/xml:
              schema:
                $ref: '#/components/schemas/createUser'
        '201':
          description: successful operation
        '400':
          description: AC1004 Missing Parameters
        '404':
          description: >-
            AC1001 Oops! Something went wrong |  AC2033 User Not Allow in
            Multiple Group
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists
        '422':
          description: AC1007 Invalid Parameters
  /users/{{memberId}}:
    get:
      tags:
        - Users
      summary: Get member information
      description: >-
        This API method is used to fetch all the information for a loyalty
        member by passing the unique ID of the member.
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the loyalty member.
          example: jacklee2023
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getUserDetails'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getUserDetails'
        '400':
          description: Invalid status value
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
    patch:
      tags:
        - Users
      summary: Update member details
      description: >-
        This method is used to update existing member information by merging the
        provided information with the current data.
      operationId: userupdatereq
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the unique ID of the loyalty member.
                  example: jacklee2023
                  type: string
                email:
                  description: Enter the email address of the loyalty member.
                  example: jacklee2023@gmail.com
                  type: string
                firstName:
                  description: Enter the first name of the loyalty member.
                  example: John
                  type: string
                lastName:
                  description: Enter the last name of the loyalty member.
                  example: Deo
                  type: string
                optInStatus:
                  description: >-
                    Enter the opt-in status as YES for opt-in or NO for opt-out.
                    The default opt-in status is YES.
                  example: 'YES'
                  type: string
                optInDate:
                  description: >-
                    Enter the loyalty member's opt-in date in
                    yyyy-MM-dd'T'HH:mm:ssZ format. If the opt-in date is not
                    provided, by default, the system takes the current date and
                    time automatically.
                  example: 2024-08-08T07:00:12+0000
                  type: string
                status:
                  description: >-
                    If the activity-based membership status flag is OFF- Enter
                    the loyalty member’s status as active or inactive. By
                    default, the status is active and can be changed to inactive
                    as per the client’s request.  If the activity-based
                    membership status flag is ON- Any values submitted in the
                    status parameter will be ignored. The system automatically
                    manages member status based on the defined activity-based
                    criteria.
                  example: ACTIVE
                  type: string
                phone:
                  description: Enter the loyalty member’s phone number.
                  example: 123-123-4567
                  type: string
                birthDate:
                  description: Enter the loyalty member's date of birth.
                  example: '1989-12-11'
                  type: string
                createDate:
                  description: >-
                    Enter the date when the loyalty member’s profile was created
                    in yyyy-MM-dd'T'HH:mm:ssZ format. If the date is not
                    provided, by default, the system takes the current date and
                    time automatically.
                  example: 2024-08-08T07:00:12+0000
                  type: string
                anniversaryDate:
                  description: >-
                    Enter the loyalty member's anniversary date in yyyy-MM-dd
                    format. This can be their birthdate, the date they joined
                    the loyalty program or marriage date.
                  example: '2023-12-11'
                  type: string
                userProfileImageUrl:
                  description: >-
                    Enter the image URL for the loyalty member’s profile
                    picture. Note - The image value should be in base64 encoded
                    format.
                  example: >-
                    aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
                  type: string
                zipcode:
                  description: Enter the zip code of the loyalty member's residence.
                  example: '517501'
                  type: string
                source:
                  description: >-
                    Enter the source of the loyalty member's profile creation.
                    For example, website, application, or in-store.
                  example: website
                  type: string
                optReason:
                  description: >-
                    Enter the reason for opting in or out of the loyalty
                    program. The default opt-in status is YES. Note - For
                    opt-in, the action ID is 149, while for opt-out, it is 150.
                  example: New member
                  type: string
                extendedAttribute:
                  type: object
                  description: >-
                    Enter the member attributes defined in your program
                    configuration. This can be customized according to
                    requirements. It accepts multiple parameters; however, these
                    parameters must be defined under Products > Additional
                    Loyalty Settings > Extended Attributes. Note - The extended
                    attributes listed below are examples only. All extended
                    attributes must be configured for the program as stated
                    above.
                  properties:
                    userType:
                      description: >-
                        Enter the employment status of the member as employed,
                        unemployed, or student.
                      example: Employed
                      type: string
                    userStatus:
                      description: >-
                        Enter the unique referrer code provided by the
                        Refer-a-Friend program (if applicable), when creating a
                        loyalty member profile.
                      example: Enabled
                      type: string
                heirarchyDetails:
                  type: object
                  description: >-
                    Enter the following information for the hierarchy management
                    group (if enabled in the program).
                  properties:
                    groupId:
                      description: >-
                        Enter the group ID for the group to which the loyalty
                        member is being added.
                      example: '91'
                      type: string
                    userType:
                      description: >-
                        Enter the role of the loyalty member within the group.
                        For example, administrator, primary member and secondary
                        member.
                      example: Administrator
                      type: string
                    addedBy:
                      description: >-
                        Enter the unique ID of the group administrator who added
                        the new loyalty member to the group.
                      example: jason.limit3@gmail.com
                      type: string
                    userGroupStatus:
                      description: >-
                        Enter the group status as active or inactive. The group
                        administrator has permission to change the status of the
                        group.
                      example: ACTIVE
                      type: string
                    source:
                      description: >-
                        Enter the source of the loyalty member's profile
                        creation. For example, website, application, or
                        in-store.
                      example: website
                      type: string
                    optReason:
                      description: >-
                        Enter the reason for opting in or out of the loyalty
                        program. The default opt-in status is YES. Note - For
                        opt-in, the action ID is 149, while for opt-out, it is
                        150.
                      example: New member
                      type: string
                    updateId:
                      description: Enter the updated unique ID for the loyalty member.
                      example: jacklee23
                      type: string
              required:
                - id
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Updateuser'
            application/xml:
              schema:
                $ref: '#/components/schemas/Updateuser'
        '400':
          description: AC 1004 Missing Parameters
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: AC1007 Invalid Parameters
  /userDelete:
    post:
      tags:
        - Users
      summary: Delete member
      description: This method can be used to delete the member from the loyalty program.
      operationId: userdelete
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: >-
                    Enter the unique ID of the loyalty member that needs to be
                    deleted.
                  example: jacklee2023
                  type: string
                requestedBy:
                  description: >-
                    Enter the email address of the individual who has requested
                    the member be deleted.
                  example: jason.limit3@gmail.com
                  type: string
              required:
                - id
                - requestedBy
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteUserDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/deleteUserDetails'
        '201':
          description: successful operation
        '400':
          description: AC1004 Missing Parameters | AC1012 User not found
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/allgroup:
    get:
      tags:
        - Users
      summary: Get group information with group ID
      description: >-
        This API is used to retrieve the information of a member associated with
        a hierarchy management group.
      operationId: getgroupDetails
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the loyalty member.
          example: jacklee2023
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getgroup'
            application/xml:
              schema:
                $ref: '#/components/schemas/getgroup'
        '400':
          description: Invalid status value
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/search:
    post:
      tags:
        - Users
      summary: To search member details
      description: >-
        This API is used to search member details based on multiple query
        parameters. **Note - This API can only return a maximum of 50 records,
        and customers can access more than 50 user records by using the user
        export report in the admin portal.**
      operationId: usersearch
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  description: Enter the unique ID of the loyalty member.
                  example: jacklee2023
                  type: string
                email:
                  description: Enter the email address of the loyalty member.
                  example: jacklee2023@gmail.com
                  type: string
                firstName:
                  description: >-
                    Enter the first name of the loyalty member. Note - The
                    format of the first name must be in the format shown below
                    as example.
                  example: John% or %John%
                  type: string
                lastName:
                  description: >-
                    Enter the last name of the loyalty member. Note - The format
                    of the last name must be in the format shown below as
                    example.
                  example: Deo% or %Deo%
                  type: string
                optInStatus:
                  description: >-
                    Enter the opt-in status as YES for opt-in or NO for opt-out.
                    The default opt-in status is YES.
                  example: 'YES'
                  type: string
                optInDate:
                  description: >-
                    Enter the loyalty member's opt-in date in
                    yyyy-MM-dd'T'HH:mm:ssZ format. If the opt-in date is not
                    provided, by default, the system takes the current date and
                    time automatically.
                  example: 2024-08-08T07:00:12+0000
                  type: string
                optInStartDate:
                  description: >-
                    Enter the opt-in start date after which the loyalty member
                    details are searched. Note - All the member details are
                    searched within the opt-in start and end dates.
                  example: '2020-05-02 01:28:13'
                  type: string
                optInEndDate:
                  description: >-
                    Enter the opt-in end date. Note - All the member details are
                    searched within the opt-in start and end dates.
                  example: '2020-07-02 01:28:13'
                  type: string
                phone:
                  description: Enter the loyalty member’s phone number.
                  example: 123-123-4567
                  type: string
                birthDate:
                  description: Enter the loyalty member's date of birth.
                  example: '1989-12-11'
                  type: string
                createDate:
                  description: >-
                    Enter the date when the loyalty member’s profile was created
                    in yyyy-MM-dd'T'HH:mm:ssZ format. If the date is not
                    provided, by default, the system takes the current date and
                    time automatically.
                  example: 2024-08-08T07:00:12+0000
                  type: string
                extendedAttribute:
                  type: object
                  description: >-
                    Enter the member attributes defined in your program
                    configuration. This can be customized according to
                    requirements. It accepts multiple parameters; however, these
                    parameters must be defined under Products > Additional
                    Loyalty Settings > Extended Attributes. Note - The extended
                    attributes listed below are examples only. All extended
                    attributes must be configured for the program as stated
                    above.
                  properties:
                    userType:
                      description: >-
                        Enter the employment status of the member as employed,
                        unemployed, or student.
                      example: Employed
                      type: string
                    userStatus:
                      description: >-
                        Enter the unique referrer code provided by the
                        Refer-a-Friend program (if applicable), when creating a
                        loyalty member profile.
                      example: Enabled
                      type: string
              required:
                - userId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/userdatasearchresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/userdatasearchresp'
        '400':
          description: AC1004 Missing parameter
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1005 No data found
        '500':
          description: >-
            The request couldn't be fulfilled because the server ran into an
            unforeseen circumstance.
  /mergeuser:
    post:
      tags:
        - Users
      summary: Merge two members
      description: >-
        This method is used to merge two member accounts. The Secondary member
        account is merged with the Primary member account. Post merge, all the
        activities on the secondary member account are owned by the primary
        member. Also, if the primary member is missing member details, these
        details are filled in by the secondary member's details if available.
        Note - For 'Multi Template Summary Flag' enabled sites, the response
        shown below is sent to the email address provided against the mergedBy
        parameter.
      operationId: mergeuserpost
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                primaryUID:
                  description: >-
                    Enter the primary member’s ID. The primary member survives
                    post merge.
                  example: User1@domain.com
                  type: string
                secondaryUID:
                  description: >-
                    Enter the secondary member's ID. The data of secondary
                    member is deleted post merge as all the information is added
                    to primary member.
                  example: User2@domain.com
                  type: string
                mergedBy:
                  description: >-
                    Enter the email ID of the individual who initiated the
                    merge.
                  example: User3@domain.com
                  type: string
                reason:
                  description: >-
                    Enter the reason for which the individual wants to perform
                    the merge operation.
                  example: Duplicate records
                  type: string
                secondaryUserMultitemplateId:
                  description: >-
                    Enter the secondary member multi-template ID. Note - This
                    parameter is only required for cross-template merging.
                  example: 253
                  type: integer
                duplicateActions:
                  type: array
                  description: >-
                    Enter the actions that should be retained from either the
                    primary or secondary member when both members have performed
                    the same action.
                  items:
                    type: object
                    properties:
                      userIdToRetainActions:
                        description: >-
                          Enter either the primary or secondary member's ID to
                          retain their actions.
                        example: User2@domain.com
                        type: string
                      actionID:
                        description: >-
                          Enter the action ID. Note - This parameter is required
                          only when duplicate actions are passed.
                        example: 102
                        type: integer
              required:
                - primaryUID
                - secondaryUID
                - mergedBy
                - secondaryUserMultitemplateId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postMergeUserResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postMergeUserResp'
        '201':
          description: successful operation
        '400':
          description: AC1004 Missing Parameters | AC1012 User not found
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /mergeuser/{{memberId}}:
    get:
      tags:
        - Users
      summary: Get the status of the merge process by member’s ID
      description: >-
        This method is used to get the details of the primary member after the
        merge functionality is completed, and only a single member is left (the
        primary member). It displays how many members have been merged with the
        primary member, and some basic information, such as who the merge was
        initiated by and the reason for the merge. Note - For 'Multi Template
        Summary Flag' enabled sites, the response shows an additional status
        parameter which indicates whether the merge process is in-progress or
        completed.
      operationId: getMergeUser
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the loyalty member.
          example: jacklee2023
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMergeUserResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getMergeUserResp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/activitysummary/{{actionId}}:
    get:
      tags:
        - Users
      summary: Fetch the activity summary by action ID
      description: >-
        This API retrieves a summary of a member's activity, including points
        that have been debited or credited.
      operationId: getuseridactivitysummaryactionid
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the loyalty member.
          example: jacklee2023
          required: true
          schema:
            type: string
        - name: actionId
          in: path
          description: Enter the unique action ID used during the debit or credit activity.
          example: 109
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getuseridactivitysummaryactionidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getuseridactivitysummaryactionidresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /bulkpostusers:
    post:
      tags:
        - Users
      summary: Used to create multiple loyalty member profiles
      description: >-
        This API method is used for managing large-scale member registrations in
        the loyalty program. It facilitates the quick and efficient onboarding
        of multiple loyalty members simultaneously, by allowing the creation of
        several loyalty member profiles in a single request. This method
        significantly reduces the time and effort required to populate the
        loyalty program with new members, enhancing operational efficiency. NOTE
        - We recommend limiting requests to around 100 records.
      operationId: bulkpostusers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the unique ID of the loyalty member.
                  example: advinsap24
                  type: string
                email:
                  description: Enter the email address of the loyalty member.
                  example: advinsap24@gmail.com
                  type: string
                firstName:
                  description: Enter the first name of the loyalty member.
                  example: Advin
                  type: string
                lastName:
                  description: Enter the last name of the loyalty member.
                  example: Roy
                  type: string
                birthDate:
                  description: Enter the loyalty member's date of birth.
                  example: '2001-11-04T00:00:00-07:00'
                  type: string
                anniversaryDate:
                  description: >-
                    Enter the loyalty member's anniversary date in yyyy-MM-dd
                    format. This can be the date they joined the loyalty program
                    or marriage date.
                  example: '2021-11-04T00:00:00-07:00'
                  type: string
                optInStatus:
                  description: >-
                    Enter the opt-in status as YES for opt-in or NO for opt-out.
                    The default opt-in status is YES.
                  example: 'YES'
                  type: string
                status:
                  description: >-
                    If the activity-based membership status flag is OFF- Enter
                    the loyalty member’s status as active or inactive. By
                    default, the status is active and can be changed to inactive
                    as per the client’s request.  If the activity-based
                    membership status flag is ON- Any values submitted in the
                    status parameter will be ignored. The system automatically
                    manages member status based on the defined activity-based
                    criteria.
                  example: ACTIVE
                  type: string
                phone:
                  description: Enter the loyalty member’s phone number.
                  example: 4532678800
                  type: integer
                extendedAttribute:
                  type: object
                  description: >-
                    Enter the member attributes defined in your program
                    configuration. This can be customized according to
                    requirements. It accepts multiple parameters; however, these
                    parameters must be defined under Products > Additional
                    Loyalty Settings > Extended Attributes. Note - The extended
                    attributes listed below are examples only. All extended
                    attributes must be configured for the program as stated
                    above.
                  properties:
                    userType:
                      description: >-
                        Enter the employment status of the member as employed,
                        unemployed, or student.
                      example: Employed
                      type: string
                    userStatus:
                      description: >-
                        Enter the unique referrer code provided by the
                        Refer-a-Friend program (if applicable), when creating a
                        loyalty member profile.
                      example: Enabled
                      type: string
              required:
                - id
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbulkpostusersresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postbulkpostusersresp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Member has opted-out
        '404':
          description: AC1005 No data found
        '500':
          description: >-
            The request couldn't be fulfilled because the server ran into an
            unforeseen circumstance.
  /bulkpatchusers:
    post:
      tags:
        - Users
      summary: Used to update multiple loyalty member profiles
      description: >-
        This endpoint enables updating member information efficiently in bulk.
        NOTE - We recommend limiting requests to around 100 records.
      operationId: postbulkpatchusers
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the unique ID of the loyalty member.
                  example: advinsap24
                  type: string
                email:
                  description: Enter the email address of the loyalty member.
                  example: advinsap24@gmail.com
                  type: string
                firstName:
                  description: Enter the first name of the loyalty member.
                  example: Advin
                  type: string
                lastName:
                  description: Enter the last name of the loyalty member.
                  example: Roy
                  type: string
                optInStatus:
                  description: >-
                    Enter the opt-in status as YES for opt-in or NO for opt-out.
                    The default opt-in status is YES.
                  example: 'YES'
                  type: string
                status:
                  description: >-
                    If the activity-based membership status flag is OFF- Enter
                    the loyalty member’s status as active or inactive. By
                    default, the status is active and can be changed to inactive
                    as per the client’s request.  If the activity-based
                    membership status flag is ON- Any values submitted in the
                    status parameter will be ignored. The system automatically
                    manages member status based on the defined activity-based
                    criteria.
                  example: ACTIVE
                  type: string
                extendedAttribute:
                  type: object
                  description: >-
                    Enter the member attributes defined in your program
                    configuration. This can be customized according to
                    requirements. It accepts multiple parameters; however, these
                    parameters must be defined under Products > Additional
                    Loyalty Settings > Extended Attributes. Note - The extended
                    attributes listed below are examples only. All extended
                    attributes must be configured for the program as stated
                    above.
                  properties:
                    userType:
                      description: >-
                        Enter the employment status of the member as employed,
                        unemployed, or student.
                      example: Employed
                      type: string
                    userStatus:
                      description: >-
                        Enter the unique referrer code provided by the
                        Refer-a-Friend program (if applicable), when creating a
                        loyalty member profile.
                      example: Enabled
                      type: string
              required:
                - ID
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbulkpatchusersresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postbulkpatchusersresp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Member has opted-out
        '404':
          description: AC1005 No data found
        '500':
          description: >-
            The request couldn't be fulfilled because the server ran into an
            unforeseen circumstance.
  /transactionErasure/{{memberId}}:
    get:
      tags:
        - Users
      summary: Get transaction erasure details
      description: >-
        By passing the User ID, use this method to retrieve all transaction
        erasure details for a loyalty member.
      operationId: getTransactionErasure
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the loyalty member.
          example: jacklee2023
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getTransactionErasureResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getTransactionErasureResp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Member has opted-out
        '404':
          description: AC1005 No data found
        '500':
          description: Internal Server Error
  /transactionErasure:
    post:
      tags:
        - Users
      summary: Perform transaction erasure
      description: >-
        This method enables the member to perform Transaction Erasure for
        transactions that meet the predefined conditions.
      operationId: posttransactionerasure
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                orderId:
                  description: Enter the unique order ID from the loyalty member's order.
                  example: A2034354570
                  type: string
                userId:
                  description: Enter the unique ID of the loyalty member.
                  example: exsdf1038
                  type: string
              required:
                - orderId
                - userId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/posttransactionerasureResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/posttransactionerasureResp'
        '201':
          description: successful operation
        '400':
          description: AC1004 Missing Parameters | AC1012 User not found
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
    patch:
      tags:
        - Users
      summary: Undo transaction erasure
      description: >-
        Patch method is used to undo the transaction erasure that is in progress
        and not yet completed.
      operationId: transactionErasure
      parameters:
        - name: id
          in: path
          description: Enter the unique ID of the member.
          example: user@domain.com
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                orderId:
                  description: Enter the unique order ID from the loyalty member's order.
                  example: A2034354570
                  type: string
                userId:
                  description: Enter the unique ID of the loyalty member.
                  example: xsdf1038
                  type: string
                reversal:
                  description: To undo the transaction erasure, enter True.
                  example: true
                  type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchTransactionErasureResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchTransactionErasureResp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Member has opted-out
        '404':
          description: AC1005 No data found
        '500':
          description: Internal Server Error
  /users/{{memberId}}/activity:
    get:
      tags:
        - Users
      summary: Fetch the activity details
      description: >-
        By using this method, all activity details for a member can be
        retrieved.
      operationId: getuseractivityreq
      parameters:
        - name: memberId
          in: path
          description: Enter the unique member ID.
          example: John.j45@gmail.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getactivityresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getactivityresp'
        '403':
          description: AC1009 Opt-out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /actions:
    post:
      tags:
        - Action
      summary: Fetch the Action details by User ID
      description: >-
        This method retrieves all actions configured for the site and indicates
        which ones the member has completed.
      operationId: postActions
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the unique user ID of the loyalty member.
                  example: smith001@annexcloud.com
                  type: string
              required:
                - id
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postactionsresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postactionsresp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /actions/{{status}}:
    get:
      tags:
        - Action
      summary: Fetch the details of all actions performed against the site
      description: >-
        This method retrieves information pertaining to all activities carried
        out on the site ID. To obtain all actions configured on the site, simply
        input "all" as the status parameter.
      operationId: GetActionStatus
      parameters:
        - name: status
          in: path
          description: >-
            Enter "all" to get details of the actions performed against the
            site.
          example: all
          required: true
          schema:
            type: string
        - name: action_name
          in: query
          description: >-
            Retrieves specific action(s) by name. Multiple action names can be
            entered by separating them with a comma. The query is case
            sensitive.
          example: Purchase, Return
          required: false
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getActionStatusresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getActionStatusresp'
        '404':
          description: AC1005 No Data Found | AC1001 Oops! Something went wrong.
        '405':
          description: AC1002 Request Not Authorized
  /actiongrouplist/{{actionGroupId}}:
    get:
      tags:
        - Action
      summary: Fetch action group details
      description: >-
        This GET method is utilized to retrieve details associated with the
        action group by specifying the Action Group ID within the environment.
      operationId: getactiongrouplistgroupid
      parameters:
        - name: actionGroupId
          in: path
          description: >-
            Enter the unique identifier that represents a specific group of
            actions.
          example: 141
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getactionGroupIdResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getactionGroupIdResp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /actiongroup/{{memberId}}:
    get:
      tags:
        - Action
      summary: Fetch all the active action group details by User ID
      description: >-
        Upon passing the GET method in the environment, the system retrieves the
        following information - 1. All enabled action groups for the site. 2.
        User-associated actions linked to any enabled actions, including earned
        points, available points to earn, used action IDs, and more.
      operationId: getactiongroupEmailId
      parameters:
        - name: memberId
          in: path
          description: >-
            Enter the user ID of the member provided by Annex Cloud to get
            information regarding active action groups.
          example: User1@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getactionGroupEmailIdResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getactionGroupEmailIdResp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/actionseries:
    post:
      tags:
        - Action
      summary: >-
        Fetch the details of the action series performed by the member using
        actionSeriesID
      operationId: PostActionseries
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                actionSeriesId:
                  description: >-
                    Enter the unique identifier associated with a specific
                    action series in a database.
                  example: 1234
                  type: integer
              required:
                - actionSeriesId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postActionseriesresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postActionseriesresp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
    get:
      tags:
        - Action
      summary: Fetch the details of action series performed by the member
      description: >-
        This method retrieves the details of all action series performed by the
        particular member by using email address.
      operationId: GetActionSeriesbyemail
      parameters:
        - name: memberId
          in: path
          description: >-
            Enter the unique email ID of the loyalty member who has performed
            the actions series.
          example: smith001@annexcloud.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getActionSeriesresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getActionSeriesresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /tierlist/all:
    get:
      tags:
        - Tiers
      summary: Tier information against site ID
      description: >-
        This method retrieves tier details against site ID. The member must use
        the site ID as a key to fetch all the details of the Tier.
      operationId: getAlltierlist
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getalltiers'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getalltiers'
        '404':
          description: AC1012 User not found
        '405':
          description: AC1002 Request Not Authorized
  /tierlist/all?page=1:
    get:
      tags:
        - Tiers
      summary: Tier information against site ID and page number
      description: >-
        This method retrieves tier details against a site ID and page number.
        Site ID and page number must be passed as a key to fetch all the details
        of the tiers.
      operationId: getAlltierlistpage
      parameters:
        - name: memberId
          in: query
          description: Enter unique ID of the member.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: >-
            Enter the page number to get the activities associated with that
            page.(Default value is 1)
          example: 5
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getalltierspage'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getalltierspage'
        '400':
          description: Invalid status value.
        '404':
          description: AC1012 User not found
        '405':
          description: AC1002 Request Not Authorized
  /products:
    post:
      tags:
        - Product
      summary: Get Product Details, Create New Products, Calculate Product Points
      description: >-
        Use the POST:/products method to get details of the products in the
        loyalty program. All fields in the response body are listed below.
        Although this is a POST method, the method performs a GET action and
        returns details of the specified products. 


        Note 1 - (Get Product Details) - To retrieve data using only the
        productId, input the product ID and leave the categoryId blank.
        Conversely, to obtain data based solely on categoryId, input only the
        categoryId and leave the productId blank.


        Note 2 - (Create New Product and Get Product Point Calculation for an
        Order) - You must provide either a Product ID or Category ID in your
        request. You do not have to provide both. If you provide a Product ID in
        the request without providing a Category ID, the API displays details of
        the specified product. If you provide a Category ID in the request, the
        API displays details for all products in the category. If you provide
        both a Product ID AND a Category ID, the API displays details for all
        products in the category.
      operationId: productcreatenew
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: >-
                Depending on the parameters you use, this method fetches product
                details, creates a new product, or performs a points calculation
                on an order.
              properties:
                Get Product Details:
                  type: object
                  description: >-
                    Enter the following details to get information regarding the
                    product.
                  properties:
                    productId:
                      description: Enter comma separated Product IDs.
                      example: pr1001,pr1002,pr1003
                      type: string
                    categoryId:
                      description: Enter comma separated Category IDs.
                      example: cat1001,cat1002
                      type: string
                Create New Product:
                  type: object
                  description: >-
                    The POST:/products method creates a single product that is
                    added into the Product Catalog. The Points Award Type,
                    Product ID and Category ID parameters must be specified when
                    creating a new product.
                  properties:
                    pointAwardType:
                      description: Enter the Point Award Type (Product or Category).
                      example: Product
                      type: string
                    productDetail:
                      type: object
                      description: Enter the product details.
                      properties:
                        productId:
                          description: Enter the Product ID.
                          example: '12345'
                          type: string
                        productName:
                          description: Enter the Product Name.
                          example: Go Go Gadget Pro
                          type: string
                        productPrice:
                          description: Enter the price per unit of the product.
                          example: 105
                          type: integer
                        productPointType:
                          description: >-
                            Enter the product point type. No - No points
                            awarded, Yes - Points awarded, Bonus - Bonus points
                            awarded.
                          example: 'Yes'
                          type: string
                        productPointRatio:
                          description: >-
                            Enter the point ratio for the product. A ratio is a
                            multiplier applied to a point award based on
                            specific criteria (Product, Tier, Category,
                            Campaign) For example, if the productPointRatio is
                            3, the points awarded are multiplied by 3.
                          example: 2
                          type: integer
                        productBonus:
                          description: >-
                            If the productPointType is Bonus, enter the bonus
                            amount for the product.
                          example: 30
                          type: integer
                        productBonusFlag:
                          description: >-
                            Enter the status of a flag whether the Product Bonus
                            applies. (Yes/No).
                          example: 'Yes'
                          type: string
                        productMinimumLimit:
                          description: >-
                            Enter the minimum number of units that must be
                            purchased for points to be awarded.
                          example: 4
                          type: integer
                    categoryDetail:
                      type: object
                      description: Enter the category details.
                      properties:
                        categoryId:
                          description: Enter the Category ID.
                          example: C1
                          type: string
                        categoryName:
                          description: Enter the Category Name.
                          example: Gadgets
                          type: string
                        categoryPointType:
                          description: >-
                            Enter the category point type. No - No points
                            awarded, Yes - Points awarded, Bonus - Bonus points
                            awarded
                          example: 'Yes'
                          type: string
                        categoryPointRatio:
                          description: >-
                            Enter the point ratio for the category. A ratio is a
                            multiplier applied to a point award based on
                            specific criteria (Product, Tier, Category,
                            Campaign) For example, if the categoryPointRatio
                            value is 3, awarded points are multiplied by 3.
                          example: 3
                          type: integer
                        categoryBonus:
                          description: >-
                            If the categoryPointType is Bonus, enter the bonus
                            amount for the category.
                          example: 3
                          type: integer
                        categoryBonusFlag:
                          description: >-
                            Enter the status of the flag whether the Category
                            Bonus applies. (Yes/No).
                          example: 'Yes'
                          type: string
                        categoryMaxPoints:
                          description: >-
                            Enter the maximum points that can be awarded if
                            category limit capping is enabled.
                          example: 200
                          type: integer
                        categoryLimitType:
                          description: >-
                            If the category limit capping flag is enabled, enter
                            the category limit type. Rolling or Calendar
                          example: Rolling
                          type: string
                        categoryLimitPeriod:
                          description: >-
                            Enter the category limit period. If the
                            categoryLimitType is Rolling, the value is the
                            number of days. If calendar then Day/Month/Year.
                            Applies if category limit capping flag is enabled.
                          example: '90'
                          type: string
                    productAttributes:
                      type: object
                      description: Enter the Product attributes.
                      properties:
                        upc:
                          description: Enter the Universal Product Code (UPC) of product.
                          example: 2404120a
                          type: string
                        mpn:
                          description: >-
                            Enter the Manufacturer Part Number (MPN) of the
                            product.
                          example: PPSR12345
                          type: string
                        gtin:
                          description: >-
                            Enter the Global Trade Item Number (GTIN) of the
                            product.
                          example: HSI US Dental
                          type: string
                        brandId:
                          description: Enter the Brand ID.
                          example: VOLLRA
                          type: string
                    limits:
                      type: object
                      description: Enter the category product limits.
                      properties:
                        productOrderPointsLimit:
                          description: >-
                            Enter the maximum points that can be earned on an
                            order that includes the product.
                          example: 500
                          type: integer
                        productLifetimePointsLimit:
                          description: >-
                            Enter the maximum lifetime points that can be earned
                            on purchases of the product.
                          example: 300
                          type: integer
                        categoryOrderPointsLimit:
                          description: >-
                            Enter the maximum lifetime points that can be earned
                            on purchases in the category that includes the
                            products.
                          example: 400
                          type: integer
                        categoryLifetimePointsLimit:
                          description: >-
                            Enter the maximum lifetime point limit on purchases
                            in the product category.
                          example: 400
                          type: integer
                Get Product Point Calculation for an Order:
                  type: object
                  description: >-
                    Enter the following details to calculate the product points
                    for an order.
                  properties:
                    id:
                      description: Enter the member's User ID.
                      example: abc1234
                      type: string
                    source:
                      description: Enter the Source of the order - Web or Store
                      example: web
                      type: string
                    orderDate:
                      description: >-
                        If the back dated order flag is enabled, enter the date
                        of the order in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2018-04-01T00:00:00-0700
                      type: string
                    productDetail:
                      type: object
                      description: >-
                        Enter the order details presented in the productDetail
                        object as follows.
                      properties:
                        id:
                          description: Enter the Product ID.
                          example: '12345'
                          type: string
                        categoryId:
                          description: Enter the Category ID for the product.
                          example: '1001'
                          type: string
                        secondarykey:
                          description: >-
                            Enter the secondary key if the secondary key flag is
                            ON.
                          example: abc234
                          type: string
                        productName:
                          description: Enter the product name.
                          example: Go Go Gadget Pro
                          type: string
                        categoryName:
                          description: Enter the category name of the product.
                          example: Gadgets
                          type: string
                        quantity:
                          description: Enter the quantity - the number of units purchased.
                          example: '2'
                          type: string
                        unitPrice:
                          description: Enter the unit price of the product.
                          example: '105'
                          type: string
                        autoDelivery:
                          description: >-
                            This flag indicates whether auto delivery system is
                            enabled.Yes/No. NOTE - Required If Enable Loyalty V3
                            Auto Delivery flag is enabled.
                          example: 'Yes'
                          type: string
                        netPrice:
                          description: Enter the net price of the purchase.
                          example: 210
                          type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createProduct'
            application/xml:
              schema:
                $ref: '#/components/schemas/createProduct'
        '400':
          description: AC1004 Missing Parameters
        '404':
          description: AC1012 User not found | AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /bulkproducts:
    post:
      tags:
        - Product
      summary: Add New Products in Bulk
      description: >-
        Use the POST:/bulkproducts method to efficiently add several new
        products into a loyalty program's product catalog in one operation. When
        making a bulk request it is required to include the parameters for each
        product within a numbered object. For each product in the bulk request,
        you must include the Product Award Type, Product ID, and Category ID.
      operationId: createBulkproducts
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: >-
                This API is used to create several new products in one
                operation.
              properties:
                '1':
                  type: object
                  properties:
                    pointAwardType:
                      description: Enter the Point Award Type (Product or Category).
                      example: Product
                      type: string
                    productDetail:
                      type: object
                      description: Enter the product details.
                      properties:
                        productId:
                          description: Enter the Product ID.
                          example: '12345'
                          type: string
                        productName:
                          description: Enter the Product Name.
                          example: Go Go Gadget Pro
                          type: string
                        productPrice:
                          description: Enter the price per unit of the product.
                          example: 105
                          type: integer
                        productPointType:
                          description: >-
                            Enter the product point type. No - No points
                            awarded, Yes - Points awarded, Bonus - Bonus points
                            awarded.
                          example: 'Yes'
                          type: string
                        productPointRatio:
                          description: >-
                            Enter the point ratio for the product. A ratio is a
                            multiplier applied to a point award based on
                            specific criteria (Product, Tier, Category,
                            Campaign) For example, if the productPointRatio is
                            3, the points awarded are multiplied by 3.
                          example: 2
                          type: integer
                        productBonus:
                          description: >-
                            If the productPointType is Bonus, enter the bonus
                            amount for the product.
                          example: 30
                          type: integer
                        productBonusFlag:
                          description: >-
                            Enter the status of a flag whether the Product Bonus
                            applies. (Yes/No).
                          example: 'Yes'
                          type: string
                        productMinimumLimit:
                          description: >-
                            Enter the minimum number of units that must be
                            purchased for points to be awarded.
                          example: 4
                          type: integer
                    categoryDetail:
                      type: object
                      description: Enter the category details.
                      properties:
                        categoryId:
                          description: Enter the Category ID.
                          example: C1
                          type: string
                        categoryName:
                          description: Enter the Category Name.
                          example: Gadgets
                          type: string
                        categoryPointType:
                          description: >-
                            Enter the category point type. No - No points
                            awarded, Yes - Points awarded, Bonus - Bonus points
                            awarded
                          example: 'Yes'
                          type: string
                        categoryPointRatio:
                          description: >-
                            Enter the point ratio for the category. A ratio is a
                            multiplier applied to a point award based on
                            specific criteria (Product, Tier, Category,
                            Campaign) For example, if the categoryPointRatio
                            value is 3, awarded points are multiplied by 3.
                          example: 3
                          type: integer
                        categoryBonus:
                          description: >-
                            If the categoryPointType is Bonus, enter the bonus
                            amount for the category.
                          example: 3
                          type: integer
                        categoryBonusFlag:
                          description: >-
                            Enter the status of the flag whether the Category
                            Bonus applies. (Yes/No).
                          example: 'Yes'
                          type: string
                        categoryMaxPoints:
                          description: >-
                            Enter the maximum points that can be awarded if
                            category limit capping is enabled.
                          example: 200
                          type: integer
                        categoryLimitType:
                          description: >-
                            If the category limit capping flag is enabled, enter
                            the category limit type. Rolling or Calendar
                          example: Rolling
                          type: string
                        categoryLimitPeriod:
                          description: >-
                            Enter the category limit period. If the
                            categoryLimitType is Rolling, the value is the
                            number of days. If calendar then Day/Month/Year.
                            Applies if category limit capping flag is enabled.
                          example: '90'
                          type: string
                    productAttributes:
                      type: object
                      description: Enter the Product attributes.
                      properties:
                        upc:
                          description: Enter the Universal Product Code (UPC) of product.
                          example: 2404120a
                          type: string
                        mpn:
                          description: >-
                            Enter the Manufacturer Part Number (MPN) of the
                            product.
                          example: PPSR12345
                          type: string
                        gtin:
                          description: >-
                            Enter the Global Trade Item Number (GTIN) of the
                            product.
                          example: HSI US Dental
                          type: string
                        brandId:
                          description: Enter the Brand ID.
                          example: VOLLRA
                          type: string
                    limits:
                      type: object
                      description: Enter the category product limits.
                      properties:
                        productOrderPointsLimit:
                          description: >-
                            Enter the maximum points that can be earned on an
                            order that includes the product.
                          example: 500
                          type: integer
                        productLifetimePointsLimit:
                          description: >-
                            Enter the maximum lifetime points that can be earned
                            on purchases of the product.
                          example: 300
                          type: integer
                        categoryOrderPointsLimit:
                          description: >-
                            Enter the maximum lifetime points that can be earned
                            on purchases in the category that includes the
                            products.
                          example: 400
                          type: integer
                        categoryLifetimePointsLimit:
                          description: >-
                            Enter the maximum lifetime point limit on purchases
                            in the product category.
                          example: 400
                          type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createBulkproducts'
            application/xml:
              schema:
                $ref: '#/components/schemas/createBulkproducts'
        '400':
          description: AC1004 Missing Parameters
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /sitedetails/{{siteId}}:
    get:
      tags:
        - Others
      summary: Get Site Details
      description: >-
        This method retrieves the details for the Annex Cloud site. The
        administrator must use the site ID to fetch the details for the site.
      operationId: getSiteDetails
      parameters:
        - name: siteId
          in: path
          description: >-
            Enter the identifier for the specific site. It is a unique numerical
            code assigned to each site provided by Annex Cloud.
          example: '29235480'
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSiteDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/getSiteDetails'
        '400':
          description: AC1004 Missing Parameters | AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/activity/:
    get:
      tags:
        - Activity
      summary: Fetch the activity details
      description: >-
        This method allows for the retrieval of details about performed
        activities. The following paths can be utilized to display the
        activities. Below are a few examples that show how you can combine query
        parameters -


        GET:
        /users/{{email_id}}/activity?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&page=1
        - This method is used to display the activity details by passing the
        date range and page number. For example, if the start and end dates are
        2021-01-01 and 2022-12-21 respectively, and page=1, all activities
        performed between those dates and listed on page 1 are displayed here.


        GET:
        /users/{{email_id}}/activity?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&numberOfActivities=5
        - This method is used to display the activity details activity details
        by passing the date range and the number of activities. For example, if
        the start and end dates are 2021-01-01 and 2022-12-21 respectively, and
        the number of activities = 5, just 5 activities per page that were
        created between these date ranges are displayed.


        GET:
        /users/{{email_id}}/activity?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD&numberOfActivities=5&page=5
        - This method is used to display the activity details activity details
        by passing the date range, number of activities, and page number. For
        example, if the start and end dates are 2021-01-01 and 2022-12-21,
        respectively, and the number of activities = 5, then just the 5
        activities created between these date ranges and listed on page number 5
        are displayed.


        The response body for all the activity API is the same as the response
        body of GET: /users/{id}/activity method.
      operationId: getactivityqueryreq
      parameters:
        - name: page
          in: query
          description: >-
            Enter the page number. Note - /users/{{email_id}}/activity?page=1 -
            This method is used to display all the activities described on the
            page number entered. For example, if a member has completed 30
            activities and those activities have been displayed on 3 pages with
            10 activities on each page, the first 10 activities are displayed
            when the query parameter page=1 is passed.
          example: 1
          required: false
          schema:
            type: integer
        - name: sort_by
          in: query
          description: >-
            Enter the field by which the member's activity records should be
            sorted. The sorting can be done based on different parameters such
            as ActionId or Date. Note -
            /users/{{email_id}}/activity?sort_by=action_id&sort_value=107 - This
            method is used to display all the activities performed by the member
            can be sorted by passing the action ID. For example, the action ID
            for manual credit/debit is 100, while the action ID for purchase is
            109. If you wanted to see all manual credit/debit activity, you
            would pass action ID 100.
          example: ActionId
          required: false
          schema:
            type: string
        - name: sort_value
          in: query
          description: >-
            Enter the value of the field used for sorting member's activities.
            Note -
            /users/{{email_id}}/activity?sort_by=action_id&sort_value=100&page=5
            - This method is used to display the activity details by passing the
            action ID and page number. For example, if the action ID is 100 and
            the page number is 5, all information on activities performed with
            action ID 100 and listed on page number 5 is displayed.
          example: 107
          required: false
          schema:
            type: integer
        - name: start_date
          in: query
          description: >-
            Enter the date in YYYY-MM-DD format to only include those activities
            that occurred on or after the specified start date. Note -
            /users/{id}/activity?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD -
            This method is used to display all the member’s activity within a
            specified time frame. For example, if the start and end dates are
            January 1st, 2022 and May 5th, 2022 respectively, all activities
            performed between these dates are displayed. Note - The start and
            end dates must be entered in YYYY-MM-DD format.
          example: '2022-07-15'
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          description: >-
            Enter the date in YYYY-MM-DD format to only include those activities
            that occurred on or before the specified start date. Note -
            /users/{id}/activity?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD -
            This method is used to display all the member’s activity within a
            specified time frame. For example, if the start and end dates are
            January 1st, 2022 and May 5th, 2022 respectively, all activities
            performed between these dates are displayed. Note - The start and
            end dates must be entered in YYYY-MM-DD format.
          example: '2022-07-15'
          required: false
          schema:
            type: string
        - name: numberOfActivities
          in: query
          description: >-
            Enter the maximum number of activity records to be returned in the
            response. Note - /users/{id}/activity?numberOfActivities=10 - This
            method is used to display a set number of activities performed by
            the member. For example, if the number of activities is set to 10,
            then while fetching the activity details, it will show 10 activities
            per page.
          example: '10'
          required: false
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getactivityresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getactivityresp'
        '403':
          description: AC1009 Opt-out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/tiers:
    get:
      tags:
        - Tiers
      summary: Get tier information for a loyalty member
      description: >-
        This method retrieves tier details for a specific member. Enter the
        member's user ID as a key to fetch all tier details for that member.
      operationId: getTiersInfo
      parameters:
        - name: memberId
          in: path
          description: Enter unique ID of the member.
          example: user@domain.com
          required: true
          schema: null
          type: string
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getTiersInfo'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/getTiersInfo'
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1012 User not found | AC1005 No data found
        '405':
          description: AC1002 Request not authorized | AC1008 User is blocked
  /users/{{memberId}}/reward:
    get:
      tags:
        - Rewards
      summary: Fetch the list of all rewards for a member
      description: >-
        This method can be used to retrieve a list of all available rewards
        against a member ID. The administrator needs to pass a unique member ID
        as the key to fetch the details. A query parameter rewardSequence can be
        used to sort reward based on sequence. The response body for this method
        is the same as the response body for the GET-/users/{{id}}/reward
        method. GET-/users/{{id}}/reward?sort_by=rewardSequence - This method is
        used to sort the reward based on sequence.
      operationId: getRewardsByUser
      parameters:
        - name: memberId
          in: path
          description: Enter the unique member ID.
          example: John.j45@gmail.com
          required: true
          schema: null
          type: string
        - name: rewardSequence
          in: query
          description: Enter the reward sequence number.
          example: 5
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRewardsByUser'
            application/xml:
              schema:
                $ref: '#/components/schemas/getRewardsByUser'
        '400':
          description: >-
            AC3075 Entered key not used in filter. | AC3076 The numeric value
            entered is not in the correct format. | AC3077 The date value
            entered is not in the correct format. | AC3078 The entered value is
            not in the correct format. | AC1011 User not eligible for rewards |
            User does not have enough points to complete this action | User has
            reached the maximum claim limit. | Reward is not available for this
            year. | Reward is not available for this duration. | User does not
            have enough lifetime points to complete this action. | User does not
            have enough purchases to complete this action. | User does not
            belong to the segment to complete this action. | User does not have
            enough points this year to complete this action. | User does not
            earn enough points this year to complete this action. | User does
            not belong to the tier to complete this action.
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/usedreward:
    get:
      tags:
        - Rewards
      summary: Fetch the list of all rewards used by a member
      description: >-
        Using this method, you can retrieve the details of all rewards that have
        been used by a specific loyalty member. To access the rewards, you need
        to pass the unique member ID.
      operationId: getusedreward
      parameters:
        - name: memberId
          in: path
          description: Enter the unique member ID.
          example: John.j45@gmail.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getUsedRewards'
            application/xml:
              schema:
                $ref: '#/components/schemas/getUsedRewards'
        '400':
          description: >-
            AC3075 Entered key not used in filter. | AC3076 The numeric value
            entered is not in the correct format. | AC3077 The date value
            entered is not in the correct format. | AC3078 The entered value is
            not in the correct format. | AC1011 User not eligible for rewards |
            User does not have enough points to complete this action | User has
            reached the maximum claim limit. | Reward is not available for this
            year. | Reward is not available for this duration. | User does not
            have enough lifetime points to complete this action. | User does not
            have enough purchases to complete this action. | User does not
            belong to the segment to complete this action. | User does not have
            enough points this year to complete this action. | User does not
            earn enough points this year to complete this action. | User does
            not belong to the tier to complete this action.
        '403':
          description: AC1005 No data found
        '404':
          description: AC1012 User not found
        '405':
          description: AC1002 Request Not Authorized
    post:
      tags:
        - Rewards
      summary: Debit points from member's account for using a reward
      description: >-
        This method is used to debit points from the member's account using
        their ID, used reward ID and code, and the number of points to be
        debited.
      operationId: usedRewardpost
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: >-
                    Enter the unique member ID from whose account points will be
                    debited.
                  example: John.j45@gmail.com
                  type: string
                rewardId:
                  description: >-
                    Enter the reward ID which will be applied during the debit
                    action (It is mandatory if the reward ID is set at the site
                    level by the administrator).
                  example: 121
                  type: integer
                debit:
                  description: >-
                    Enter the points which will be debited from the member’s
                    account.
                  example: 100
                  type: integer
                rewardCode:
                  description: Enter the reward code used by the loyalty member.
                  example: AP232
                  type: string
                source:
                  description: Enter the source from where the reward code is shared.
                  example: Web
                  type: string
                orderId:
                  description: Enter the loyalty member's order ID.
                  example: 12132ab
                  type: string
                actionAttribute:
                  type: object
                  description: >-
                    Action attributes allow you to capture additional metadata
                    about an action. If configured, enter the following details-
                  properties:
                    device:
                      description: >-
                        Enter the name of the device on which debit action will
                        be performed. This can be customized as per the client's
                        request.
                      type: string
                      example: Mobile
              required:
                - id
                - rewardId
                - debit
                - rewardCode
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postusedrewards'
            application/xml:
              schema:
                $ref: '#/components/schemas/postusedrewards'
        '400':
          description: >-
            AC1004 Missing Parameters | AC1012 User not found | AC1001 Oops!
            Something went wrong | AC1025 Unable to redeem points | AC1011 User
            not eligible for rewards | User does not have enough points to
            complete this action | User has reached the maximum claim limit |
            Reward is not available for this year | Reward is not available for
            this duration | User does not have enough lifetime points to
            complete this action | User does not have enough purchases to
            complete this action | User does not belong to the segment to
            complete this action | User does not have enough points this year to
            complete this action | User does not earn enough points this year to
            complete this action | User does not belong to the tier to complete
            this action.
        '405':
          description: AC1002 Request Not Authorized
  /rewardlist/all:
    get:
      tags:
        - Rewards
      summary: Fetch the list of all the rewards established in your loyalty program
      description: >-
        By using this method, all rewards configured against a site ID can be
        retrieved. Note - The results of this API can also be filtered by
        passing the page number in the query parameter /rewardlist/all?page=1
      operationId: getRewardsBySite
      parameters:
        - name: siteId
          in: path
          description: Enter the unique Annex Cloud site ID for the loyalty program.
          example: '29235480'
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Enter the page number.
          example: 1
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRewardsBySite'
            application/xml:
              schema:
                $ref: '#/components/schemas/getRewardsBySite'
        '400':
          description: >-
            AC1011 User not eligible for rewards | User does not have enough
            points to complete this action | User has reached the maximum claim
            limit. | Reward is not available for this year. | Reward is not
            available for this duration. | User does not have enough lifetime
            points to complete this action. | User does not have enough
            purchases to complete this action. | User does not belong to the
            segment to complete this action. | User does not have enough points
            this year to complete this action. | User does not earn enough
            points this year to complete this action. | User does not belong to
            the tier to complete this action.
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  rewardlistupdate/{{rewardId}}:
    patch:
      tags:
        - Rewards
      summary: To update reward details
      description: >-
        This method can be used to update four parameter details - rewardName,
        overallRewardLimit, creditRequired, and rewardStatus.  Note - To receive
        a successful response, the request body must include one of the
        above-mentioned four parameters along with rewardID.
      operationId: patchrewardlistrewardidre
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rewardId:
                  description: >-
                    Enter the reward ID for which you would like to update the
                    details.
                  example: '346'
                  type: string
                rewardName:
                  description: Enter the reward name.
                  example: abc123
                  type: string
                overallRewardLimit:
                  description: Enter the overall reward limit.
                  example: '10'
                  type: string
                creditRequired:
                  description: Enter credits required to redeem the reward.
                  example: '5'
                  type: string
                rewardStatus:
                  description: >-
                    Enter 1 to change the reward status to active; enter 0 for
                    inactive.
                  example: '1'
                  type: string
              required:
                - rewardId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rewardlistrewardidrewardidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/rewardlistrewardidrewardidresp'
        '400':
          description: AC1004 Missing Parameters
        '404':
          description: AC2033 User Not Allow in Multiple Group. | AC2013 Group Not Exist.
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC1007 Invalid Parameters. | AC2010 Group Already Exist. | AC2013
            Group Not Exist. | AC2034 Only Group Admin Can Update Group
            Information. | AC2015 Member Not Registered with Group. | AC2014
            User not registered with loyalty.
  /segment:
    post:
      tags:
        - Segment
      summary: Create a new user segment
      description: >-
        This API is used to create a new segment of members in the database. The
        mandatory parameter values are the name of the segment, the defined
        start date of the segment, and the defined end date of the segment.
      operationId: createsegment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: Enter the name of the new segment.
                  example: Newly Arrived Products
                  type: string
                type:
                  description: Enter the segment type.
                  example: Current Data
                  type: string
                fromDate:
                  description: >-
                    Enter the current date the segment is being created in
                    YYYY-MM-DD format.
                  example: '2024-10-01'
                  type: string
                toDate:
                  description: Enter a future date in YYYY-MM-DD format.
                  example: '2024-10-01'
                  type: string
                member:
                  description: >-
                    Enter the relevant user IDs to add members to the new
                    segment. If there are multiple user IDs, separate each ID
                    with a comma.
                  example: johnsmith81@gmail.com,rogerwaters@hotmail.com
                  type: string
                status:
                  description: Enter the status as either 'ACTIVE' or as 'INACTIVE'.
                  example: ACTIVE
                  type: string
              required:
                - name
                - member
                - status
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createSegment'
            application/xml:
              schema:
                $ref: '#/components/schemas/createSegment'
        '400':
          description: >-
            AC7011 Campaign ID is required | AC7021 User ID is required | AC7022
            User ID does not exist in the loyalty program | AC7023 Campaign is
            not active | AC7005 Campaign is already expired | AC7007 Individual
            validity is not yet started | AC7008 Individual validity is expired
            | AC7006 No Individual validity dates are found | AC7002 You have
            already activated the campaign | AC7001 This campaign does not
            require any activation | AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /eligiblesegment/{{segmentId}}:
    get:
      tags:
        - Segment
      summary: This method retrieves segment details for a specific segment ID
      description: >-
        This method retrieves segment details for all members who are eligible
        to be included in an existing segment. The administrator needs to use
        the segment ID as a key to fetch all the details of that eligible
        segment.
      operationId: eligiblesegment
      parameters:
        - name: segmentId
          in: path
          description: >-
            Enter the specific segment ID to return the segment details against
            the segments ID.
          example: 1234
          required: true
          schema:
            type: integer
        - name: page
          in: path
          description: Enter the page number.
          example: 2
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSegmentDetailsById'
            application/xml:
              schema:
                $ref: '#/components/schemas/getSegmentDetailsById'
        '400':
          description: >-
            AC7011 Campaign ID is required | AC7021 User ID is required | AC7022
            User ID does not exist in the loyalty program | AC7023 Campaign is
            not active | AC7005 Campaign is already expired | AC7007 Individual
            validity is not yet started | AC7008 Individual validity is expired
            | AC7006 No Individual validity dates are found | AC7002 You have
            already activated the campaign | AC7001 This campaign does not
            require any activation | AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /segment/{{segmentId}}:
    get:
      tags:
        - Segment
      summary: Get the segment details for a specific segment ID
      description: >-
        This method retrieves segment details for a specific segment ID. The
        user needs to use the segment ID as a key to fetch all the details for
        that particular segment.
      operationId: getSegmentId
      parameters:
        - name: segmentId
          in: path
          description: >-
            Enter the specific segment ID to return the segment details against
            the segment ID.
          example: 1234
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSegmentIdResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getSegmentIdResp'
        '400':
          description: AC1004 Bad Request
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
    patch:
      tags:
        - Segment
      summary: This API is used to update member segment
      description: >-
        The patch method is used to update existing member segments in the
        database. An update merges the given request parameters into the current
        segment. The mandatory parameter values are segment ID, segment name,
        and time duration for the segment.
      operationId: updateSegment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the ID of the segment.
                  type: integer
                  example: 1234
                name:
                  description: Enter the name of the segment.
                  type: string
                  example: Test Segment
                member:
                  description: >-
                    Enter the user IDs of the members you want to add, remove,
                    or override within an existing segment. If there are
                    multiple user IDs, separate each ID with a comma.
                  type: string
                  example: abc@test.com,lmn@test.com,xyz@test.com
                status:
                  description: Enter the status as either ‘ACTIVE’ or as ‘INACTIVE’.
                  type: string
                  example: ACTIVE
                memberUpdate:
                  description: >-
                    Enter the type of member update as either ‘add’, ‘delete’,
                    or ‘override’.
                  type: string
                  example: add
              required:
                - id
                - name
                - member
                - status
                - memberUpdate
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchsegmentidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchsegmentidresp'
        '400':
          description: >-
            AC7011 Campaign ID is required | AC7021 User ID is required | AC7022
            User ID does not exist in the loyalty program | AC7023 Campaign is
            not active | AC7005 Campaign is already expired | AC7007 Individual
            validity is not yet started | AC7008 Individual validity is expired
            | AC7006 No Individual validity dates are found | AC7002 You have
            already activated the campaign | AC7001 This campaign does not
            require any activation | AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /segmentlist/status:
    get:
      tags:
        - Segment
      summary: This API is used to get all the segments against the site ID
      description: >-
        This method retrieves details of all segments available against the site
        ID. The administrator defines the ‘status’ parameter as either ‘all,’
        ‘active,’ or ‘inactive’ in order to display a list of all the segments
        contained within the loyalty program (regardless of status), all the
        active segments within the program, or all the inactive segments within
        the program, respectively.
      operationId: getSegmentListstatus
      parameters:
        - name: status
          in: path
          description: >-
            Enter ‘all', ‘active’, or ‘inactive’ as the status to get details on
            all the available segments.
          example: all
          required: true
          schema:
            type: string
        - name: page
          in: path
          description: Enter the page number.
          example: 2
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSegmentList'
            application/xml:
              schema:
                $ref: '#/components/schemas/getSegmentList'
        '400':
          description: AC1004 Bad Request
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /bulksegmentupdate:
    post:
      tags:
        - Segment
      summary: Add, override, or delete users in bulk
      description: >-
        This API is used to add, override, or delete users in bulk in the
        database. The segment ID, a list of user IDs, and defining the
        ‘memberUpdate’ parameter as ‘add’, ‘override,’ or ‘delete’ are required
        to update the existing segments. ",
      operationId: postBulkSegment
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the ID of the segment.
                  example: 1234
                  type: integer
                name:
                  description: Enter the name of the segment.
                  example: Test segment
                  type: string
                member:
                  description: >-
                    Enter the user IDs of the members you want to add, remove,
                    or override within an existing segment. If there are
                    multiple user IDs, separate each ID with a comma.
                  example: abc@test.com, lmn@test.com, xyz@test.com.
                  type: string
                status:
                  description: Enter the status as either ‘ACTIVE’ or as ‘INACTIVE’.
                  example: Active
                  type: string
                memberUpdate:
                  description: >-
                    Enter the type of member update as either ‘add’, ‘delete’,
                    or ‘override’.
                  example: add
                  type: string
              required:
                - id
                - name
                - member
                - status
                - memberUpdate
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postBulkSegmentResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postBulkSegmentResp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC7011 Campaign ID is required | AC7021 User ID is required | AC7022
            User ID does not exist in the loyalty program | AC7023 Campaign is
            not active | AC7005 Campaign is already expired | AC7007 Individual
            validity is not yet started | AC7008 Individual validity is expired
            | AC7006 No Individual validity dates are found | AC7002 You have
            already activated the campaign | AC7001 This campaign does not
            require any activation | AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /bulkpoints:
    post:
      tags:
        - Points
      summary: To deduct or award loyalty points to multiple members
      description: >-
        This method allows you to simultaneously deduct or award points to
        multiple members. To make a bulk point adjustment you will number each
        object in the request. Nested within each object, you must include the
        id, actionId, and activity parameters. If you are manually crediting
        points or debiting points, you must also include the credit or debit
        parameter accordingly. If you are crediting points for a point awarding
        action configured in the loyalty program, you do not need to include the
        credit parameter, as it will award the member points as configured in
        the system for that action ID.
      operationId: postbulkpoints
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                '1':
                  type: object
                  description: Enter the following details of the member.
                  properties:
                    id:
                      description: Enter the member's unique ID.
                      example: user@domain.com
                      type: string
                    actionId:
                      description: >-
                        Enter the unique action ID for awarding or deducting
                        points from the member's account. For instance, the
                        action ID for manual credit is 100.
                      example: '100'
                      type: string
                    activity:
                      description: Enter the activity as CREDIT or DEBIT.
                      example: CREDIT
                      type: string
                    debit/credit:
                      description: >-
                        Enter the number of points to be credited or debited
                        from the member’s account.
                      example: 100
                      type: integer
                    reason:
                      description: >-
                        Enter the reason for awarding or deducting points from
                        the member's account.
                      example: Bonus points
                      type: string
                    storeId:
                      description: >-
                        Enter the store ID, a unique number used to identify the
                        specific store. Note - If a store ID is provided with
                        any action and it exists in the metadata, all associated
                        attributes of that store will be displayed. If the store
                        ID does not exist in the metadata, it will simply
                        display the store ID itself.
                      example: IN12369
                      type: string
              required:
                - '1'
      responses:
        '200':
          description: >-
            Successful operation | AC1026 Points cannot be awarded due to limit
            reached|AC1028 Points can be earned next in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbulkpointsresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postbulkpointsresp'
        '400':
          description: >-
            AC1001 Oops! Something went wrong|AC1004 Missing Parameters|AC1005
            No data found|AC1007 Invalid Parameters|AC1011 User not eligible for
            rewards|AC1011 Member does not have enough points to complete this
            action|AC1011 Member has reached the maximum claim limit|AC1011
            Reward is not available for this year|AC1011 Reward is not available
            for this duration|AC1011 Member does not have enough lifetime points
            to complete this action.|AC1011 Member does not have enough
            purchases to complete this action.|AC1011 Member does not belong to
            the segment to complete this action.|AC1011 Member does not have
            enough points this year to complete this action.|AC1011 Member does
            not earn enough points this year to complete this action.|AC1011
            Member does not belong to the tier to complete this action.|AC1012
            User not found|AC1025 Unable to redeem points|AC1033 Invalid
            Parameter Value Passed|AC1043 User is not eligible for rewards
            redemption. Maximum
        '403':
          description: >-
            AC1009 Opt out member|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1009 Opt out user|AC1070
            Sender/Recipient Member should be opted in to transfer points
        '404':
          description: >-
            AC1005 No data found|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1005 No data found|AC1068 Invalid
            User ID (sender cannot send points to itself)|AC2013 Group Not
            Exist|AC2015 Member Not Registered With Group|AC2016 Loyalty setting
            not set|AC2017 Points Not Available|AC2022 User is not active member
            in group|AC2023 Group is inactive
        '405':
          description: >-
            AC1002 Request Not Authorized|AC1058 Member does not have enough
            points to complete this action|AC1059 Member has reached the maximum
            claim limit|AC1066 Overall reward limit has been reached Please
            increase the limit to allow additional claims
        '422':
          description: >-
            AC1081 The Member Is Not Part Of The Specified Group ID|AC1082 The
            Member Does Not Have The Necessary Permissions To Redeem Group
            Points|AC1083 The Group ID does not exist. Please use a valid Group
            ID
  /products/{{prod_id}}:
    get:
      tags:
        - Product
      summary: Retrieve product information for a specific product
      description: >-
        This method retrieves product details for a specific product ID. User
        needs to use product ID as a key to fetch all the details of that
        particular product.
      operationId: getProductInfo
      parameters:
        - name: prod_id
          in: path
          description: Enter the unique Product ID.
          example: 12345
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getProductInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/getProductInfo'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
    patch:
      tags:
        - Product
      summary: Update Existing Product Information
      description: >-
        The PATCH method is used for updates of existing product information.
        The Point Award Type and Product ID must be specified to update product
        information. If you enter a different value for any of these fields, the
        database is updated with the new value. If you enter the existing value
        for any of these fields, the database is not changed. If you do not
        include certain fields in the request, or if you do not enter a value
        for these fields, the database is not updated. You must provide either a
        Product ID or Category ID in your request. You do not have to provide
        both. If you provide a Product ID in the request without providing a
        Category ID, the API displays details of the specified product. If you
        provide a Category ID in the request, the API displays details for all
        products in the category. If you provide both a Product ID and a
        Category ID, the API displays details for all products in the category.


        Note - The product's price must be included in the request body even if
        it is not being altered as part of the update. If the productPrice
        parameter is not included in the request, the price of the product will
        update to 0 in the Product Catalog.
      operationId: updateProduct
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                pointAwardType:
                  description: Enter the Point Award Type. Product or Category.
                  example: Product
                  type: string
                productDetail:
                  type: object
                  description: Enter the product details.
                  properties:
                    productId:
                      description: Enter the Product ID.
                      example: '12345'
                      type: string
                    productName:
                      description: Enter the Product Name.
                      example: Go Go Gadget Pro
                      type: string
                    productPrice:
                      description: Enter the price per unit of the product.
                      example: '50'
                      type: string
                    productPointType:
                      description: >-
                        Enter the product point type. No - No points awarded,
                        Yes - Points awarded, Bonus - Bonus points awarded.
                      example: 'Yes'
                      type: string
                    productPointRatio:
                      description: >-
                        Enter the point ratio for the product. A ratio is a
                        multiplier applied to a point award based on specific
                        criteria (Product, Tier, Category, Campaign) For
                        example, if the productPointRatio is 3, the points
                        awarded are multiplied by 3.
                      example: 3
                      type: integer
                    productBonus:
                      description: >-
                        If the productPointType is Bonus, enter the bonus amount
                        for the product.
                      example: 50
                      type: integer
                    productBonusFlag:
                      description: >-
                        Enter the status of a flag whether the Product Bonus
                        applies. (Yes/No).
                      example: 'Yes'
                      type: string
                    productMinimumLimit:
                      description: >-
                        Enter the minimum number of units that must be purchased
                        for points to be awarded.
                      example: 1
                      type: integer
                categoryDetail:
                  type: object
                  description: Enter the category details.
                  properties:
                    categoryId:
                      description: Enter the Category ID.
                      example: '1'
                      type: string
                    categoryName:
                      description: Enter the Category Name.
                      example: Gadgets
                      type: string
                    categoryPointType:
                      description: >-
                        Enter the category point type. No - No points awarded,
                        Yes - Points awarded, Bonus - Bonus points awarded
                      example: 'Yes'
                      type: string
                    categoryPointRatio:
                      description: >-
                        Enter the point ratio for the category. A ratio is a
                        multiplier applied to a point award based on specific
                        criteria (Product, Tier, Category, Campaign) For
                        example, if the categoryPointRatio value is 3, awarded
                        points are multiplied by 3.
                      example: 3
                      type: integer
                    categoryBonus:
                      description: >-
                        If the categoryPointType is Bonus, enter the bonus
                        amount for the category.
                      example: 50
                      type: integer
                    categoryBonusFlag:
                      description: >-
                        Enter the status of the flag whether the Category Bonus
                        applies. (Yes/No).
                      example: 'Yes'
                      type: string
                    categoryMaxPoints:
                      description: >-
                        Enter the maximum points that can be awarded if category
                        limit capping is enabled.
                      example: 50
                      type: integer
                    categoryLimitType:
                      description: >-
                        If the category limit capping flag is enabled, enter the
                        category limit type. Rolling or Calendar
                      example: Rolling
                      type: string
                    categoryLimitPeriod:
                      description: >-
                        Enter the category limit period. If the
                        categoryLimitType is Rolling, the value is the number of
                        days. If calendar then Day/Month/Year. Applies if
                        category limit capping flag is enabled.
                      example: '180'
                      type: string
                productAttributes:
                  type: object
                  description: Enter the Product attributes.
                  properties:
                    upc:
                      description: Enter the Universal Product Code (UPC) of product.
                      example: 2404120a
                      type: string
                    mpn:
                      description: Enter the Manufacturer Part Number (MPN) of the product.
                      example: PPSR12345
                      type: string
                    gtin:
                      description: >-
                        Enter the Global Trade Item Number (GTIN) of the
                        product.
                      example: HSI US Dental
                      type: string
                    brandId:
                      description: Enter the Brand ID.
                      example: VOLLRA
                      type: string
                limits:
                  type: object
                  description: Enter the category product limits.
                  properties:
                    productOrderPointsLimit:
                      description: >-
                        Enter the maximum points that can be earned on an order
                        that includes the product.
                      example: 100
                      type: integer
                    productLifetimePointsLimit:
                      description: >-
                        Enter the maximum lifetime points that can be earned on
                        purchases of the product.
                      example: 500
                      type: integer
                    categoryOrderPointsLimit:
                      description: >-
                        Enter the maximum number of points that can be earned on
                        purchases in the product category.
                      example: 1000
                      type: integer
                    categoryLifetimePointsLimit:
                      description: >-
                        Enter the maximum lifetime point limit on purchases in
                        the product category.
                      example: 1000
                      type: integer
              required:
                - pointAwardType
                - productDetail
                - categoryDetail
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateProduct'
            application/xml:
              schema:
                $ref: '#/components/schemas/updateProduct'
        '400':
          description: AC1004 Missing Parameters
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /orders:
    post:
      tags:
        - Orders
      summary: Create a New Order
      description: >-
        Use the POST method in the Orders API to create a new order made by a
        member in the loyalty program. Each order has a unique ID and contains
        all the relevant order data such as the member placing the order, the
        order total, when the order is placed, discounts applied to the order or
        when the order ships. All other fields in the request body are listed
        below. Please note that you must enter required fields such as the ID
        and user ID parameters.


        The orderDate parameter is required to make the POST request if the
        backdated order functionality is enabled for the client via the "Enable
        Customize Orderdate In Order API " flag in the super admin.
      operationId: createorder
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the order ID for the order.
                  example: abc720
                  type: string
                userId:
                  description: Enter the unique ID of the loyalty member.
                  example: user@domain.com
                  type: string
                disregardHoldPeriod:
                  description: >-
                    Enter Yes or No based on the flag enabled. YES- instructs
                    the system to bypass the standard hold period for the points
                    associated with the order. It releases the points to the
                    member immediately, overriding the default holding period.
                    NO-  the points will follow the standard hold process before
                    being released.
                  example: 'YES'
                  type: string
                referrerCode:
                  description: >-
                    Enter the unique referrer code provided by the
                    Refer-a-Friend program (if applicable) when placing an
                    order. Note1- If you have already entered the referrer code
                    while creating a member profile, and the Auto Assign Points
                    to Referrer flag is enabled in the super admin settings,
                    there is no need to enter the code again when placing an
                    order. The system will automatically retrieve the necessary
                    information, and upon the first successful order, points
                    will be awarded to the referrer. Note2- This parameter is
                    also applicable to multi-template sites.
                  example: Abc123
                  type: string
                email:
                  description: Enter the email address of the member.
                  example: user@domain.com
                  type: string
                firstName:
                  description: Enter the first name of the loyalty member.
                  example: John
                  type: string
                lastName:
                  description: Enter the last name of the loyalty member.
                  example: Smith
                  type: string
                orderTotal:
                  description: Enter the total amount spent on the order.
                  example: 100
                  type: integer
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store. For customers who use
                    our Native Receipt Scanner (NRS) solution, this parameter is
                    auto-populated as “Receipt Upload.”
                  example: web
                  type: string
                discountAmount:
                  description: Enter the total discount amount applied to the order.
                  example: 5
                  type: integer
                coupon:
                  description: Enter the coupon code applied to the order.
                  example: SARL0RXQ12017
                  type: string
                rewardId:
                  description: >-
                    Enter the reward ID for the reward being applied to the
                    order.
                  example: 234
                  type: integer
                rewardName:
                  description: Enter the name of the reward.
                  example: Reward234
                  type: string
                shippingAmount:
                  description: >-
                    Enter the cost that will be applied for shipping the order.
                    Please note that as a pre-requisite, Action ID 1091 must be
                    configured and enabled.
                  example: 250
                  type: integer
                orderDate:
                  description: >-
                    Enter the order date in yyyy-MM-dd HH:mm:ss format. It
                    becomes a required field when backdated orders are enabled.
                    Represents the UTC order date and time. Note - This field is
                    required if the backdated order flag is enabled in the Super
                    Admin.
                  example: '2024-01-01 01:28:13'
                  type: string
                secondaryUserId:
                  description: >-
                    A list of members who have assisted in the sale. Only
                    displays if multi-level earning rules are enabled.
                  example: gt45sh
                  type: string
                orderDetail:
                  type: object
                  description: >-
                    Enter the order details for the products from the order that
                    you would like to ship in the orderDetail object as follows.
                  properties:
                    id:
                      description: Enter the unique ID of the product.
                      example: p1
                      type: string
                    productName:
                      description: Enter the name of the product.
                      example: football
                      type: string
                    quantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 2
                      type: integer
                    unitPrice:
                      description: Enter the unit price of the product.
                      example: 230
                      type: integer
                    estimatedShipDate:
                      description: >-
                        Enter the estimated date the product will be shipped in
                        yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2018-04-01T00:00:00-0700
                      type: string
                    categoryId:
                      description: Enter the category ID of the product.
                      example: 23
                      type: integer
                    categoryName:
                      description: Enter the category name of the product.
                      example: sporting goods
                      type: string
                    url:
                      description: Enter the product URL.
                      example: http://domain.com/image.gif
                      type: string
                    imageUrl:
                      description: Enter the product image URL.
                      example: http://domain.com/image.gif
                      type: string
                    transactionType:
                      description: >-
                        Enter the type of transaction. Please note, this only
                        works if the transaction type is enabled.
                      example: DEBIT
                      type: string
                    description:
                      description: Enter the applicable description of the product.
                      example: collegiate leather football
                      type: string
                    secondaryKey:
                      description: >-
                        Enter the unique secondary key. The secondary key is an
                        essential element in handling orders that contain
                        multiple products with the same product ID. If a member
                        wants to return a product after the order is shipped,
                        the system may encounter issues due to the identical
                        product IDs. However, the secondary key comes in handy
                        to differentiate between the products, enabling the
                        system to identify each product accurately and process
                        partial returns or cancellations of the order
                        successfully. Note - If the secondary key flag is
                        enabled in the Products > Actions > Action Rules >
                        Purchase > Advanced Settings > Additional Settings >
                        Enable Secondary Key for Product page, the field is
                        required; otherwise, it's optional.
                      example: p101
                      type: string
                orderAttribute:
                  type: object
                  description: >-
                    If an order attribute was previously set to mandatory, then
                    the parameter is required. If not, then the parameter
                    appears as optional.
                  properties:
                    MPC*:
                      description: Enter the MPC code.
                      example: abc12345abc
                      type: string
                    MSTN*:
                      description: >-
                        Enter the MSTN code. An asterisk ( * ) after a field
                        name indicates the parameter is a key value pair.
                      example: hf45jh
                      type: string
              required:
                - id
                - userId
                - orderDetail
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createordersresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/createordersresp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 Member has opted out
        '404':
          description: >-
            AC2029 Duplicate Secondary Key | AC1010 Duplicate order ID | AC4003
            User ID does not exist | AC1010 Duplicate Order ID | AC1053 You have
            passed invalid/inactive Multi-Template ID | AC1054 Multi-Template ID
            is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format |  AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL
  /bulkpostorder:
    post:
      tags:
        - Orders
      summary: Create New Orders in Bulk
      description: >-
        To create new orders in bulk, use this POST method in the Orders API.
        When uploading bulk orders, you will input the relevant order
        information such as the parameters for userId, orderID and orderDetails,
        for each order being passed. This is very helpful when you need to
        upload the order information for multiple orders instead of doing it as
        a single order like you would in the POST /orders method. You must
        specify the order id, user Id, product id, quantity, and unit price
        parameters for each order included in the bulk request, as they are
        mandatory fields.
      operationId: createbulkorder
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the unique order ID.
                  example: abc720
                  type: string
                userId:
                  description: Enter the unique member ID.
                  example: user@domain.com
                  type: string
                email:
                  description: Enter the email address of the member.
                  example: user@domain.com
                  type: string
                firstName:
                  description: Enter the first name of the loyalty member.
                  example: John
                  type: string
                lastName:
                  description: Enter the last name of the loyalty member.
                  example: Smith
                  type: string
                orderTotal:
                  description: >-
                    Enter the total amount of the order placed by the loyalty
                    member.
                  example: 100
                  type: integer
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store.
                  example: web
                  type: string
                discountAmount:
                  description: Enter the total discount amount on the placed order.
                  example: 10
                  type: integer
                coupon:
                  description: Enter the coupon code (if applicable).
                  example: SARL0RXQ12017
                  type: string
                rewardId:
                  description: >-
                    Enter the specific reward ID for the reward applied to the
                    order.
                  example: 1234
                  type: integer
                rewardName:
                  description: Enter the name of the reward.
                  example: Reward234
                  type: string
                shippingAmount:
                  description: >-
                    Enter the cost that will be applied for shipping the order.
                    Please note that as a pre-requisite, Action ID 1091 must be
                    configured and enabled.
                  example: 0
                  type: integer
                orderDetail:
                  type: object
                  description: >-
                    Enter the order details for the products from the order that
                    you would like to ship in the orderDetail object as follows.
                  properties:
                    id:
                      description: Enter the unique ID of the product.
                      example: 12345
                      type: integer
                    productName:
                      description: Enter the name of the product.
                      example: lorem ipsum
                      type: string
                    quantity:
                      description: Enter the quantity of the product that was purchased.
                      example: 2
                      type: integer
                    unitPrice:
                      description: Enter the unit price of the product.
                      example: 234
                      type: integer
                    estimatedShipDate:
                      description: >-
                        Enter the estimated date the product will be shipped in
                        yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2018-04-01T00:00:00-0700
                      type: string
                    categoryId:
                      description: Enter the category ID of the product.
                      example: 23
                      type: integer
                    categoryName:
                      description: Enter the category name of the product.
                      example: lorem ipsum
                      type: string
                    url:
                      description: Enter the product URL.
                      example: http://domain.com/image.gif
                      type: string
                    imageUrl:
                      description: Enter the product image URL.
                      example: http://domain.com/image.gif
                      type: string
                    description:
                      description: Enter the applicable description of the product.
                      example: XYZ Flowers
                      type: string
                    secondaryKey:
                      description: >-
                        Enter the unique secondary key. The secondary key is an
                        essential element in handling orders that contain
                        multiple products with the same product ID. If a member
                        wants to return a product after the order is shipped,
                        the system may encounter issues due to the identical
                        product IDs. However, the secondary key comes in handy
                        to differentiate between the products, enabling the
                        system to identify each product accurately and process
                        partial returns or cancellations of the order
                        successfully. Note - If the secondary key flag is
                        enabled in the Products > Actions > Action Rules >
                        Purchase > Advanced Settings > Additional Settings >
                        Enable Secondary Key for Product page, the field is
                        required; otherwise, it's optional.
                      example: p101
                      type: string
                orderAttribute:
                  type: object
                  description: >-
                    If an order attribute was previously set to mandatory, then
                    the parameter is required. If not, then the parameter
                    appears as optional.
                  properties:
                    MPC*:
                      description: Enter the MPC code.
                      example: 12345bg
                      type: string
                    MSTN*:
                      description: >-
                        Enter the MSTN code. An asterisk ( * ) after a field
                        name indicates the parameter is a key value pair.
                      example: 67890df
                      type: string
              required:
                - id
                - userId
                - orderDetail
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkorderresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/bulkorderresp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 User has opted out.
        '404':
          description: >-
            AC4003 User ID does not exist | AC1010 Duplicate Order ID | AC1053
            You have passed invalid/inactive Multi-Template ID | AC1054
            Multi-Template ID is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format | AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL | AC4028 Invalid Auto delivery value.
  /secondaryuserorders:
    get:
      tags:
        - Orders
      summary: This API is used to get the details of all the secondary member orders
      description: >-
        This field will only retrieve the information specific to that member
        for that order. Otherwise, it will return all secondary member's data.
      operationId: secondaryUserOrders
      parameters:
        - name: id
          in: path
          description: Enter the unique ID of the member.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: secondaryUser
          in: path
          description: Enter the secondary user ID.
          example: secondary_user_1
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/secondaryUserOrdersresp'
        '400':
          description: AC1004 Missing parameter | AC1005 No data found
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1012 User not found | AC1005 No data found
        '405':
          description: AC1002 Request not authorized | AC1008 User is blocked
  /orderdetails:
    post:
      tags:
        - Orders
      summary: Get order details
      description: >-
        This API is used to retrieve all of the details of an order based on
        either the user ID parameter, the order ID parameter, or both. Please
        note that if only the userId is entered, all orders placed by that
        member are returned.
      operationId: postOrderDetails
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  description: Enter the unique ID of the loyalty member.
                  example: j86.sa@gmail.com
                  type: string
                orderId:
                  description: Enter the unique ID of the loyalty member.
                  example: p1
                  type: string
              required:
                - userId
                - orderId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postOrderDetailsResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postOrderDetailsResp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 Member has opted out
        '404':
          description: >-
            AC2029 Duplicate Secondary Key | AC1010 Duplicate order ID | AC4003
            User ID does not exist | AC1010 Duplicate Order ID | AC1053 You have
            passed invalid/inactive Multi-Template ID | AC1054 Multi-Template ID
            is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format |  AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL
  /cart:
    post:
      tags:
        - Orders
      summary: >-
        Calculate the potential points of the products which are in the member's
        cart
      description: >-
        The potential points a member can earn off of the products in their cart
        are calculated by using the POST cart API. The Purchase Action must be
        properly configured before the API can function correctly.
      operationId: postCart
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                siteId:
                  description: Enter the Annex Cloud site ID for the loyalty program.
                  example: '29235480'
                  type: string
                userId:
                  description: Enter the unique user ID for the loyalty member.
                  example: user@domain.com
                  type: string
                appliedPoints:
                  description: >-
                    Enter the number of points the member has applied (for
                    redemption) on the cart page.
                  example: 20
                  type: integer
                shippingAmount:
                  description: >-
                    Enter the amount that is applied for shipping the order.
                    Please note that as a pre-requisite, Action ID 1091 must be
                    configured and enabled.
                  example: 200
                  type: integer
                discountAmount:
                  description: Enter the total discount amount on a placed order.
                  example: 1234
                  type: integer
                productDetail:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    id:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    categoryId:
                      description: Enter the category ID of the product.
                      example: 23
                      type: integer
                    categoryName:
                      description: Enter the category name of the product.
                      example: outerwear
                      type: string
                    quantity:
                      description: Enter the quantity of the product.
                      example: 2
                      type: integer
                    unitPrice:
                      description: Enter the unit price of the product.
                      example: 230
                      type: integer
                    coupon:
                      description: Enter the coupon code.
                      example: SARL0RXQ12017
                      type: string
                    storeId:
                      description: Enter the store ID.
                      example: IN12369
                      type: string
              required:
                - userId
                - productDetail
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postCartResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postCartResp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 Member has opted out
        '404':
          description: >-
            AC2029 Duplicate Secondary Key | AC1010 Duplicate order ID | AC4003
            User ID does not exist | AC1010 Duplicate Order ID | AC1053 You have
            passed invalid/inactive Multi-Template ID | AC1054 Multi-Template ID
            is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format |  AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL
  /manualspend:
    post:
      tags:
        - Orders
      summary: Manually adjust (credit or debit) the spend amount for an order
      description: >-
        To manually adjust the spend amount of an order, use this POST method.
        When adjusting the spend amount, locate the specific order using the
        orderId field and then enter when the adjustment is a credit or debit,
        the amount credited or debited, which administrator performed the
        adjustment, and the reason why the manual spend is being adjusted.
      operationId: postManuaSpend
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the order ID for the member.
                  example: abc720
                  type: string
                orderId:
                  description: Enter the order ID for the order.
                  example: '067575654'
                  type: string
                actionId:
                  description: Enter Action ID 164.
                  example: '164'
                  type: string
                credit or debit:
                  description: >-
                    To credit the spend, use the credit parameter to enter the
                    spend amount to be credited. To debit the spend, use the
                    debit parameter to enter the spend amount to be debited.
                  example: '50'
                  type: string
                activity:
                  description: Enter the activity as either CREDIT or DEBIT.
                  example: CREDIT
                  type: string
                adminEmail:
                  description: >-
                    Enter the email address of the administrator adjusting the
                    spend.
                  example: user@domain.com
                  type: string
                reason:
                  description: Enter the reason for modifying the spend amount.
                  example: Spend has been modified.
                  type: string
              required:
                - id
                - orderId
                - actionId
                - credit or debit
                - activity
                - adminEmail
                - reason
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postManualSpendResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postManualSpendResp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 Member has opted out
        '404':
          description: >-
            AC2029 Duplicate Secondary Key | AC1010 Duplicate order ID | AC4003
            User ID does not exist | AC1010 Duplicate Order ID | AC1053 You have
            passed invalid/inactive Multi-Template ID | AC1054 Multi-Template ID
            is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format |  AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL
  /orders/orderid:
    patch:
      tags:
        - Orders
      summary: Update the order
      description: >-
        Use the PATCH method in the Orders API to update the order status of a
        shipment to the ship, return, or cancel status in the input parameter.
        Orders can also be updated depending on their status as partial or full
        ship, partial or full return, and partial or full cancellation of the
        order. All other fields in the request body are listed below. If you are
        cancelling, returning, or shipping an order, use the first
        request/response body schema set. If you are adding a new product or
        changing the quantity of an existing order, use the second
        request/response body schema set.
      operationId: updateorder
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Different body parameters:
                  type: object
                  description: >-
                    Different body parameters are shown below in accordance with
                    the order update needed.
                  properties:
                    For Partial Ship:
                      type: object
                      description: Enter the following parameter details.
                      properties:
                        orderId:
                          description: Enter the original order ID.
                          example: satestorder1
                          type: string
                        status:
                          description: Enter the status as ship.
                          example: ship
                          type: string
                        disregardHoldPeriod:
                          description: >-
                            Enter Yes or No based on the flag enabled. YES-
                            instructs the system to bypass the standard hold
                            period for the points associated with the order. It
                            releases the points to the member immediately,
                            overriding the default holding period. NO-  the
                            points will follow the standard hold process before
                            being released.
                          example: 'YES'
                          type: string
                        orderDetail:
                          type: object
                          description: >-
                            Enter the order details for the products from the
                            order that you would like to ship in the orderDetail
                            object as follows.
                          properties:
                            id:
                              description: Enter the unique product ID.
                              example: p32
                              type: string
                            productName:
                              description: Enter the name of product.
                              example: socks
                              type: string
                            quantity:
                              description: Enter the quantity of the product.
                              example: 2
                              type: integer
                            unitPrice:
                              description: Enter the unit price of the product.
                              example: 75
                              type: integer
                            estimatedShipDate:
                              description: >-
                                Enter the estimated date the product will be
                                shipped in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2018-04-01T00:00:00-0700
                              type: string
                            categoryId:
                              description: Enter the category ID of the product.
                              example: 23
                              type: integer
                            categoryName:
                              description: Enter the category name of the product.
                              example: clothing
                              type: string
                            url:
                              description: Enter the product URL.
                              example: domain.com/image.gif
                              type: string
                            imageUrl:
                              description: Enter the product image URL.
                              example: domain.com/image.gif
                              type: string
                            description:
                              description: Enter the product description.
                              example: outdoor hiking socks
                              type: string
                            lastUpdatedDate:
                              description: >-
                                Enter the date on which the order was last
                                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2018-04-01T00:00:00-0700
                              type: string
                            autoDelivery:
                              description: >-
                                Enter an auto-delivery as YES or NO. If not
                                provided, then by default it is YES. Points are
                                not awarded against the product ID if the value
                                is Entered as NO if the autoDelivery flag is
                                enabled. If the autoDelivery flag is enabled,
                                then this is a mandatory (Required) field.
                              example: 'YES'
                              type: string
                            secondarykey:
                              description: >-
                                Enter the unique secondary key. The secondary
                                key is an essential element in handling orders
                                that contain multiple products with the same
                                product ID. If a member wants to return a
                                product after the order is shipped, the system
                                may encounter issues due to the identical
                                product IDs. However, the secondary key comes in
                                handy to differentiate between the products,
                                enabling the system to identify each product
                                accurately and process partial returns or
                                cancellations of the order successfully. Note -
                                If the secondary key flag is enabled in the
                                Products > Actions > Action Rules > Purchase >
                                Advanced Settings > Additional Settings > Enable
                                Secondary Key for Product page, the field is
                                required, otherwise, it's optional.
                              example: p101
                              type: string
                    For Full Ship:
                      type: object
                      description: Enter the following parameter details for the order.
                      properties:
                        orderId:
                          description: Enter the original order ID.
                          example: satestorder1
                          type: string
                        status:
                          description: Enter the status as ship.
                          example: ship
                          type: string
                    For Full Return:
                      type: object
                      description: Enter the following details for the order.
                      properties:
                        orderId:
                          description: Enter the original order ID.
                          example: satestorder1
                          type: string
                        status:
                          description: Enter the status as return.
                          example: return
                          type: string
                        reason:
                          description: Enter an explanation of why the order was returned.
                          example: credit memo
                          type: string
                        pointsRefund:
                          description: >-
                            This parameter is used to refund member's points if
                            they were used to purchase the order that is now
                            being returned. Enter the amount of points the
                            member should be refunded (if applicable).
                          example: 10
                          type: integer
                    For Partial Return:
                      type: object
                      description: Enter the following parameter details.
                      properties:
                        orderId:
                          description: Enter the original order ID.
                          example: satestorder1
                          type: string
                        status:
                          description: Enter the status as return.
                          example: return
                          type: string
                        reason:
                          description: >-
                            Enter an explanation for why part of the order was
                            returned.
                          example: credit memo
                          type: string
                        discountRefund:
                          description: >-
                            Enter the total amount of the previously applied
                            order discount for a partial return.
                          example: 10
                          type: integer
                        pointsRefund:
                          description: >-
                            This parameter is used to refund members' points if
                            they were used to purchase the order that is now
                            being returned. Enter the amount of points the
                            member should be refunded (if applicable).
                          example: 10
                          type: integer
                        updatedDiscountAmount:
                          description: >-
                            Enter the updated discount amount to partially
                            return products from the same order. Also, it works
                            only when the Enable Manual Refund On Return flag is
                            enabled in the Super Admin.
                          example: 100
                          type: integer
                        orderDetail:
                          type: object
                          description: >-
                            Enter the order details for the products from the
                            order that you would like to return in the
                            orderDetail object as follows.
                          properties:
                            id:
                              description: Enter the product ID.
                              example: p19
                              type: string
                            productName:
                              description: Enter the name of product.
                              example: toothbrush
                              type: string
                            quantity:
                              description: Enter the quantity of the product.
                              example: 2
                              type: integer
                            unitPrice:
                              description: Enter the unit price of the product.
                              example: 230
                              type: integer
                            estimatedShipDate:
                              description: >-
                                Enter the estimated date the product will be
                                shipped in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2018-04-01T00:00:00-0700
                              type: string
                            categoryId:
                              description: Enter the category ID of the product.
                              example: 23
                              type: integer
                            categoryName:
                              description: Enter the category name of the product.
                              example: oral hygiene
                              type: string
                            url:
                              description: Enter the product URL.
                              example: domain.com/image.gif
                              type: string
                            imageUrl:
                              description: Enter the product image URL.
                              example: domain.com/image.gif
                              type: string
                            description:
                              description: Enter the product description.
                              example: XYZ Flowers
                              type: string
                            lastUpdatedDate:
                              description: >-
                                Enter the date on which the order was last
                                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2018-04-01T00:00:00-0700
                              type: string
                            secondarykey:
                              description: >-
                                Enter the unique secondary key. The secondary
                                key is an essential element in handling orders
                                that contain multiple products with the same
                                product ID. If a member wants to return a
                                product after the order is shipped, the system
                                may encounter issues due to the identical
                                product IDs. However, the secondary key comes in
                                handy to differentiate between the products,
                                enabling the system to identify each product
                                accurately and process partial returns or
                                cancellations of the order successfully. Note -
                                If the secondary key flag is enabled in the
                                Products > Actions > Action Rules > Purchase >
                                Advanced Settings > Additional Settings > Enable
                                Secondary Key for Product page, the field is
                                required, otherwise, it's optional.
                              example: p101
                              type: string
                    For Full Cancel:
                      type: object
                      description: >-
                        Enter the following parameter details for the order
                        being cancelled.
                      properties:
                        orderId:
                          description: Enter the original order ID.
                          example: satestorder1
                          type: string
                        status:
                          description: Enter the status as cancel.
                          example: cancel
                          type: string
                        reason:
                          description: >-
                            Provide an explanation for why the order was
                            cancelled.
                          example: credit memo
                          type: string
                        pointsRefund:
                          description: >-
                            This parameter is used to refund members' points if
                            they were used to purchase the order that is now
                            being canceled. Enter the amount of points the
                            member should be refunded (if applicable).
                          example: 10
                          type: integer
                    For Partial Cancel:
                      type: object
                      description: Enter the following parameter details.
                      properties:
                        orderId:
                          description: Enter the original order ID.
                          example: satestorder1
                          type: string
                        status:
                          description: Enter the status as cancel.
                          example: cancel
                          type: string
                        reason:
                          description: >-
                            Provide an explanation for why part of the order is
                            being cancelled.
                          example: credit memo
                          type: string
                        discountRefund:
                          description: >-
                            Enter the total amount of the previously applied
                            order discount for the partial cancellation.
                          example: 10
                          type: integer
                        pointsRefund:
                          description: >-
                            This parameter is used to refund members' points if
                            they were used to purchase the order that is now
                            being canceled. Enter the amount of points the
                            member should be refunded (if applicable).
                          example: 10
                          type: integer
                        orderDetail:
                          type: object
                          description: >-
                            Enter the details for the products from the order
                            that you would like to cancel in the orderDetail
                            object as follows.
                          properties:
                            id:
                              description: Enter the product ID.
                              example: p1
                              type: string
                            productName:
                              description: Enter the name of product.
                              example: computer mouse
                              type: string
                            quantity:
                              description: Enter the quantity of the product.
                              example: 2
                              type: integer
                            unitPrice:
                              description: Enter the unit price of the product.
                              example: 230
                              type: integer
                            estimatedShipDate:
                              description: >-
                                Enter the estimated date the product will be
                                shipped in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2018-04-01T00:00:00-0700
                              type: string
                            categoryId:
                              description: Enter the category ID of the product.
                              example: 23
                              type: integer
                            categoryName:
                              description: Enter the category name of the product.
                              example: electronics
                              type: string
                            url:
                              description: Enter the product URL.
                              example: http://domain.com/image.gif
                              type: string
                            imageUrl:
                              description: Enter the product image URL.
                              example: http://domain.com/image.gif
                              type: string
                            description:
                              description: Enter the product description.
                              example: XYZ Flowers
                              type: string
                            secondarykey:
                              description: >-
                                Enter the unique secondary key. The secondary
                                key is an essential element in handling orders
                                that contain multiple products with the same
                                product ID. If a member wants to return a
                                product after the order is shipped, the system
                                may encounter issues due to the identical
                                product IDs. However, the secondary key comes in
                                handy to differentiate between the products,
                                enabling the system to identify each product
                                accurately and process partial returns or
                                cancellations of the order successfully. Note -
                                If the secondary key flag is enabled in the
                                Products > Actions > Action Rules > Purchase >
                                Advanced Settings > Additional Settings > Enable
                                Secondary Key for Product page, the field is
                                required, otherwise, it's optional.
                              example: p101
                              type: string
                            lastUpdatedDate:
                              description: >-
                                Enter the last updated date of the order in
                                yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2018-04-01T00:00:00-0700
                              type: string
              required:
                - orderId
                - status
                - orderId
                - status
                - orderId
                - status
                - orderDetail
                - id
                - quantity
                - unitPrice
                - orderId
                - status
                - orderId
                - status
                - orderDetail
                - id
                - quantity
                - unitPrice
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchordersresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchordersresp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 Member has opted out
        '404':
          description: >-
            AC2029 Duplicate Secondary Key | AC1010 Duplicate order ID | AC4003
            User ID does not exist | AC1010 Duplicate Order ID | AC1053 You have
            passed invalid/inactive Multi-Template ID | AC1054 Multi-Template ID
            is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format |  AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL
  /orders/orderid - Add to an existing order:
    patch:
      tags:
        - Orders
      summary: Add to an exisiting order
      description: >-
        Use the following request body schema to add new quantities or an
        additional product(s) to an existing order by entering add as the Status
        parameter value.
      operationId: updateaddexistingorder
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                orderId:
                  description: Enter the original order ID.
                  example: 123abc
                  type: string
                status:
                  description: Enter the status as Add.
                  example: Add
                  type: string
                disregardHoldPeriod:
                  description: >-
                    Enter Yes or No based on the flag enabled. YES- instructs
                    the system to bypass the standard hold period for the points
                    associated with the order. It releases the points to the
                    member immediately, overriding the default holding period.
                    NO-  the points will follow the standard hold process before
                    being released.
                  example: 'YES'
                  type: string
                orderDetail:
                  type: object
                  description: >-
                    Enter the order details for the products from the order that
                    you would like to add to the order in the orderDetail object
                    as follows.
                  properties:
                    id:
                      description: Enter the unique product ID.
                      example: p1
                      type: string
                    quantity:
                      description: Enter the quantity of the product purchased.
                      example: 2
                      type: integer
                    unitPrice:
                      description: Enter the unit price of the product.
                      example: 230
                      type: integer
                    secondarykey:
                      description: >-
                        Enter the unique secondary key. The secondary key is an
                        essential element in handling orders that contain
                        multiple products with the same product ID. If a member
                        wants to return a product after the order is shipped,
                        the system may encounter issues due to the identical
                        product IDs. However, the secondary key comes in handy
                        to differentiate between the products, enabling the
                        system to identify each product accurately and process
                        partial returns or cancellations of the order
                        successfully. Note - If the secondary key flag is
                        enabled in the Products > Actions > Action Rules >
                        Purchase > Advanced Settings > Additional Settings >
                        Enable Secondary Key for Product page, the field is
                        required; otherwise, it's optional.
                      example: p101
                      type: string
              required:
                - orderId
                - status
                - orderDetail
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchOrdersexistingorderResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchOrdersexistingorderResp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC4032 Purchase Action is not configured/enabled | AC4007 Order ID
            is missing | AC4001 User ID is missing | AC4002 User ID cannot be
            blank | AC4008 Order ID cannot be blank | AC4029 Secondary Key is
            missing | AC4030 Secondary Key cannot be blank | AC4012 Order Date
            is missing | AC4013 Order Date cannot be blank | AC4016 Product ID
            is missing | AC4017 Product ID cannot be blank | AC4018 Product
            quantity is missing | AC4022 Unit price is missing | AC4023 Unit
            price cannot be blank | AC4010 Order details are missing | AC4011
            Order details cannot be blank | AC4026 Auto Delivery parameter is
            missing | AC4027 Auto Delivery parameter cannot be blank | AC4028
            Invalid Auto delivery value | AC4015 Backdated Order limit is
            exceeded | AC2029 Duplicate Secondary Key | AC4024 Invalid unit
            price | AC4020 Invalid quantity | AC4037 Invalid value passed in the
            parameter name | AC4031 Duplicate Product ID | AC4021 Quantity is
            acceptable up to two decimal values
        '403':
          description: AC4004 Member has opted out
        '404':
          description: >-
            AC2029 Duplicate Secondary Key | AC1010 Duplicate order ID | AC4003
            User ID does not exist | AC1010 Duplicate Order ID | AC1053 You have
            passed invalid/inactive Multi-Template ID | AC1054 Multi-Template ID
            is missing
        '405':
          description: AC1002 Request Not Authorized
        '422':
          description: >-
            AC4006 Invalid Email Address format |  AC4014 Invalid Order Date
            format | AC4038 Order ID does not match with the one passed in the
            URL
  /campaign:
    post:
      tags:
        - Campaign
      summary: >-
        Get campaign details by User ID and either Campaign ID or Campaign
        Status
      description: >-
        This API is used to get the campaigns details against the user &
        campaignID.
      operationId: postcampaign
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Retrieve Campaign Details by Campaign ID and User ID:
                  type: object
                  properties:
                    userId:
                      description: >-
                        Enter the unique internal User ID. This may or may not
                        be an email address.
                      example: user@domain.com
                      type: string
                    campaignId:
                      description: Enter the unique internal Campaign ID
                      example: 10007
                      type: integer
                Retrieve Campaign Details by Campaign Status and User ID:
                  type: object
                  description: >-
                    Custom points are not predefined in the system; instead,
                    they are set and managed based on specific user-defined
                    criteria.
                  properties:
                    userId:
                      description: >-
                        Enter the unique internal User ID. This may or may not
                        be an email address.
                      example: user@domain.com
                      type: string
                    campaignStatus:
                      description: >-
                        Enter ALL- details for all campaigns. ACTIVE- details
                        for only campaigns for which the Status toggle is ON and
                        the current date falls within the Campaign Period.
                        INACTIVE- details for only campaigns for which the
                        Status toggle is OFF and the current date falls within
                        the Campaign Period. UPCOMING- details for only
                        campaigns for which the current date is earlier than the
                        Campaign Period. EXPIRED- details for only campaigns for
                        which the current date is after the Campaign Period
                      example: Active
                      type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postcampaignsResp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postcampaignsResp'
        '201':
          description: successful operation
        '400':
          description: AC1004 Missing Parameters | AC1012 User not found
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/{{status}}:
    get:
      tags:
        - Campaign
      summary: Fetch Campaign Details by Campaign Status
      description: >-
        This method retrieves campaign details for campaigns based on the
        Campaign Status. To retrieve details for all campaigns of any status,
        use campaign status = all
      operationId: getCampaignStatus
      parameters:
        - name: campaignStatus
          in: path
          description: >-
            ALL- Displays details for all campaigns. ACTIVE - Displays details
            for campaigns for which the Status toggle is ON and the current date
            falls within the Campaign Period only. INACTIVE - Displays details
            for campaigns for which the Status toggle is OFF and the current
            date falls within the Campaign Period only. UPCOMING - Displays
            details for campaigns for which the current date is earlier than the
            Campaign Period only. EXPIRED - Displays details for campaigns for
            which the current date is after the Campaign Period only.
          example: ALL
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getcampaignstatusresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getcampaignstatusresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/{{campaignId}}:
    get:
      tags:
        - Campaign
      summary: Fetch Campaign Details by Campaign ID
      description: >-
        This method retrieves campaign details for a specific Campaign ID. The
        user must provide the Campaign ID as a key to fetch all the details of
        that campaign.
      operationId: getCampaignCampaignId
      parameters:
        - name: campaignId
          in: path
          description: Enter a unique internal Campaign ID.
          example: 123
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getcampaigncampaignidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getcampaigncampaignidresp'
        '400':
          description: AC1004 Bad Request
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /users/{{memberId}}/campaign:
    get:
      tags:
        - Campaign
      summary: Fetch Campaign Details for all Campaigns for which a member is eligible
      description: >-
        This method retrieves all active eligible campaigns for a particular
        member. The user needs to use a unique user ID as a key to fetch all
        eligible campaigns for the particular member.
      operationId: getusersidcampaign
      parameters:
        - name: memberId
          in: path
          description: >-
            Enter a unique User ID. This may or may not be the user’s email
            address.
          example: user@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getusersidcampaignresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getusersidcampaignresp'
        '400':
          description: AC1004 Bad Request
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/activation/{{memberId}}:
    patch:
      tags:
        - Campaign
      summary: >-
        Reactivate the campaign to participate in it by using userId and
        campaignId details
      description: >-
        Use this PATCH campaign activation method to reactivate the campaign to
        participate in it. {Reactivation is required if the member receives
        individual validity more than one time for a campaign.}
      operationId: patchcampaignactivation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  description: Enter the unique internal User ID.
                  example: user@domain.com
                  type: string
                campaignId:
                  description: Enter a unique internal Campaign ID.
                  example: 179
                  type: integer
              required:
                - userId
                - campaignId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchcampaignactivationresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchcampaignactivationresp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC7011 Campaign ID is required | AC7021 User ID is required | AC7022
            User ID does not exist in the loyalty program | AC7023 Campaign is
            not active | AC7005 Campaign is already expired | AC7007 Individual
            validity is not yet started | AC7008 Individual validity is expired
            | AC7006 No Individual validity dates are found | AC7002 You have
            already activated the campaign | AC7001 This campaign does not
            require any activation | AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/activation:
    post:
      tags:
        - Campaign
      summary: >-
        Activate the campaign to participate in it by using userId and
        campaignId details
      description: >-
        Use this POST campaign activation method to let the member activate the
        campaign to participate in it.
      operationId: postcampaignactivation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  description: Enter the unique internal member ID.
                  example: user@domain.com
                  type: string
                campaignId:
                  description: Enter a unique internal Campaign ID.
                  example: 179
                  type: integer
              required:
                - userId
                - campaignId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postcampaignactivationresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postcampaignactivationresp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC3086 Campaign is not yet started | AC7011 Campaign ID is required
            | AC7021 User ID is required | AC7022 User ID does not exist in the
            loyalty program | AC7023 Campaign is not active | AC7005 Campaign is
            already expired | AC7007 Individual validity is not yet started |
            AC7008 Individual validity is expired | AC7006 No Individual
            validity dates are found | AC7002 You have already activated the
            campaign | AC7001 This campaign does not require any activation |
            AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/individualvalidity:
    post:
      tags:
        - Campaign
      summary: >-
        To set a personalized individual validity period for a member within the
        general campaign period
      description: >-
        Use this POST campaign individual validity method to send individual
        validity for each target member in bulk.
      operationId: postcampaignindividualvalidity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                campaignId:
                  description: Enter a unique internal Campaign ID.
                  example: 179
                  type: integer
                memberDetails:
                  type: object
                  properties:
                    userId:
                      description: Enter the unique internal member ID.
                      example: user@domain.com
                      type: string
                    individualValidityStartDate:
                      description: >-
                        Enter the ID of either the primary or secondary member
                        to retain their actions. Note - Depending on whether you
                        wish to keep the actions of the primary member or the
                        secondary member, enter their ID.
                      example: 2024-07-11T15:32:00+0000
                      type: string
                    individualValidityEndDate:
                      description: >-
                        Enter the action ID. Note - This parameter is required
                        only when duplicate actions are passed.
                      example: 2024-07-11T15:32:00+0000
                      type: string
              required:
                - campaignId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postcampaignindividualvalidityresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postcampaignindividualvalidityresp'
        '201':
          description: successful operation
        '400':
          description: >-
            AC3087 Individual validity is outside the campaign validity | AC7011
            Campaign ID is required | AC7021 User ID is required | AC7022 User
            ID does not exist in the loyalty program | AC7023 Campaign is not
            active | AC7005 Campaign is already expired | AC7007 Individual
            validity is not yet started | AC7008 Individual validity is expired
            | AC7006 No Individual validity dates are found | AC7002 You have
            already activated the campaign | AC7001 This campaign does not
            require any activation | AC7003 Campaign does not exist
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/group/{{status}}:
    get:
      tags:
        - Campaign
      summary: Fetch the Campaign Groups
      description: >-
        This API method returns the response as per the campaign group status
        passed, i.e. all, active or inactive.
      operationId: getCampaignGroupStatus
      parameters:
        - name: status
          in: path
          description: >-
            Enter ACTIVE to see all the active campaign groups. Enter INACTIVE
            to see all the campaign inactive groups and ALL to see all the
            campaign groups that are present
          example: Active
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getcampaigngroupstatusresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getcampaigngroupstatusresp'
        '400':
          description: AC1004 Bad Request
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /campaign/group/{{campaignGroupId}}:
    get:
      tags:
        - Campaign
      summary: Fetch details of specific Campaign Group
      description: >-
        This method allows users to retrieve detailed information about a
        campaign group by specifying a unique Campaign Group ID.
      operationId: getCampaignGroupCampaigngroupid
      parameters:
        - name: campaignGroupId
          in: path
          description: Enter the campaign group ID.
          example: 123
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getcampaigngroupcampaigngroupidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getcampaigngroupcampaigngroupidresp'
        '400':
          description: AC1004 Bad Request
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey:
    post:
      tags:
        - Survey
      summary: This method is used to submit a response to questions in the survey
      description: >-
        This method can be used in three different ways to submit a response to
        questions in the survey. Please see the information listed below to
        identify your use case.


        Note1 - Question Type - checkbox, radio button, dropdown or scale.


        Use the request body as listed in the example below.


        Question Type - textbox, text area, or image upload.


        The request body will include the parameters listed in the example
        below, with the addition of the parameter, 'answerValue', that should be
        included in the request following the 'answerId'. The 'answerValue'
        parameter will then replace the 'answerOption' parameter in the response
        body.


        Note2 - Skip Question - When the Skip option is selected as the
        question's response, an additional parameter called 'isSkip' with the
        value entered as true, will be added to the request body's question
        object following the 'questionId' parameter. There will be no answer
        object in the request.


        In the response body, the 'questionAnsweredDate' parameter will be
        removed from the question object, and the answer object will only have
        two parameters - 'answerId' and 'answerOption'. The 'answerStat' object
        will also be removed.
      operationId: postsurvey
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  description: >-
                    Enter the unique ID of the member who is submitting a
                    response to questions in the survey.
                  example: jacklee2023.sa1301231@gmail.com
                  type: string
                surveyId:
                  description: >-
                    Enter the unique survey ID for which the member wants to
                    submit the response.
                  example: 132
                  type: string
                section:
                  type: object
                  description: >-
                    Enter the following details related to the section of the
                    survey.
                  properties:
                    sectionId:
                      description: >-
                        Enter the unique section ID for which the member wants
                        to submit the question’s response. (A survey includes
                        multiple questions for loyalty members to answer, and
                        the questions are split into various sections to help
                        them comprehend the context of the survey.)
                      example: 132
                      type: integer
                    question:
                      type: object
                      description: >-
                        Enter the following details related to question in the
                        survey.
                      properties:
                        questionId:
                          description: >-
                            Enter the unique question ID for which the member is
                            submitting the response.
                          example: 154
                          type: integer
                        answer:
                          type: object
                          description: >-
                            Enter the following details related to the answer
                            the member has selected in response to the question.
                          properties:
                            answerId:
                              description: >-
                                The question consists of multiple answers.Enter
                                the unique ID of the answer you want to select
                                as the response.It is auto generated at the time
                                of creating an answer.
                              example: 102
                              type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postsurveyresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postsurveyresp'
        '201':
          description: successful operation
        '400':
          description: AC1004 Missing Parameters | AC1012 User not found
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/all:
    get:
      tags:
        - Survey
      summary: Get details of all the surveys
      description: >-
        By using this method, all surveys configured against a site ID can be
        retrieved.
      operationId: getsurveyall
      parameters:
        - name: siteId
          in: path
          description: Enter Annex Cloud’s site ID for the loyalty program.
          example: '29235480'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getsurveyallresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getsurveyallresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}:
    get:
      tags:
        - Survey
      summary: Get survey details by survey ID
      description: >-
        This method is used to get the survey information for a specific survey
        by passing the survey ID.
      operationId: getsurveysueveyid
      parameters:
        - name: surveyId
          in: path
          description: Enter survey ID for the loyalty program.
          example: 29
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getsurveysurveyidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getsurveysurveyidresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/all/user/{{memberId}}:
    get:
      tags:
        - Survey
      summary: Get survey details by user ID
      description: >-
        By passing the user ID, you can retrieve information for all surveys
        configured for the site and the specific member’s eligibility and
        completion status for each survey.
      operationId: getsurveyalluseremailid
      parameters:
        - name: memberId
          in: path
          description: Enter Annex Cloud’s email address for the loyalty member.
          example: user@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getsurveyalluseremailidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getsurveyalluseremailidresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}:
    get:
      tags:
        - Survey
      summary: Get survey details by survey ID and user ID
      description: >-
        By passing the survey ID and user ID, information can be retrieved for a
        specific survey as well as a specific member’s eligibility and
        completion status for that survey.
      operationId: getsurveysurveyiduseremailid
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getsurveysurveyiduseremailidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getsurveysurveyiduseremailidresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}/section/all:
    get:
      tags:
        - Survey
      summary: Get section details by section all
      description: >-
        This method is used to fetch section information for a specific survey
        along with a specific member’s completion and eligibility status for the
        survey by passing the survey ID and user ID.
      operationId: getsurveysurveyiduseremailidsectionall
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionallresp
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionallresp
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}:
    get:
      tags:
        - Survey
      summary: Get section details by section ID
      description: >-
        By passing the section ID along with the survey and user ID, this method
        is used to fetch information for a specific section of a survey along
        with a specific member’s completion and eligibility status for the
        survey.
      operationId: getsurveysurveyiduseremailidsectionsectionid
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: sectionId
          in: path
          description: Enter the section ID.
          example: 232
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidresp
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidresp
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/question/all:
    get:
      tags:
        - Survey
      summary: Get question details - Question All
      description: >-
        This method is used to fetch the question details for a specific section
        of a survey along with a member’s completion and eligibility status for
        the survey.
      operationId: getsurveysurveyiduseremailidsectionsectionidquestionall
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: sectionId
          in: path
          description: Enter the section ID.
          example: 232
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidquestionallresp
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidquestionallresp
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/question/{{questionId}}:
    get:
      tags:
        - Survey
      summary: Get question details by question ID
      description: >-
        This method is used to fetch the question details for a specific
        question within a section of a survey along with a member’s completion
        and eligibility status for the survey.
      operationId: getsurveysurveyiduseremailidsectionsectionidquestionquestionid
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: sectionId
          in: path
          description: Enter the section ID.
          example: 232
          required: true
          schema:
            type: integer
        - name: questionId
          in: path
          description: >-
            Enter the question ID for which you want to fetch the question
            details.
          example: 153
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidquestionquestionidresp
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidquestionquestionidresp
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}/status:
    get:
      tags:
        - Survey
      summary: Get survey status by survey and user ID’s
      description: >-
        This method is used to fetch information related to a specific member’s
        completion of a specific survey.
      operationId: getsurveysurveyiduseremailidstatus
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getsurveysurveyiduseremailidstatusresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getsurveysurveyiduseremailidstatusresp'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /survey/{{surveyId}}/user/{{memberId}}/section/{{sectionId}}/status:
    get:
      tags:
        - Survey
      summary: Get section's completion status
      description: >-
        This method is used to fetch information related to a specific member’s
        completion of a section within a survey.
      operationId: getsurveysurveyiduseremailidsectionsectionidstatus
      parameters:
        - name: surveyId
          in: path
          description: Enter the survey ID for which you want to fetch the data.
          example: 229
          required: true
          schema:
            type: integer
        - name: memberId
          in: path
          description: >-
            Enter Annex Cloud’s email ID for the loyalty member for which you
            want to fetch the data.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: sectionId
          in: path
          description: Enter the section ID.
          example: 232
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidstatusresp
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/getsurveysurveyiduseremailidsectionsectionidstatusresp
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /group - HM:
    post:
      tags:
        - Hierarchy Management
      summary: Create group
      description: >-
        This method is used to create a group and add members to the group. The
        loyalty member who creates the group automatically becomes the group
        owner. Note - When the Group Invitation Acceptance Required flag is
        turned ON, the response body includes invitedBy and invitationStatus in
        place of the status parameter.
      operationId: postgroupHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                groupName:
                  description: Enter the name of the group which you want to create.
                  example: Loyalty Circle
                  type: string
                groupCreator:
                  description: >-
                    Enter the ID of the loyalty member who wants to create the
                    group.
                  example: b.sa113@gmail.com
                  type: string
                groupMembers:
                  type: object
                  description: >-
                    Enter the following details of the loyalty members you want
                    to add to the group.
                  properties:
                    memberId:
                      description: Enter the unique ID of the loyalty member.
                      example: b.sa24@gmail.com
                      type: string
                    userRole:
                      description: >-
                        Enter the role which you want to assign to the loyalty
                        member. There are two roles- Owner and Member.
                      example: Owner
                      type: string
                groupConfigurations:
                  type: object
                  description: >-
                    If the Enable Group Level Permission option is enabled at
                    the site level, it displays the following group level
                    configuration set by the group owner.
                  properties:
                    allowAutoTransferPointsToGroup:
                      description: >-
                        Enter YES, If you want to automatically transfer
                        members' points to the group. If you enter NO, the
                        member will have the choice to transfer their points
                        manually to the group.
                      example: 'YES'
                      type: string
                    allowGroupPointsRedemption:
                      description: >-
                        The group owner has the authority to set a rule for
                        redeeming group points. There are only two options- 1.
                        If the owner selects OWNER, only the group owner is
                        eligible to redeem group points. 2. If the owner selects
                        ALL, all the group members are eligible to redeem group
                        points. Enter OWNER or ALL, based on the authority you
                        want to give to redeem group points.
                      example: OWNER
                      type: string
              required:
                - groupName
                - groupCreator
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postgroupHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postgroupHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/{{groupId}} - HM:
    get:
      tags:
        - Hierarchy Management
      summary: Get group information
      description: >-
        This method is used to get group information by passing the unique group
        ID.
      operationId: getgroupgroupifHM
      parameters:
        - name: groupId
          in: path
          description: Enter the group ID generated during group creation.
          example: '91'
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getgroupgroupidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getgroupgroupidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
    patch:
      tags:
        - Hierarchy Management
      summary: Update group details or dissolve group
      description: >-
        This method is used to update the group details. This method can also be
        used to dissolve a group.
      operationId: patchgroupgroupidHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                updatedBy:
                  description: >-
                    Enter the ID of the group owner who wishes to update the
                    group details.
                  example: b.sa70@gmail.com
                  type: string
                groupName:
                  description: Enter the name of the group which you want to create.
                  example: Loyalty Circle
                  type: string
                groupStatus:
                  description: >-
                    Enter whether the group is currently ACTIVE, INACTIVE or
                    DELETED.
                  example: ACTIVE
                  type: string
                deleteGroup:
                  description: Enter YES if you want to delete the group.
                  example: 'YES'
                  type: string
                groupConfigurations:
                  type: object
                  description: >-
                    If the Enable Group Level Permission option is enabled at
                    the site level, it displays the following group level
                    configuration set by the group owner.
                  properties:
                    allowAutoTransferPointsToGroup:
                      description: >-
                        Enter YES, If you want to automatically transfer
                        members' points to the group. If you enter NO, the
                        member will have the choice to transfer their points
                        manually to the group.
                      example: 'YES'
                      type: string
                    allowGroupPointsRedemption:
                      description: >-
                        The group owner has the authority to set a rule for
                        redeeming group points. There are only two options- 1.
                        If the owner selects OWNER, only the group owner is
                        eligible to redeem group points. 2. If the owner selects
                        ALL, all the group members are eligible to redeem group
                        points. Enter OWNER or ALL, based on the authority you
                        want to give to redeem group points.
                      example: OWNER
                      type: string
              required:
                - updatedBy
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchgroupgroupidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchgroupgroupidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/invite/{{memberId}} - HM:
    get:
      tags:
        - Hierarchy Management
      summary: Get invite details
      description: >-
        This method is used to retrieve the invitation details for a loyalty
        member. Members can only belong to one group at a time but can receive
        multiple group invites before accepting.
      operationId: getgroupinviteemailidHM
      parameters:
        - name: memberId
          in: path
          description: >-
            Enter the ID of the loyalty member for which you want to see
            invitation details.
          example: b.sa70@gmail.com
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getgroupinviteemailidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getgroupinviteemailidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
    patch:
      tags:
        - Hierarchy Management
      summary: Accept or Decline group invitation
      description: >-
        This method is used for accepting or declining group invitations by the
        loyalty member. Note - The group acceptance criteria only works when the
        Group Invitation Acceptance Required flag is enabled at the site level.
      operationId: patchgroupinviteemailidHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: >-
                    Enter the ID of the loyalty member who wants to accept or
                    decline the group invitation.
                  example: b.sa35@gmail.com
                  type: string
                invitedMemberDetails:
                  type: object
                  description: >-
                    Enter the following details to respond to the group
                    invitation.
                  properties:
                    groupId:
                      description: >-
                        Enter the group ID to which you would like to accept or
                        decline the group invitation.
                      example: '91'
                      type: string
                    inviteSentBy:
                      description: >-
                        Enter the ID of the group owner who sent you the
                        invitation to join the group.
                      example: b.sa40@gmail.com
                      type: string
                    inviteStatus:
                      description: >-
                        Enter the invitation status as Accepted if you want to
                        join the group otherwise enter Declined.
                      example: Accepted
                      type: string
              required:
                - id
                - invitedMemberDetails
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchgroupinviteemailidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchgroupinviteemailidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/invite - HM:
    post:
      tags:
        - Hierarchy Management
      summary: Send group invitations / Add members to the group
      description: >-
        This method is used to send invitations to loyalty members if invites
        are required. If invitations are not required, this method is used to
        directly add members to a group.
      operationId: postgroupinviteHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: Enter the ID of the group owner.
                  example: b.sa35@gmail.com
                  type: string
                groupId:
                  description: Enter the group ID generated during group creation.
                  example: '91'
                  type: string
                addMemberDetails:
                  type: object
                  description: >-
                    Enter the following details of the member you want to add to
                    the group.
                  properties:
                    memberId:
                      description: Enter the unique ID of the loyalty member.
                      example: b.sa24@gmail.com
                      type: string
                    userRole:
                      description: >-
                        Enter the role which you want to assign to the loyalty
                        member. There are two roles- Owner and Member.
                      example: Owner
                      type: string
              required:
                - ID
                - groupId
                - addMemberDetails
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postgroupinviteHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postgroupinviteHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/leave/{{memberId}} - HM:
    patch:
      tags:
        - Hierarchy Management
      summary: Leave the group
      description: >-
        This method allows group members to leave the group. If the "Restrict
        Members from Leaving Group" flag is enabled at site level, members are
        not permitted to leave the group without the group owner's permission.
        This method can then be used for a group owner to approve or reject a
        request to leave.
      operationId: patchgroupleaveemailidHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                memberId:
                  description: >-
                    Enter the ID of the loyalty member who wants to leave the
                    group.
                  example: b.sa35@gmail.com
                  type: string
                groupId:
                  description: Enter the group ID of the group you want to leave.
                  example: '91'
                  type: string
                status:
                  description: Enter the status as LEAVE, APPROVE or REJECT.
                  example: LEAVE
                  type: string
                groupOwner:
                  description: >-
                    Enter the email address of the group owner. Note - If the
                    status above is APPROVE or REJECT, the groupOwner parameter
                    will be required.
                  example: b.sa56@gmail.com
                  type: string
              required:
                - memberId
                - groupId
                - status
                - groupOwner
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchgroupleaveemailidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchgroupleaveemailidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/remove/{{memberId}} - HM:
    put:
      tags:
        - Hierarchy Management
      summary: Remove a member from the group
      description: This method is used for removing a group member from the group.
      operationId: putgroupremoveemailidHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: >-
                    Enter the ID of the group owner who wants to remove group
                    members.
                  example: b.sa35@gmail.com
                  type: string
                groupId:
                  description: >-
                    Enter the group ID from which you want to remove group
                    members.
                  example: '91'
                  type: string
                membersToRemove:
                  description: >-
                    Enter the IDs of the group members you want to remove,
                    separated by commas.
                  example: b.sa42@gmail.com, b.sa110@gmail.com
                  type: string
              required:
                - id
                - groupId
                - membersToRemove
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/putgroupremoveemailidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/putgroupremoveemailidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/role/{{memberId}} - HM:
    patch:
      tags:
        - Hierarchy Management
      summary: Update Member Role
      description: >-
        This method is used to update the member's role. The group owner has the
        authority to update the member's role.
      operationId: patchgrouproleemailidHM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                memberId:
                  description: >-
                    Enter the ID of the group member for whom you want to update
                    the role.
                  example: b.sa132@gmail.com
                  type: string
                groupId:
                  description: Enter the group ID generated during group creation.
                  example: '91'
                  type: string
                groupOwner:
                  description: Enter the ID of the group owner.
                  example: b.sa42@gmail.com
                  type: string
                userRole:
                  description: >-
                    Enter the role you want to assign to the group member. There
                    are two roles- Owner and Member.
                  example: Owner
                  type: string
              required:
                - memberId
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchgrouproleemailidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchgrouproleemailidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /group/{{groupId}}/activity - HM:
    get:
      tags:
        - Hierarchy Management
      summary: Get group activity details
      description: >-
        This method is used to get the activity details of the group by passing
        unique group ID.
      operationId: getgroupgroupidactivityHM
      parameters:
        - name: groupId
          in: path
          description: Enter the group ID for which you want to see the activity details.
          example: '91'
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getgroupgroupidactivityHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getgroupgroupidactivityHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /pointsexpiry/group/{{groupId}} - HM:
    get:
      tags:
        - Hierarchy Management
      summary: Fetches the point expiration details for a specific group
      description: >-
        This API retrieves point expiration details for a specified group based
        on the provided group ID, date range, and page number. Users can group
        results by week, month, quarter, or year using the aggregate_by
        parameter. The response includes both expired points and points set to
        expire within the aggregation period.
      operationId: getpointsexpirygroupgrupidHM
      parameters:
        - name: groupId
          in: path
          description: Enter the unique identifier for the group.
          example: '91'
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          description: >-
            Enter the start date for fetching point expiration data for the
            group in yyyy-MM-dd format.
          example: '2024-04-28'
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          description: >-
            Enter the end date for fetching point expiration data for the group
            in yyyy-MM-dd format.
          example: '2024-04-28'
          required: false
          schema:
            type: string
        - name: aggregate_by
          in: query
          description: >-
            Enter a value to group point expiration data within a calendar date
            range- week, month, quarter, or year. For example- GET
            /pointsexpiry/group/{{groupId}}?aggregate_by=year | On providing the
            query parameter that is, aggregate by this method retrieves the
            points expiry details for a specified groupId, aggregated by
            quarter. It provides insight into how many points are set to expire
            within each quarter.
          example: year
          required: false
          schema:
            type: string
        - name: page
          in: query
          description: >-
            Enter the specific page number to access and view the corresponding
            records.
          example: 1
          required: false
          schema:
            type: integer
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getpointsexpirygroupgroupidHMresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getpointsexpirygroupgroupidHMresp'
        '400':
          description: AC1004 Missing parameter.
        '404':
          description: >-
            AC1001 Oops! Something went wrong | AC2033 User Not Allow in
            Multiple Group.
        '405':
          description: AC1002 Request Not Authorized
        '409':
          description: AC1006 Data already exists.
        '422':
          description: AC1007 Invalid Parameter.
  /store/{{Store_Id}}:
    get:
      tags:
        - Store
      summary: Get store details
      description: >-
        This method retrieves detailed information about a store. The
        administrator must use the store ID to fetch the details for the store.
      operationId: getStore
      parameters:
        - name: storeId
          in: path
          description: >-
            Enter the unique identifier for the specific store. It is a unique
            numerical code assigned to each store.
          example: IN12369
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStore'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetStore'
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /bulkpoststore:
    post:
      tags:
        - Store
      summary: Create stores in bulk
      description: >-
        This method is used to create stores in bulk, which enhances the process
        and saves member's time. If you pass the same store ID multiple times,
        it will show an error, and you will not be able to create the required
        store.
      operationId: Bulkpoststores
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                storeId:
                  description: >-
                    Enter the store ID, a unique number used to identify the
                    store.
                  example: IN12369
                  type: string
                storeName:
                  description: Enter the store name.
                  example: ShinePulse
                  type: string
                storeAttribute:
                  description: >-
                    Enter the store attribute. The attributes can be customized
                    as per your requirements. The data type of the attribute
                    parameters depends on the attribute data type defined while
                    creating the store attribute in the extended attribute
                    section.
                  type: object
                  properties:
                    attribute:
                      description: >-
                        Enter the attribute name. For example, the attribute
                        could be the store's country.
                      example: USA
                      type: string
              required:
                - storeId
                - storeName
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbulkpoststoreresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postbulkpoststoreresp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /bulkpatchstore:
    post:
      tags:
        - Store
      summary: Update stores information in bulk
      description: >-
        This method is utilized to update store information, such as the name
        value and its attribute values, in bulk, which saves a lot of processing
        time for the user. Once a StoreId is created, it cannot be updated.
        However, you can update the store name value and attribute value using
        this API.
      operationId: Bulkpatchstores
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                storeId:
                  description: >-
                    Enter the store ID to update the store's information, which
                    is a unique number used to identify the store.
                  example: IN12369
                  type: string
                storeName:
                  description: Enter the store name.
                  example: ShinePulse
                  type: string
                storeAttribute:
                  description: >-
                    Enter the store attribute. The attributes can be customized
                    as per your requirements. The data type of the attribute
                    parameters depends on the attribute data type defined while
                    creating the store attribute in the extended attribute
                    section.
                  type: object
                  properties:
                    attribute:
                      description: >-
                        Enter the attribute name. For example, the attribute
                        could be the store's country.
                      example: USA
                      type: string
              required:
                - storeId
                - storeName
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchbulkpatchstoreresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchbulkpatchstoreresp'
        '400':
          description: AC1004 Missing Parameters
        '403':
          description: AC1009 Opt out user
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /points/{{memberId}}:
    get:
      tags:
        - Points
      summary: To retrieve point details for a member
      description: >-
        This method retrieves point details associated with a member’s ID. The
        member needs to use their ID as a key to fetch all the points details.
      operationId: getpointsid
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the member.
          example: user@domain.com
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            Successful operation | AC1026 Points cannot be awarded due to limit
            reached|AC1028 Points can be earned next in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPointsDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/getPointsDetails'
        '400':
          description: >-
            AC1001 Oops! Something went wrong|AC1004 Missing Parameters|AC1005
            No data found|AC1007 Invalid Parameters|AC1011 User not eligible for
            rewards|AC1011 Member does not have enough points to complete this
            action|AC1011 Member has reached the maximum claim limit|AC1011
            Reward is not available for this year|AC1011 Reward is not available
            for this duration|AC1011 Member does not have enough lifetime points
            to complete this action.|AC1011 Member does not have enough
            purchases to complete this action.|AC1011 Member does not belong to
            the segment to complete this action.|AC1011 Member does not have
            enough points this year to complete this action.|AC1011 Member does
            not earn enough points this year to complete this action.|AC1011
            Member does not belong to the tier to complete this action.|AC1012
            User not found|AC1025 Unable to redeem points|AC1033 Invalid
            Parameter Value Passed|AC1043 User is not eligible for rewards
            redemption. Maximum
        '403':
          description: >-
            AC1009 Opt out member|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1009 Opt out user|AC1070
            Sender/Recipient Member should be opted in to transfer points
        '404':
          description: >-
            AC1005 No data found|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1005 No data found|AC1068 Invalid
            User ID (sender cannot send points to itself)|AC2013 Group Not
            Exist|AC2015 Member Not Registered With Group|AC2016 Loyalty setting
            not set|AC2017 Points Not Available|AC2022 User is not active member
            in group|AC2023 Group is inactive
        '405':
          description: >-
            AC1002 Request Not Authorized|AC1058 Member does not have enough
            points to complete this action|AC1059 Member has reached the maximum
            claim limit|AC1066 Overall reward limit has been reached Please
            increase the limit to allow additional claims
        '422':
          description: >-
            AC1081 The Member Is Not Part Of The Specified Group ID|AC1082 The
            Member Does Not Have The Necessary Permissions To Redeem Group
            Points|AC1083 The Group ID does not exist. Please use a valid Group
            ID
  /pointsexpiry/{{memberId}}:
    get:
      tags:
        - Points
      summary: Fetches the point expiration details for a specific member
      description: >-
        This API is used to fetch the point expiration details for a member
        based on the specified date range and page number as provided by the
        user.
      operationId: getpointsexpiryid
      parameters:
        - name: memberId
          in: path
          description: Enter the unique ID of the member.
          example: user@domain.com
          required: true
          schema:
            type: string
        - name: start_date
          in: path
          description: >-
            Enter the date on which you’d like to start pulling point expiration
            data for the member in yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2024-04-28T06:02:06+0000
          required: true
          schema:
            type: string
        - name: end_date
          in: path
          description: >-
            Enter the date on which you’d like to stop pulling point expiration
            data for the member in yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2024-04-28T06:02:06+0000
          required: true
          schema:
            type: string
        - name: aggregate_by
          in: path
          description: >-
            Enter a value to group points in a date range that have expired or
            are about to expire in a week, month, quarter, or year.
          example: month
          required: true
          schema:
            type: string
        - name: page
          in: path
          description: >-
            Enter the total number of pages of the point expiration details for
            the member.
          example: 1
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: >-
            Successful operation | AC1026 Points cannot be awarded due to limit
            reached|AC1028 Points can be earned next in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getpointsExpiryid_page'
            application/xml:
              schema:
                $ref: '#/components/schemas/getpointsExpiryid_page'
        '400':
          description: >-
            AC1001 Oops! Something went wrong|AC1004 Missing Parameters|AC1005
            No data found|AC1007 Invalid Parameters|AC1011 User not eligible for
            rewards|AC1011 Member does not have enough points to complete this
            action|AC1011 Member has reached the maximum claim limit|AC1011
            Reward is not available for this year|AC1011 Reward is not available
            for this duration|AC1011 Member does not have enough lifetime points
            to complete this action.|AC1011 Member does not have enough
            purchases to complete this action.|AC1011 Member does not belong to
            the segment to complete this action.|AC1011 Member does not have
            enough points this year to complete this action.|AC1011 Member does
            not earn enough points this year to complete this action.|AC1011
            Member does not belong to the tier to complete this action.|AC1012
            User not found|AC1025 Unable to redeem points|AC1033 Invalid
            Parameter Value Passed|AC1043 User is not eligible for rewards
            redemption. Maximum
        '403':
          description: >-
            AC1009 Opt out member|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1009 Opt out user|AC1070
            Sender/Recipient Member should be opted in to transfer points
        '404':
          description: >-
            AC1005 No data found|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1005 No data found|AC1068 Invalid
            User ID (sender cannot send points to itself)|AC2013 Group Not
            Exist|AC2015 Member Not Registered With Group|AC2016 Loyalty setting
            not set|AC2017 Points Not Available|AC2022 User is not active member
            in group|AC2023 Group is inactive
        '405':
          description: >-
            AC1002 Request Not Authorized|AC1058 Member does not have enough
            points to complete this action|AC1059 Member has reached the maximum
            claim limit|AC1066 Overall reward limit has been reached Please
            increase the limit to allow additional claims
        '422':
          description: >-
            AC1081 The Member Is Not Part Of The Specified Group ID|AC1082 The
            Member Does Not Have The Necessary Permissions To Redeem Group
            Points|AC1083 The Group ID does not exist. Please use a valid Group
            ID
  /points:
    post:
      tags:
        - Points
      summary: To deduct points, redeem points and award loyalty points to a member
      description: >-
        Use the POST method in the Points API to redeem points and award points
        to members of the loyalty program. All other fields in the request body
        are listed below.
      operationId: postpoints
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: object
                  description: >-
                    Different body parameters are shown below depending on
                    whether you’d like to redeem points or award points.
                  properties:
                    To Redeem Rewards:
                      type: object
                      properties:
                        id:
                          description: Enter the unique ID for the member.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique action ID for the redemption of
                            rewards performed by the member.
                          example: 107
                          type: integer
                        customId:
                          description: >-
                            Enter a unique ID to associate with the Action ID to
                            support unique transactions.
                          example: gadget01
                          type: string
                        rewardId:
                          description: >-
                            Enter the specific reward ID that the member wants
                            to claim or redeem. The reward should be configured
                            in the site admin.
                          example: '121'
                          type: string
                        groupId:
                          description: >-
                            Enter the member’s group ID if they’d like to redeem
                            the reward using points from the group points
                            balance. Note - If the Enable Auto Group Points
                            Redemption flag is turned on in the Hierarchy
                            Management settings, all redeemed points are
                            automatically deducted from the group point balance,
                            eliminating the need to include the group ID in the
                            request.
                          example: '91'
                          type: string
                        activity:
                          description: >-
                            Enter debit in the activity field to indicate that
                            the member is redeeming their points.
                          example: DEBIT
                          type: string
                        orderId:
                          description: Enter the loyalty member's order ID.
                          example: A12345
                          type: string
                        retry:
                          description: >-
                            The retry parameter's function is to ensure there
                            aren't any duplicate order IDs. ‘YES’ should be
                            entered if points have been previously redeemed for
                            the same order. ‘NO’ should be entered if points
                            have not been previously redeemed for the same
                            order.
                          example: 'YES'
                          type: string
                        reason:
                          description: >-
                            Enter the reason for deducting points from the
                            member’s account.
                          example: points redeemed for discount
                          type: string
                        storeId:
                          description: >-
                            Enter the store ID, a unique number used to identify
                            the specific store. Note - If a store ID is provided
                            with any action and it exists in the metadata, all
                            associated attributes of that store will be
                            displayed. If the store ID does not exist in the
                            metadata, it will simply display the store ID
                            itself.
                          example: IN12369
                          type: string
                        source:
                          description: >-
                            Enter the source from where the member performed the
                            transaction. For example, Web or App.
                          example: web
                          type: string
                        allowNegativePoints:
                          description: >-
                            Enter the following options for handling negative
                            points. 1 - Do Not Allow Negative Points 2 - Allow
                            Negative Points 3 - Set Balance to Zero.
                          example: '2'
                          type: string
                        vendorEmail:
                          description: Enter the vendor’s unique email address.
                          example: vendor@domain.com
                          type: string
                        vendorName:
                          description: Enter the vendor’s name.
                          example: John mark
                          type: string
                        actionAttribute:
                          type: object
                          description: >-
                            Action attributes allow you to capture additional
                            metadata about an action. If you are leveraging
                            action attributes, enter the following data.
                          properties:
                            attributeValue:
                              description: >-
                                Enter the attribute name that has been added to
                                the action. This attribute is nested within the
                                action attribute object, where the parameter
                                specifies an attribute name and the parameter
                                value enters the shared metadata.
                              example: shirt size
                              type: string
                      required:
                        - id
                        - actionId
                        - rewardId
                        - activity
                    To Redeem Custom Points:
                      type: object
                      description: >-
                        Note - Custom points are not predefined in the system,
                        instead, they are set and managed based on specific
                        user-defined criteria.
                      properties:
                        id:
                          description: Enter the unique ID for the member.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique action ID for the redemption of
                            custom points performed by the member.
                          example: 107
                          type: integer
                        customId:
                          description: >-
                            Enter a unique ID to associate with the Action ID to
                            support unique transactions.
                          example: gadget01
                          type: string
                        activity:
                          description: >-
                            Enter debit in the activity field to indicate that
                            the member is redeeming their custom points.
                          example: DEBIT
                          type: string
                        orderId:
                          description: Enter the loyalty member's order ID.
                          example: A12345
                          type: string
                        debit:
                          description: >-
                            Enter the number of points debited from the member’s
                            account for redeeming custom points by performing
                            the redemption action.
                          example: 121
                          type: integer
                        reason:
                          description: >-
                            Enter the reason for removing points from the
                            member’s account to redeem custom points.
                          example: custom points redeemed for discount
                          type: string
                        storeId:
                          description: >-
                            Enter the store ID, a unique number used to identify
                            the specific store. Note - If a store ID is provided
                            with any action and it exists in the metadata, all
                            associated attributes of that store will be
                            displayed. If the store ID does not exist in the
                            metadata, it will simply display the store ID
                            itself.
                          example: IN12369
                          type: string
                        source:
                          description: >-
                            Enter the source from where the member performed the
                            transaction. For example, Web or App.
                          example: web
                          type: string
                        actionAttribute:
                          type: object
                          description: >-
                            Action attributes allow you to capture additional
                            metadata about an action. If you are leveraging
                            action attributes, enter the following data.
                          properties:
                            attributeValue:
                              description: >-
                                Enter the attribute name that has been added to
                                the action. This attribute is nested within the
                                action attribute object, where the parameter
                                specifies an attribute name and the parameter
                                value enters the shared metadata.
                              example: shirt size
                              type: string
                      required:
                        - id
                        - actionId
                        - activity
                        - orderId
                        - debit
                    To Award Points:
                      type: object
                      properties:
                        id:
                          description: Enter the unique ID for the member.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique action ID of the action for which
                            points are being awarded to the member. For example,
                            the action ID for manual credit is 100.
                          example: 100
                          type: integer
                        customId:
                          description: >-
                            Enter a unique ID to associate with the Action ID to
                            support unique transactions.
                          example: gadget01
                          type: string
                        activity:
                          description: >-
                            Enter credit in the activity field to indicate that
                            the points are awarded to the member’s account.
                          example: CREDIT
                          type: string
                        credit:
                          description: >-
                            Enter the number of points credited to the member’s
                            account for performing the action.
                          example: 435
                          type: integer
                        pointType:
                          description: >-
                            Enter the value for the point type parameter, which
                            specifies the transaction type for credit and debit
                            activities. If the user sets the point type value to
                            “Regular”, it should display as “Regular” in Point
                            API response and overwrite the existing point value
                            in the activity API response. If the point type
                            parameter is included in the Point API payload but
                            no value is provided, the system will throw an error
                            indicating that the point type should not be blank.
                            If the point type is not included, the current
                            behavior is that the point response will not display
                            the point type parameter and it’s value.
                          example: Standard or Promotional
                          type: string
                        campaignId:
                          description: >-
                            Enter the campaign ID of the campaign associated
                            with the points. (The campaign ID needs to be
                            entered only if the points being awarded are
                            associated with campaign benefits).
                          example: 12345
                          type: integer
                        orderId:
                          description: Enter the loyalty member's order ID.
                          example: A12345
                          type: string
                        source:
                          description: >-
                            Enter the source from where the member performed the
                            transaction. For example, Web or App.
                          example: web
                          type: string
                        reason:
                          description: >-
                            Enter the reason for crediting points to the
                            member’s account.
                          example: bonus
                          type: string
                        storeId:
                          description: >-
                            Enter the store ID, a unique number used to identify
                            the specific store. Note - If a store ID is provided
                            with any action and it exists in the metadata, all
                            associated attributes of that store will be
                            displayed. If the store ID does not exist in the
                            metadata, it will simply display the store ID
                            itself.
                          example: IN12369
                          type: string
                        actionAttribute:
                          type: object
                          description: >-
                            Action attributes allow you to capture additional
                            metadata about an action. If you are leveraging
                            action attributes, enter the following data.
                          properties:
                            attributeValue:
                              description: >-
                                Enter the attribute name that has been added to
                                the action. This attribute is nested within the
                                action attribute object, where the parameter
                                specifies an attribute name and the parameter
                                value enters the shared metadata.
                              example: shirt size
                              type: string
                      required:
                        - id
                        - actionId
                        - activity
                        - credit
                    To Award or Deduct Custom Points from a member’s account:
                      type: object
                      description: >-
                        Note - Custom points are not predefined in the system,
                        instead, they are set and managed based on specific
                        user-defined criteria or rules. These points can be
                        awarded or deducted according to custom parameters.
                      properties:
                        id:
                          description: Enter the unique ID for the member.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique action ID for which you are
                            awarding or deducting custom points for the member.
                            For example, the action ID for manual credit or
                            debit is 100.
                          example: 100
                          type: integer
                        activity:
                          description: >-
                            Enter the name of the action to either award or
                            deduct custom points. In this case, the action name
                            is either credit (if awarding) or debit (if
                            deducting).
                          example: CREDIT or DEBIT
                          type: string
                        source:
                          description: >-
                            Enter the source from where the member performed the
                            transaction. For example, Web or App.
                          example: web
                          type: string
                        orderId:
                          description: >-
                            Enter the loyalty member's order ID. In order to
                            associate points with an activity involving both
                            credit and debit, the member’s order ID needs to be
                            entered.
                          example: A12345
                          type: string
                        credit or debit:
                          description: >-
                            Enter the number of custom points that will be
                            credited to the member’s account or debited from the
                            member’s account.
                          example: 435
                          type: integer
                        Credit[bucketName]:
                          description: >-
                            Enter the number of points in this field if you are
                            awarding the member custom points to an additional
                            point bucket. (This is only applicable if the
                            loyalty program leverages multipoint buckets).
                          example: 100
                          type: integer
                        TierCredit[bucketName]:
                          description: >-
                            Enter the number of points if you are awarding the
                            member custom points to an additional tier point
                            bucket. (This is only applicable if the loyalty
                            program leverages multiple point buckets).
                          example: 200
                          type: integer
                        reason:
                          description: >-
                            Enter the reason for awarding custom points to the
                            member’s account or deducting custom points from the
                            member’s account.
                          example: bonus
                          type: string
                        storeId:
                          description: >-
                            Enter the store ID, a unique number used to identify
                            the specific store. Note - If a store ID is provided
                            with any action and it exists in the metadata, all
                            associated attributes of that store will be
                            displayed. If the store ID does not exist in the
                            metadata, it will simply display the store ID
                            itself.
                          example: IN12369
                          type: string
                        sectionId:
                          description: >-
                            Enter the unique survey section ID the custom points
                            are associated with. (A survey includes multiple
                            questions for loyalty members to answer, and the
                            questions are split into various sections to help
                            them comprehend the context of the survey).
                          example: '654'
                          type: string
                        sectionName:
                          description: >-
                            Enter the name of the survey section that the custom
                            points are associated with. (If the member just
                            completes one section of the survey, the name of the
                            survey and the section are both entered).
                          example: main section
                          type: string
                        surveyId:
                          description: >-
                            Enter the unique Survey ID that the custom points
                            are associated with. (This identifier helps in
                            tracking and organizing survey responses, ensuring
                            that each response is linked to the correct survey
                            and participant).
                          example: '123'
                          type: string
                        surveyName:
                          description: >-
                            Enter the name of the survey the custom points are
                            associated with. (The surveys for loyalty members
                            have names based on their criteria to differentiate
                            and outline the contents of the survey in brief. If
                            the member takes the survey, the name of the survey
                            in which the member participated is entered).
                          example: general survey
                          type: string
                        customId:
                          description: >-
                            Enter the custom identification number for awarding
                            or deducting the custom points.
                          example: 1022
                          type: integer
                        actionAttribute:
                          type: object
                          description: >-
                            Action attributes allow you to capture additional
                            metadata about an action. If you are leveraging
                            action attributes, enter the following data.
                          properties:
                            attributeValue:
                              description: >-
                                Enter the attribute name that has been added to
                                the action. This attribute is nested within the
                                action attribute object, where the parameter
                                specifies an attribute name and the parameter
                                value enters the shared metadata.
                              example: shirt size
                              type: string
                      required:
                        - id
                        - actionId
                        - activity
                        - credit or debit
                    Transfer Group Points to Members:
                      type: object
                      description: >-
                        This use case occurs when a member who belongs to a
                        group initiates a point transfer, where the points are
                        debited from the group’s overall balance and credited to
                        an individual member’s account. This type of transfer is
                        commonly referred to as a manual group point transfer.
                        It is triggered using a standard action 176, and the key
                        component that distinguishes this transfer from others
                        is the presence of the groupId in the payload. When the
                        groupId is included, the system understands that the
                        transfer is being made on behalf of the group. The
                        member initiating the action is not transferring points
                        from their own personal balance but instead from the
                        collective balance of the group they are part of. The
                        recipient of these points can be any member within the
                        platform—they may belong to the same group, a different
                        group, or not belong to any group at all. There are no
                        restrictions requiring the recipient to be in the same
                        group as the sender.
                      properties:
                        id:
                          description: >-
                            Enter the unique ID for the member who is
                            transferring their points.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique action ID for the action performed
                            by the member. For example, the action ID for
                            transferring points within the group is 160.
                          example: 160
                          type: integer
                        groupId:
                          description: Enter the unique ID of the group.
                          example: '91'
                          type: string
                        activity:
                          description: >-
                            Enter debit in the activity field to indicate that
                            the points are being deducted from the member’s
                            account.
                          example: DEBIT
                          type: string
                        orderId:
                          description: Enter the loyalty member's order ID.
                          example: A12345
                          type: string
                        debit:
                          description: >-
                            Enter the number of points debited from the member’s
                            account for performing the action.
                          example: 435
                          type: integer
                        reason:
                          description: >-
                            Enter the reason for removing points from the
                            member’s account.
                          example: points transferred
                          type: string
                        userId:
                          description: >-
                            Enter the unique user ID of the group member the
                            points should be transferred to.
                          example: user@domain.com
                          type: string
                        actionAttribute:
                          type: object
                          description: >-
                            Action attributes allow you to capture additional
                            metadata about an action. If you are leveraging
                            action attributes, enter the following data.
                          properties:
                            attributeValue:
                              description: >-
                                Enter the attribute name that has been added to
                                the action. This attribute is nested within the
                                action attribute object, where the parameter
                                specifies an attribute name and the parameter
                                value enters the shared metadata.
                              example: moto
                              type: string
                      required:
                        - id
                        - actionId
                        - activity
                        - debit
                        - userId
                    Transfer Member Points to Group:
                      type: object
                      description: >-
                        Note - This only applies if the loyalty program is
                        leveraging hierarchy management groups.
                      properties:
                        id:
                          description: >-
                            Enter the unique ID for the member who is
                            transferring their points.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique action ID for the action performed
                            by the member. For example, the action ID for
                            transferring points within the group is 160.
                          example: 160
                          type: integer
                        groupId:
                          description: Enter the unique ID of the group.
                          example: '91'
                          type: string
                        activity:
                          description: >-
                            Enter credit in the activity field to indicate that
                            the points are being transferred from a member to
                            the group.
                          example: CREDIT
                          type: string
                        debit:
                          description: >-
                            Enter the number of points debited from the member’s
                            account for performing the action.
                          example: 435
                          type: integer
                        reason:
                          description: >-
                            Enter the reason for transferring the points from
                            the member’s account to the group.
                          example: points transferred
                          type: string
                        recipientData:
                          type: object
                          description: Displays details about the recipient
                          properties:
                            recipientId:
                              description: >-
                                Enter the unique ID of the member to whom the
                                points are to be transferred.
                              example: r00.000@annexcloud.com
                              type: string
                      required:
                        - id
                        - actionId
                        - adminUser
                        - activity
                        - debit
                    Transfer Points between Two Individual Members:
                      type: object
                      description: >-
                        This use case refers to a straightforward transaction
                        where one member directly transfers points from their
                        personal account to another member’s personal account.
                        Unlike the group transfer scenario, there is no group
                        involvement in this type of transaction. The sender and
                        the recipient are treated as individuals operating
                        independently of any group associations. Although the
                        same action ID (such as 176 or a similar custom action)
                        might be used to trigger both group and individual
                        transfers, the logic used to determine the source of the
                        points (group or personal) depends entirely on the
                        presence or absence of the groupID. In this transfer
                        case, since no groupId is provided, it is understood
                        that both members are acting in their personal
                        capacities. There is no expectation that either member
                        belongs to a group, nor is any group balance affected by
                        this transaction.
                      properties:
                        id:
                          description: >-
                            Enter the unique ID of the member who is
                            transferring their points.
                          example: user@domain.com
                          type: string
                        actionId:
                          description: >-
                            Enter the unique Action ID for the action performed
                            by the member. For example, the custom Action ID for
                            transferring points between two members is 8055.
                          example: 8055
                          type: integer
                        activity:
                          description: >-
                            Enter debit in the activity field to indicate that
                            the points are being transferred to the receiver.
                            (This functionality works for debit only)
                          example: DEBIT
                          type: string
                        debit:
                          description: >-
                            Enter the number of points transferred to the
                            receiver’s account on performing the action.
                          example: 435
                          type: integer
                        recipientData:
                          type: object
                          description: Enter the following details regarding the receiver.
                          properties:
                            recipientId:
                              description: >-
                                Enter the unique ID of the member to whom the
                                points are to be transferred.
                              example: r00.000@annexcloud.com
                              type: string
                      required:
                        - id
                        - actionId
                        - activity
                        - debit
      responses:
        '200':
          description: >-
            Successful operation | AC1026 Points cannot be awarded due to limit
            reached|AC1028 Points can be earned next in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPoints'
            application/xml:
              schema:
                $ref: '#/components/schemas/getPoints'
        '400':
          description: >-
            AC1001 Oops! Something went wrong|AC1004 Missing Parameters|AC1005
            No data found|AC1007 Invalid Parameters|AC1011 User not eligible for
            rewards|AC1011 Member does not have enough points to complete this
            action|AC1011 Member has reached the maximum claim limit|AC1011
            Reward is not available for this year|AC1011 Reward is not available
            for this duration|AC1011 Member does not have enough lifetime points
            to complete this action.|AC1011 Member does not have enough
            purchases to complete this action.|AC1011 Member does not belong to
            the segment to complete this action.|AC1011 Member does not have
            enough points this year to complete this action.|AC1011 Member does
            not earn enough points this year to complete this action.|AC1011
            Member does not belong to the tier to complete this action.|AC1012
            User not found|AC1025 Unable to redeem points|AC1033 Invalid
            Parameter Value Passed|AC1043 User is not eligible for rewards
            redemption. Maximum
        '403':
          description: >-
            AC1009 Opt out member|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1009 Opt out user|AC1070
            Sender/Recipient Member should be opted in to transfer points
        '404':
          description: >-
            AC1005 No data found|AC2040 Action cannot be completed, extended
            attribute value does not match|AC1005 No data found|AC1068 Invalid
            User ID (sender cannot send points to itself)|AC2013 Group Not
            Exist|AC2015 Member Not Registered With Group|AC2016 Loyalty setting
            not set|AC2017 Points Not Available|AC2022 User is not active member
            in group|AC2023 Group is inactive
        '405':
          description: >-
            AC1002 Request Not Authorized|AC1058 Member does not have enough
            points to complete this action|AC1059 Member has reached the maximum
            claim limit|AC1066 Overall reward limit has been reached Please
            increase the limit to allow additional claims
        '422':
          description: >-
            AC1081 The Member Is Not Part Of The Specified Group ID|AC1082 The
            Member Does Not Have The Necessary Permissions To Redeem Group
            Points|AC1083 The Group ID does not exist. Please use a valid Group
            ID
  /bulkpatchproducts:
    post:
      tags:
        - Product
      summary: Update Products in Bulk
      description: >-
        To update a several products at once in the loyalty program, use this
        POST method. Points Award Type, Product ID must be specified when
        updating multiple products. All other additional fields in the request
        body are listed below. If you enter a different value for any of these
        fields, the database is updated with the new value. If you enter the
        existing value for any of these fields, the database is not changed. If
        you do not include certain fields in the request, or if you do not enter
        a value for these fields, the database is not updated. You must provide
        either a Product ID or Category ID in your request. You do not have to
        provide both. If you provide a Product ID in the request without
        providing a Category ID, the API displays details of the specified
        product. If you provide a Category ID in the request, the API displays
        details for all products in the category. If you provide both a Product
        ID and a Category ID, the API displays details for all products in the
        category.
      operationId: postbulkpatchproducts
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: >-
                This API is used to update several existing products at one
                time.
              properties:
                pointAwardType:
                  description: Enter the point award type (Product or Category).
                  example: Product
                  type: string
                productDetail:
                  type: object
                  description: Enter the product details.
                  properties:
                    productId:
                      description: Enter the Product ID.
                      example: '12345'
                      type: string
                    productName:
                      description: Enter the Product Name.
                      example: Go Go Gadget Pro
                      type: string
                    productPrice:
                      description: Enter the product unit price.
                      example: 105
                      type: integer
                    productPointType:
                      description: >-
                        Enter the product point type. No - No points awarded,
                        Yes - Points awarded, Bonus - Bonus points awarded.
                      example: 'Yes'
                      type: string
                    productPointRatio:
                      description: >-
                        Enter the point ratio for the product. A ratio is a
                        multiplier applied to a point award based on specific
                        criteria (Product, Tier, Category, Campaign) For
                        example, if the productPointRatio is 3, the points
                        awarded are multiplied by 3.
                      example: 2
                      type: integer
                    productBonus:
                      description: >-
                        If the productPointType is Bonus, enter the bonus amount
                        for the product.
                      example: 30
                      type: integer
                    productBonusFlag:
                      description: >-
                        Enter the status of a flag whether the Product Bonus
                        applies. (Yes/No).
                      example: 'Yes'
                      type: string
                    productMinimumLimit:
                      description: >-
                        Enter the minimum number of units that must be purchased
                        for points to be awarded.
                      example: 4
                      type: integer
                categoryDetail:
                  type: object
                  description: Enter the category details.
                  properties:
                    categoryId:
                      description: Enter the Category ID.
                      example: Cat1
                      type: string
                    categoryName:
                      description: Enter the Category Name.
                      example: Gadgets
                      type: string
                    categoryPointType:
                      description: >-
                        Enter the category point type. No - No points awarded,
                        Yes - Points awarded, Bonus - Bonus points awarded
                      example: 'Yes'
                      type: string
                    categoryPointRatio:
                      description: >-
                        Enter the point ratio for the category. A ratio is a
                        multiplier applied to a point award based on specific
                        criteria (Product, Tier, Category, Campaign) For
                        example, if the categoryPointRatio value is 3, awarded
                        points are multiplied by 3.
                      example: 3
                      type: integer
                    categoryBonus:
                      description: >-
                        If the categoryPointType is Bonus, enter the bonus
                        amount for the category.
                      example: 30
                      type: integer
                    categoryBonusFlag:
                      description: >-
                        Enter the status of the flag whether the Category Bonus
                        applies. (Yes/No).
                      example: 'Yes'
                      type: string
                    categoryMaxPoints:
                      description: >-
                        Enter the maximum points that can be awarded if category
                        limit capping is enabled
                      example: 50
                      type: integer
                    categoryLimitType:
                      description: >-
                        If the category limit capping flag is enabled, enter the
                        category limit type. Rolling or Calendar
                      example: Rolling
                      type: string
                    categoryLimitPeriod:
                      description: >-
                        Enter the category limit period. If the
                        categoryLimitType is Rolling, the value is the number of
                        days. If calendar then Day/Month/Year. Applies if
                        category limit capping flag is enabled.
                      example: Day
                      type: string
                productAttributes:
                  type: object
                  description: Enter the Product attributes.
                  properties:
                    upc:
                      description: Enter the Universal Product Code (UPC) of product.
                      example: 2404120a
                      type: string
                    mpn:
                      description: Enter the Manufacturer Part Number (MPN) of the product.
                      example: PPSR12345
                      type: string
                    gtin:
                      description: >-
                        Enter the Global Trade Item Number (GTIN) of the
                        product.
                      example: HSI US Dental
                      type: string
                    brandId:
                      description: Enter the Brand ID.
                      example: VOLLRA
                      type: string
                limit:
                  type: object
                  description: Enter the category product limits.
                  properties:
                    productOrderPointsLimit:
                      description: >-
                        Enter the maximum points that can be earned on an order
                        that includes the product.
                      example: 50
                      type: integer
                    productLifetimePointsLimit:
                      description: >-
                        Enter the maximum lifetime points that can be earned on
                        purchases in the category that includes the products.
                      example: 300
                      type: integer
                    categoryOrderPointsLimit:
                      description: >-
                        Enter the maximum number of points that can be earned on
                        purchases in the product category.
                      example: 400
                      type: integer
                    categoryLifetimePointsLimit:
                      description: >-
                        Enter the maximum lifetime point limit on purchases in
                        the product category.
                      example: 400
                      type: integer
              required:
                - pointAwardType
                - productDetail
                - categoryDetail
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbulkpatchproductsresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postbulkpatchproductsresp'
        '400':
          description: AC1004 Missing Parameters | AC1007 Invalid Parameters
        '404':
          description: AC1005 No data found
        '405':
          description: AC1002 Request Not Authorized
  /issuance- create new issuance:
    post:
      tags:
        - Issuance
      summary: Create a new issuance
      description: >-
        Use the POST method in the Issuance API to create a new order initiated
        by a member within the loyalty program. Each order is assigned a unique
        ID and encompasses essential order details, including the member
        initiating the order, the total amount of the order, the order placement
        timestamp, any discounts applied to the order, the shipping timestamp,
        and other pertinent information. The remaining fields in the request
        body are detailed below.
      operationId: postissuance
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
                actionId:
                  description: Enter the action ID.
                  example: 174
                  type: integer
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store.
                  example: Web
                  type: string
                coupon:
                  description: Enter the name of a coupon.
                  example: $10 Off
                  type: string
                orderTotalSpend:
                  description: Enter the total amount spent on the order.
                  example: 100
                  type: integer
                orderTotalPoints:
                  description: >-
                    Enter the total number of points loyalty members can earn on
                    this issuance.
                  example: 500
                  type: integer
                orderDiscountAmount:
                  description: Enter the total discount amount on the issuance.
                  example: 50
                  type: integer
                orderStatus:
                  description: >-
                    Enter the order status. i.e., SHIP, HOLD, RETURN, CANCEL
                    based on the order status.
                  example: SHIP
                  type: string
                pointType:
                  description: >-
                    Enter the point type. The pointType is an activity type,
                    which would be an open field in the POST Issuance API
                    payload.
                  example: Regular
                  type: string
                orderDate:
                  description: Enter the order date in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                orderShipDate:
                  description: Enter the date of order shipping in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                productDetails:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    productId:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    productQuantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 23
                      type: integer
                    productPrice:
                      description: Enter the price per unit for the product.
                      example: 100
                      type: integer
                    productDiscountAmount:
                      description: >-
                        Enter the total product discount amount applied on the
                        product
                      example: 10
                      type: integer
                    productCouponCode:
                      description: >-
                        Enter the name of a product coupon code applied to the
                        product order.
                      example: abcd2344
                      type: string
                    productTotalAmount:
                      description: >-
                        Enter the total amount of the Product Purchased by the
                        loyalty member.
                      example: 200
                      type: integer
                    productTotalPoints:
                      description: Enter the total points.
                      example: 200
                      type: integer
                    productDescription:
                      description: Enter the product description.
                      example: iPad came with p10 chip and one week battery support.
                      type: string
                    productShipDate:
                      description: >-
                        Enter the date when the product will be shipped in the
                        format yyyy-MM-dd.
                      example: '2023-12-11'
                      type: string
                    issuanceProductAttribute:
                      type: object
                      description: >-
                        issuanceProductAttribute may have multiple dynamic
                        product attributes and values.
                      properties:
                        issuanceOrderAttribute:
                          type: object
                          description: >-
                            This object contain multiple dynamic attributes and
                            its values.
                          properties:
                            attribute:
                              description: Enter attribute name and value information.
                              example: Quantity
                              type: string
              required:
                - orderId
                - userId
                - actionId
                - orderTotalSpend
                - orderTotalPoints
                - orderStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postissuanceresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postissuanceresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Issuance creation for non purchase transaction:
    post:
      tags:
        - Issuance
      summary: Issuance Creation for Non-Purchase Transactions
      description: >-
        Use the POST method in the Issuance API to create a new Non-Purchase
        Transactions within the loyalty program. Each order has a unique ID and
        includes essential details like the member, total amount, order
        timestamp, discounts, shipping timestamp, and other relevant info.
        Include mandatory fields like order ID and user ID parameters.
      operationId: postissuancecreationfornonpurchasetransactions
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
                actionId:
                  description: Enter the action ID.
                  example: 174
                  type: integer
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store.
                  example: Web
                  type: string
                coupon:
                  description: Enter the name of a coupon.
                  example: $10 Off
                  type: string
                orderTotalSpend:
                  description: Enter the total amount spent on the order in dollars.
                  example: 100
                  type: integer
                orderTotalPoints:
                  description: >-
                    Enter the total number of points users earned on a
                    particular order.
                  example: 500
                  type: integer
                orderDiscountAmount:
                  description: Enter the total discount amount on the placed order.
                  example: 50
                  type: integer
                orderStatus:
                  description: Enter the status as ship.
                  example: SHIP
                  type: string
                pointType:
                  description: >-
                    Enter the point type. The pointType is an activity type,
                    which would be an open field in the POST Issuance API
                    payload.
                  example: Regular
                  type: string
                orderDate:
                  description: >-
                    Enter the order date in yyyy-MM-dd  format. It becomes a
                    required field when backdated orders are enabled.
                  example: '2024-06-19'
                  type: string
                orderShipDate:
                  description: Enter the shipping date for the order in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                productDetails:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    productId:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    productQuantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 23
                      type: integer
                    productPrice:
                      description: Enter the price per unit for the product.
                      example: 100
                      type: integer
                    productDiscountAmount:
                      description: >-
                        Enter the total product discount amount applied to the
                        transaction.
                      example: 10
                      type: integer
                    productCouponCode:
                      description: >-
                        Enter the name of a product coupon code applied to the
                        product order.
                      example: abcd2344
                      type: string
                    productTotalAmount:
                      description: >-
                        Enter the total amount of the order placed by the
                        loyalty member.
                      example: 200
                      type: integer
                    productTotalPoints:
                      description: Enter the total points.
                      example: 200
                      type: integer
                    productDescription:
                      description: Enter the product description.
                      example: iPad came with p10 chip and one week battery support.
                      type: string
                    productShipDate:
                      description: >-
                        Enter the date when the product will be shipped in the
                        format yyyy-MM-dd.
                      example: 22023-12-11
                      type: string
                    issuanceProductAttribute:
                      type: object
                      description: >-
                        issuanceProductAttribute may have multiple dynamic
                        product attributes and values.
                      properties:
                        issuanceOrderAttribute:
                          type: object
                          description: >-
                            This object contain multiple dynamic attributes and
                            its values.
                          properties:
                            attribute:
                              description: Enter attribute name and value information.
                              example: Quantity
                              type: string
              required:
                - orderId
                - userId
                - actionId
                - orderTotalSpend
                - orderTotalPoints
                - orderStatus
                - productTotalAmount
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/postissuancecreationfornonpurchasetransactionresp
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/postissuancecreationfornonpurchasetransactionresp
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Updated Issuance return:
    patch:
      tags:
        - Issuance
      summary: Updated Issuance return
      description: >-
        Use a PATCH method for updating the status of an existing order,
        enabling actions such as RETURN, PARTIAL RETURN. Utilize the PATCH
        method within the Issuance API to modify the order status of a shipment
        to return status as specified in the input parameter.
      operationId: patchupdatedissuancereturn
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
                actionId:
                  description: Enter the action ID.
                  example: 174
                  type: integer
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store.
                  example: Web
                  type: string
                coupon:
                  description: Enter the name of the coupon.
                  example: acdb2344
                  type: string
                orderTotalSpend:
                  description: Enter the total amount spent on the order in dollars..
                  example: 100
                  type: integer
                orderTotalPoints:
                  description: >-
                    Enter the total number of points users earned on a
                    particular order.
                  example: 500
                  type: integer
                orderDiscountAmount:
                  description: Enter the total discount amount on the placed order.
                  example: 50
                  type: integer
                orderStatus:
                  description: Enter the order status as RETURN.
                  example: Return
                  type: string
                pointType:
                  description: Enter the point type.
                  example: Regular
                  type: string
                orderDate:
                  description: >-
                    Enter the order date in yyyy-MM-dd format. It becomes a
                    required field when backdated orders are enabled.
                  example: '2024-06-19'
                  type: string
                orderShipDate:
                  description: Enter the shipping date for the order in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                productDetails:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    productId:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    productQuantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 23
                      type: integer
                    productPrice:
                      description: Enter the price per unit for the product.
                      example: 100
                      type: integer
                    productDiscountAmount:
                      description: >-
                        Enter the total product discount amount applied to the
                        transaction.
                      example: 10
                      type: integer
                    productCouponCode:
                      description: >-
                        Enter the name of a product coupon code applied to the
                        order.
                      example: abcd2344
                      type: string
                    productTotalAmount:
                      description: >-
                        Enter the total amount of the order placed by the
                        loyalty member.
                      example: 200
                      type: integer
                    productTotalPoints:
                      description: Enter the total points.
                      example: 200
                      type: integer
                    productDescription:
                      description: Enter the product description.
                      example: iPad came with p10 chip and one week battery support.
                      type: string
                    productShipDate:
                      description: >-
                        Enter the date when the product will be shipped in the
                        format yyyy-MM-dd.
                      example: 22023-12-11
                      type: string
                    issuanceProductAttribute:
                      type: object
                      description: >-
                        issuanceProductAttribute may have multiple dynamic
                        product attributes and values.
                      properties:
                        issuanceOrderAttribute:
                          type: object
                          description: >-
                            This object contain multiple dynamic attributes and
                            its values.
                          properties:
                            attribute:
                              description: Enter attribute name and value information.
                              example: Quantity
                              type: string
              required:
                - orderId
                - userId
                - actionId
                - orderTotalSpend
                - orderTotalPoints
                - orderStatus
                - productTotalAmount
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchUpdatedIssuancereturnresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchUpdatedIssuancereturnresp'
        '201':
          description: successful operation
        '400':
          description: "AC 6057 Insufficient points balance to process the return. | AC6058 Insufficient group points balance to process the return. | AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Update the Issuance details:
    put:
      tags:
        - Issuance
      summary: Update the Issuance details
      description: Use PUT method to edit and update the existing transactional details.
      operationId: putupdateissuancedetails
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
                actionId:
                  description: Enter the action ID.
                  example: 174
                  type: integer
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store.
                  example: Web
                  type: string
                coupon:
                  description: Enter the name of a coupon.
                  example: $10 Off
                  type: string
                orderTotalSpend:
                  description: Enter the total amount spent on the order in dollars.
                  example: 100
                  type: integer
                orderTotalPoints:
                  description: >-
                    Enter the total number of points users earned on a
                    particular order.
                  example: 500
                  type: integer
                orderDiscountAmount:
                  description: Enter the total discount amount on the placed order.
                  example: 50
                  type: integer
                orderStatus:
                  description: Enter the order status as SHIP.
                  type: string
                pointType:
                  description: Enter the point type.
                  example: Regular
                  type: string
                orderDate:
                  description: >-
                    Enter the order date in yyyy-MM-dd HH:mm:ss format. It
                    becomes a required field when backdated orders are enabled.
                    Represents the UTC order date and time.
                  example: '2024-06-19'
                  type: string
                orderShipDate:
                  description: Enter the shipping date for the order in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                productDetails:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    productId:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    productQuantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 23
                      type: integer
                    productPrice:
                      description: Enter the price per unit for the product.
                      example: 100
                      type: integer
                    productDiscountAmount:
                      description: >-
                        Enter the total product discount amount applied to the
                        transaction.
                      example: 10
                      type: integer
                    productCouponCode:
                      description: >-
                        Enter the name of a product coupon code applied to the
                        product order.
                      example: acdb2344
                      type: string
                    productTotalAmount:
                      description: >-
                        Enter the total amount of the order placed by the
                        loyalty member.
                      example: 200
                      type: integer
                    productTotalPoints:
                      description: Enter the total points.
                      example: 200
                      type: integer
                    productDescription:
                      description: Enter the product description.
                      example: iPad came with p10 chip and one week battery support.
                      type: string
                    productShipDate:
                      description: >-
                        Enter the date when the product will be shipped in the
                        format yyyy-MM-dd.
                      example: 22023-12-11
                      type: string
                    issuanceProductAttribute:
                      type: object
                      description: >-
                        issuanceProductAttribute may have multiple dynamic
                        product attributes and values.
                      properties:
                        issuanceOrderAttribute:
                          type: object
                          description: >-
                            This object contain multiple dynamic attributes and
                            its values.
                          properties:
                            attribute:
                              description: Enter attribute name and value information.
                              example: Quantity
                              type: string
              required:
                - orderId
                - userId
                - actionId
                - orderTotalSpend
                - orderTotalPoints
                - orderStatus
                - productTotalAmount
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/putupdateissuancedetailsresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/putupdateissuancedetailsresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Update the transaction as Partial Ship:
    patch:
      tags:
        - Issuance
      summary: Update the transaction as Partial Ship
      description: >-
        Use the PATCH method in the Issuance API to modify the order status of a
        shipment to "Partial Ship." Orders have the option to be adjusted to
        Partial Ship status, with all other fields specified in the request
        body.
      operationId: patchupdatetransactionaspartialship
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
                actionId:
                  description: Enter the action ID.
                  example: 174
                  type: integer
                source:
                  description: >-
                    Enter the source of where the order was placed by the
                    loyalty member, such as web or store.
                  example: Web
                  type: string
                coupon:
                  description: Enter the name of a coupon.
                  example: acdb2344
                  type: string
                orderTotalSpend:
                  description: Enter the total amount spent on the order in dollars.
                  example: 100
                  type: integer
                orderTotalPoints:
                  description: >-
                    Enter the total number of points users earned on a
                    particular order.
                  example: 500
                  type: integer
                orderDiscountAmount:
                  description: Enter the total discount amount on the placed order.
                  example: 50
                  type: integer
                orderStatus:
                  description: Enter the order status as PARTIAL SHIP.
                  example: Partial Ship
                  type: string
                pointType:
                  description: Enter the point type.
                  example: Regular
                  type: string
                orderDate:
                  description: >-
                    Enter the order date in yyyy-MM-dd format. It becomes a
                    required field when backdated orders are enabled.
                  example: '2024-06-19'
                  type: string
                orderShipDate:
                  description: Enter the shipping date for the order in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                productDetails:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    productId:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    productQuantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 23
                      type: integer
                    productPrice:
                      description: Enter the price per unit for the product.
                      example: 100
                      type: integer
                    productDiscountAmount:
                      description: >-
                        Enter the total product discount amount applied to the
                        transaction.
                      example: 10
                      type: integer
                    productCouponCode:
                      description: >-
                        Enter the name of a product coupon code applied to the
                        order.
                      example: acdb2344
                      type: string
                    productTotalAmount:
                      description: >-
                        Enter the total amount of the order placed by the
                        loyalty member.
                      example: 200
                      type: integer
                    productTotalPoints:
                      description: Enter the total points.
                      example: 200
                      type: integer
                    productDescription:
                      description: Enter the product description.
                      example: iPad came with p10 chip and one week battery support.
                      type: string
                    productShipDate:
                      description: >-
                        Enter the date when the product will be shipped in the
                        format yyyy-MM-dd.
                      example: 22023-12-11
                      type: string
                    issuanceProductAttribute:
                      type: object
                      description: >-
                        issuanceProductAttribute may have multiple dynamic
                        product attributes and values.
                      properties:
                        issuanceOrderAttribute:
                          type: object
                          description: >-
                            If an order attribute was previously set to
                            mandatory, then the parameter is required.
                          properties:
                            attribute:
                              description: Enter attribute name and value information.
                              example: Quantity
                              type: string
              required:
                - orderId
                - userId
                - actionId
                - orderTotalSpend
                - orderTotalPoints
                - orderStatus
                - productTotalAmount
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionaspartialshipresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionaspartialshipresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Update transaction as Partial Cancel:
    patch:
      tags:
        - Issuance
      summary: Update transaction as Partial Cancel
      description: >-
        Use the PATCH method in the Issuance API to modify the order status of a
        shipment to "Partial Cancel." Orders have the option to be adjusted to
        Partial Cancel status, with all other fields specified in the request
        body.
      operationId: patchupdatetransactionaspartialcancel
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
                actionId:
                  description: Enter the action ID.
                  example: 174
                  type: integer
                source:
                  description: >-
                    Enter the source where the order was placed by the loyalty
                    member, such as web or store.
                  example: Web
                  type: string
                coupon:
                  description: Enter the name of a coupon.
                  example: acdb2344
                  type: string
                orderTotalSpend:
                  description: Enter the total amount spent on the order in dollars.
                  example: 100
                  type: integer
                orderTotalPoints:
                  description: >-
                    Enter the total number of points loyalty members can earn on
                    a particular order.
                  example: 500
                  type: integer
                orderDiscountAmount:
                  description: Enter the total discount amount on the placed order.
                  example: 50
                  type: integer
                orderStatus:
                  description: Enter the order status as PARTIAL CANCEL.
                  example: Partial Cancel
                  type: string
                pointType:
                  description: Enter the point type.
                  example: Regular
                  type: string
                orderDate:
                  description: >-
                    Enter the order date in yyyy-MM-dd HH:mm:ss format. It
                    becomes a required field when backdated orders are enabled.
                    Represents the UTC order date and time.
                  example: '2024-06-19'
                  type: string
                orderShipDate:
                  description: Enter the shipping date for the order in yyyy-MM-dd format.
                  example: '2024-06-19'
                  type: string
                storeId:
                  description: Enter the unique ID of the store.
                  example: IN12369
                  type: string
                productDetails:
                  type: object
                  description: >-
                    Enter the array of product details presented in the
                    productDetail object as follows.
                  properties:
                    productId:
                      description: Enter the product ID.
                      example: p1
                      type: string
                    productName:
                      description: Enter the product name.
                      example: wool sweater
                      type: string
                    productQuantity:
                      description: >-
                        Enter the quantity of the product that has been
                        purchased.
                      example: 23
                      type: integer
                    productPrice:
                      description: Enter the price per unit for the product.
                      example: 100
                      type: integer
                    productDiscountAmount:
                      description: >-
                        Enter the total product discount amount applied to the
                        transaction.
                      example: 10
                      type: integer
                    productCouponCode:
                      description: >-
                        Enter the name of a product coupon code applied to the
                        product order.
                      example: abcd2344
                      type: string
                    productTotalAmount:
                      description: >-
                        Enter the total amount of the order placed by the
                        loyalty member.
                      example: 200
                      type: integer
                    productTotalPoints:
                      description: Enter the total points.
                      example: 200
                      type: integer
                    productDescription:
                      description: Enter the product description.
                      example: iPad came with p10 chip and one week battery support.
                      type: string
                    productShipDate:
                      description: >-
                        Enter the date when the product will be shipped in the
                        format yyyy-MM-dd.
                      example: 22023-12-11
                      type: string
                    issuanceProductAttribute:
                      type: object
                      description: >-
                        issuanceProductAttribute may have multiple dynamic
                        product attributes and values.
                      properties:
                        issuanceOrderAttribute:
                          type: object
                          description: >-
                            This object contain multiple dynamic attributes and
                            its values.
                          properties:
                            attribute:
                              description: Enter attribute name and value information.
                              example: Quantity
                              type: string
              required:
                - orderId
                - userId
                - actionId
                - orderTotalSpend
                - orderTotalPoints
                - orderStatus
                - productTotalAmount
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionaspartialcancelresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionaspartialcancelresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuancedetails/{{memberId}}:
    post:
      tags:
        - Issuance
      summary: Use Issuance details filter
      description: Use the POST method to filter the issuance details.
      operationId: postissuancedetailsfilter
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                userId:
                  description: Enter the unique user ID of the loyalty member.
                  example: user@domain.com
                  type: string
              required:
                - orderId
                - userId
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postuseissuancedetailsfilterresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postuseissuancedetailsfilterresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Update the transaction as Full Cancel:
    patch:
      tags:
        - Issuance
      summary: Update the transaction as Full cancel
      description: >-
        Use the PATCH method in the Issuance API to modify the order status of a
        shipment to "Full Cancel". Orders have the option to be updated as "Full
        Cancel", while all other fields are specified in the request body.
      operationId: patchupdatetransactionasfullcancel
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                orderStatus:
                  description: Enter the order status as FULL CANCEL.
                  example: Full Cancel
                  type: string
              required:
                - orderId
                - orderStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionasfullcancelresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionasfullcancelresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing| AC6006\tSource Is Missing| AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /issuance- Update the transaction as Full Ship:
    patch:
      tags:
        - Issuance
      summary: Update the transaction as Full ship
      description: >-
        Use the PATCH method in the Issuance API to update the order status of a
        shipment to Full Ship. Orders can be updated as Ship. All other fields
        are listed in the request body.
      operationId: patchupdatetransactionasfullship
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Different body parameters are shown below.
              properties:
                orderId:
                  description: Enter the order ID for the order.
                  example: '12345'
                  type: string
                orderStatus:
                  description: Enter the order status as FULL SHIP.
                  example: Full Ship
                  type: string
              required:
                - orderId
                - orderStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionasfullshipresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/patchupdatetransactionasfullshipresp'
        '201':
          description: successful operation
        '400':
          description: "AC6001 The Order ID Is Already Exist | AC6002 The Order ID Cannot Be Blank | AC6003 User ID Is Missing | AC6004 User ID Cannot Be Blank | AC6005\tAction ID Is Missing | AC6006\tSource Is Missing | AC6007\tCoupon Is Missing | AC6008\tOrder Total Spend Is Missing | AC6009\tThe Order Status Is Missing | AC6010\tPoint Type Is Missing | AC6011\tThe Product Details Are Missing | AC6012\tProduct ID Is Missing | AC6013\tProduct ID Cannot Be Blank | AC6014\tThe Order Date Cannot Be A Future Date | AC6015\tProduct Quantity Is Missing | AC6016\tIncorrect Product Total Points | AC6017\tIncorrect Product Total Amount | AC6018\tProduct Total Amount Is Missing | AC6019\tProduct Total Points Is Missing | AC6020\tUser ID Does Not Exist | AC6023\tThe Order Status Cannot Be Blank | AC6024\tInvalid Order Status | AC6025\tThe Order Is Already Cancelled | AC6026\tInvalid Point Type | AC6027\tStore ID Can Not Be Blank | AC6028\tOrder Total Points Is Missing | AC6029\tIncorrect Order Total Spend | AC6030\tInsufficiant Quantity | AC6031\tIncorrect Order Total Points | AC6032\tIncorrect Order Discount Amount | AC6034\tThe Order Is Already Shipped | AC6035\tThe Product Is Already Shipped | AC6036\tThe Product Is Already Cancelled | AC6037\tOrder Ship Date Is Missing | AC6039\tCannot Return This Order | AC6041\tUnable To Deduct Points As Debit Points Are More Than Available Points | AC6042\tOrder Must Ship Before Return |  AC6043\tIncorrect Product Quantity | AC6044\tIncorrect Product Price | AC6045\tIncorrect Product Discount Amount | AC6046\tProduct Price Is Missing | AC6047\tOrder Total Spend Cannot Be In Negative | AC6048\tOrder Total Points Cannot Be In Negative | AC6049\tOrder Discount Amount Cannot Be In Negative | AC6050\tProduct Quantity Cannot Be In Negative | AC6051\tProduct Price Cannot Be In Negative | AC6052\tProduct Discount Amount Cannot Be Negative |AC6053\tProduct Total Amount Cannot Be In Negative | AC6054\tProduct Total Points Cannot Be In Negative | AC6055\tProduct ID Not Found Against This Order ID | AC1001\tOops! Something went wrong | AC1003\tMethod Not Allowed | AC1004\tMissing Parameters | AC1005\tNo data found | AC1012\tUser not found | AC4004\tUser has Opted out | AC4007\tOrder ID is missing | AC4009\tOrder ID does not exist  | AC4014\tInvalid Order Date format"
        '401':
          description: Invalid Product Ship Date Format
        '404':
          description: "AC6021\tThe Action Is Not Configured | AC6022\tThe Order ID Is Already Exist | AC6033\tInvalid Order Ship Date format | AC6040\tThe Order Is Already Returned"
        '422':
          description: Invalid Order ID
  /blocklist:
    post:
      tags:
        - BlockList
      summary: Add domains and members to the blocklist
      description: >-
        This API method is used to block both members and domains within the
        Annex Cloud site. It facilitates the execution of actions that prevent
        specified members and domains from accessing or interacting with the
        site, contributing to enhanced security and control measures.
      operationId: BlockList
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                blocklistUsers:
                  type: string
                  description: >-
                    Enter the user IDs of members you would like to add to the
                    blocklist. Multiple user IDs can be added to the blocklist
                    separated with a comma.
                  example: sa.matthenryy12@gmail.com, joyroy.saa12
                blocklistDomains:
                  type: string
                  description: >-
                    Enter the domains you would like to add to the blocklist.
                    Multiple domains can be added to the blocklist separated
                    with a comma.
                  example: testdomain1.com
                blockedBy:
                  type: string
                  description: >-
                    Enter the email address of the admin who has added members'
                    user IDs, domains, or both to the blocklist.
                  example: user@domain.com
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddBlockList'
            application/xml:
              schema:
                $ref: '#/components/schemas/AddBlockList'
        '404':
          description: AC1001 Oops! Something went wrong
        '422':
          description: AC1007 Invalid Parameters
  /blocklist/all:
    get:
      tags:
        - BlockList
      summary: Fetch all blocklist domain and member information for the site
      description: >-
        This API method retrieves comprehensive information about all the
        members and domains listed in the blocklist on the Annex Cloud site.
      operationId: BlockListall
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getBlockListDetails'
            application/xml:
              schema:
                $ref: '#/components/schemas/getBlockListDetails'
        '404':
          description: AC1001 Oops! Something went wrong
        '405':
          description: AC1008 User is Blocked
        '422':
          description: AC1007 Invalid Parameters
  /blocklistdelete:
    post:
      tags:
        - BlockList
      summary: Delete members and domains from the blocklist
      description: >-
        This API method is used for removing members and domains from the
        blocklist of the Annex Cloud site. If members or domains are requested
        to be deleted but are not on the blocklist, you will be notified in the
        API response.
      operationId: BlockListdelete
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                deleteBlocklistDomains:
                  type: string
                  description: >-
                    Enter the list of domains that must be deleted from the
                    blocklist. Multiple domains can be deleted from the
                    blocklist separated with a comma.
                  example: testdomain1.com
                deleteBlocklistUsers:
                  type: string
                  description: >-
                    Enter the list of members that should be deleted from the
                    blocklist by entering their user ID. Multiple user IDs can
                    be deleted from the blocklist separated with a comma.
                  example: sa.matthenryy12@gmail.com, joyroy.saa12
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBlocklist'
            application/xml:
              schema:
                $ref: '#/components/schemas/DeleteBlocklist'
        '404':
          description: AC1001 Oops! Something went wrong
  /receipts - upload receipt:
    post:
      tags:
        - Receipt
      summary: Upload a receipt
      description: >-
        This endpoint can be used to upload receipts in JPEG, PNG, or HEIC
        format. Once a receipt is submitted, it goes through a verification
        process, and upon successful verification, points are awarded to the
        member. Here, in the request body, you need to select 'form-data' to
        provide the user ID and upload the receipt.
      operationId: postreceipts
      requestBody:
        content:
          form-data:
            schema:
              type: object
              properties:
                userId:
                  description: >-
                    Enter the user ID of the member who wants to upload a
                    receipt.
                  example: user25
                  type: string
                file:
                  description: >-
                    Upload a receipt image in JPEG, PNG, or HEIC format. The
                    file must be under 10MB, and only one receipt can be
                    uploaded at a time. To begin, click the upload option. You
                    will then be prompted to choose the source of the image -
                    either your local drive (your computer) or a shared drive.
                    After selecting the drive, browse and select the receipt
                    image you wish to upload. Once selected, the image will be
                    uploaded.
                  example: billreceipt.jpeg
                  type: string
              required:
                - userId
                - file
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postreceiptsresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postreceiptsresp'
        '400':
          description: >-
            AC1084 Oops! The file type you uploaded is not supported. Please try
            again with a different file format | AC1086 We couldn't generate the
            receipt URL. Please check the details and try again | AC1087 The
            receipt URL is not valid. Please verify the URL and try again |
            AC1089 Oops! The file size is greater than 10MB. Please try again
            with a smaller file.
        '404':
          description: >-
            AC1005 No data found | AC1085 It seems like the file URL or data is
            missing. Please ensure that the file is properly linked and try
            again
  /receipts - upload receipt by URL:
    post:
      tags:
        - Receipt
      summary: Upload the receipt by providing the URL
      description: >-
        This endpoint can be used to upload a receipt by providing a URL with a
        PNG, JPEG, or HEIC extension. Once the receipt is submitted, it goes
        through a verification process, and upon successful verification, points
        are awarded to the member. Here, in the request body, you need to select
        'raw' to provide the user ID and upload the receipt URL.
      operationId: postreceiptsURL
      requestBody:
        content:
          raw:
            schema:
              type: object
              properties:
                userId:
                  description: >-
                    Enter the user ID of the member who wishes to upload the
                    receipt.
                  example: user25
                  type: string
                file_url:
                  description: >-
                    Enter the receipt URL to be uploaded by the member. The
                    receipt URL extension must be in PNG, JPEG, or HEIC format.
                    The file size must be less than 10MB.
                  example: https://i.postimg.cc/2jnCbcYy/working752.jpg
                  type: string
              required:
                - userId
                - file_url
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postreceiptsURLresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/postreceiptsURLresp'
        '400':
          description: >-
            AC1084 Oops! The file type you uploaded is not supported. Please try
            again with a different file format | AC1086 We couldn't generate the
            receipt URL. Please check the details and try again | AC1087 The
            receipt URL is not valid. Please verify the URL and try again |
            AC1089 Oops! The file size is greater than 10MB. Please try again
            with a smaller file.
        '404':
          description: >-
            AC1005 No data found | AC1085 It seems like the file URL or data is
            missing. Please ensure that the file is properly linked and try
            again
  /receipts/user/{{email_id}}:
    get:
      tags:
        - Receipt
      summary: Get member’s receipt details
      description: >-
        This endpoint can be used to fetch all receipts uploaded by a member by
        providing the member's user ID. Note - The member’s receipt information
        can also be filtered based on query parameters such as receipt_id,
        receipt_status, and submission_id.
      operationId: getmemberreceiptdetails
      parameters:
        - name: email_id
          in: path
          description: >-
            Enter the user ID of the member for whom you want to retrieve all
            receipt details.
          example: user@domain.com
          schema:
            type: string
      required:
        - email_id
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getmemberreceiptdetailsresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getmemberreceiptdetailsresp'
        '404':
          description: AC1005 No data found
  /receipts/{{submission_id}}:
    get:
      tags:
        - Receipt
      summary: Check receipt status
      description: >-
        This endpoint can be used to check the status of a receipt after it has
        been uploaded. Once the receipt is verified, the member receives the
        points benefit.
      operationId: getreceiptssubmissionid
      parameters:
        - name: submission_id
          in: path
          description: >-
            Enter the submission ID of the receipt for which you want to check
            the status.
          example: 4b299b81-203c-11f0-8a74
          schema:
            type: string
      required:
        - submission_id
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getreceiptssubmissionidresp'
            application/xml:
              schema:
                $ref: '#/components/schemas/getreceiptssubmissionidresp'
        '404':
          description: AC1005 No data found
components:
  schemas:
    postreceiptsresp:
      type: object
      properties:
        submissionId:
          type: string
          description: >-
            Displays the autogenerated submission ID after the receipt was
            uploaded.
          example: c68d67d1-2006-11f0-8a74
        receiptId:
          type: string
          description: >-
            Displays the unique receipt ID generated once the receipt was
            uploaded.
          example: '698381745387396'
        status:
          type: string
          description: >-
            Displays the status of the receipt verification process. The status
            can be 'Pending', 'Points Awarded', or 'Rejected'. When a member
            uploads a receipt, the status will appear as 'Pending'. Once the
            receipt is verified and points are awarded, the status will change
            to 'Points Awarded'. If the receipt is rejected, the status will be
            'Rejected'.
          example: Pending
        message:
          type: string
          description: >-
            Displays whether the receipt verification was successful or not. Any
            errors or issues encountered during the verification process will be
            clearly communicated through this message.
          example: The receipt has been successfully verified.
    postreceiptsURLresp:
      type: object
      properties:
        submissionId:
          type: string
          description: >-
            Displays the autogenerated submission ID when the receipt URL was
            uploaded.
          example: c68d67d1-2006-11f0-8a74
        receiptId:
          type: string
          description: >-
            Displays the unique receipt ID generated once the receipt URL was
            uploaded.
          example: '698381745387396'
        status:
          type: string
          description: >-
            Displays the status of the receipt verification process. The status
            can be 'Pending', 'Points Awarded', or 'Rejected'. When a member
            uploads a receipt, the status will appear as 'Pending'. Once the
            receipt is verified and points are awarded, the status will change
            to 'Points Awarded'. If the receipt is rejected, the status will be
            'Rejected'.
          example: Pending
        message:
          type: string
          description: >-
            Displays whether the receipt verification was successful or not. Any
            errors or issues encountered during the verification process will be
            clearly communicated through this message.
          example: The receipt has been successfully verified.
    getmemberreceiptdetailsresp:
      type: object
      properties:
        submissionId:
          type: string
          description: >-
            Displays the autogenerated submission ID when the receipt was
            uploaded.
          example: 4b299b81-203c-11f0-8a74
        receiptId:
          type: string
          description: >-
            Displays the unique receipt ID generated once the receipt was
            uploaded.
          example: '283111745410383'
        uploadDate:
          type: string
          description: >-
            Displays the date when the receipt was uploaded, in yyyy-MM-dd
            HH:mm:ssZ format.
          example: '2025-04-23 12:12:57'
        pointsAwarded:
          type: integer
          description: >-
            Displays the number of points awarded to the member once the receipt
            was approved.
          example: 10
        status:
          type: string
          description: >-
            Displays the status of the receipt verification process. The status
            can be 'Pending', 'Points Awarded', or 'Rejected'. When a member
            uploads a receipt, the status will appear as 'Pending'. Once the
            receipt is verified and points are awarded, the status will change
            to 'Points Awarded'. If the receipt is rejected, the status will be
            'Rejected'.
          example: Points Awarded
        processCompletedDate:
          type: string
          description: >-
            Displays the date on which the receipt verification was completed
            and points were awarded to the member, in the yyyy-MM-dd HH:mm:ssZ
            format.
          example: '2025-04-23 12:12:57'
        pages:
          type: integer
          description: >-
            Displays the total number of pages on which the member's receipt
            information appears.
          example: 10
        currentPage:
          type: integer
          description: >-
            Displays the current page number on which the member's receipt
            information appears.
          example: 1
    getreceiptssubmissionidresp:
      type: object
      properties:
        submissionId:
          type: string
          description: >-
            Displays the submission ID of the receipt for which you want to
            check the status.
          example: 4b299b81-203c-11f0-8a74
        receiptId:
          type: string
          description: >-
            Displays the unique ID of the receipt for which you requested the
            status.
          example: '283111745410383'
        uploadDate:
          type: string
          description: >-
            Displays the date when the receipt was uploaded, in yyyy-MM-dd
            HH:mm:ssZ format.
          example: '2025-04-23 12:12:57'
        pointsAwarded:
          type: integer
          description: >-
            Displays the number of points awarded to the member once the receipt
            was approved.
          example: 10
        status:
          type: string
          description: >-
            Displays the status of the receipt verification process. The status
            can be 'Pending', 'Points Awarded', or 'Rejected'. When a member
            uploads a receipt, the status will appear as 'Pending'. Once the
            receipt is verified and points are awarded, the status will change
            to 'Points Awarded'. If the receipt is rejected, the status will be
            'Rejected'.
          example: Points Awarded
    postbulkpointsresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: '29235480'
        id:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        actionId:
          type: string
          description: >-
            Displays the unique action ID for which the member is awarded or
            deducted points.
          example: 101
        activity:
          type: string
          description: Displays whether the activity is a credit or a debit.
          example: CREDIT
        credit/debit:
          type: integer
          description: >-
            Displays the number of points credited to or debited from the
            member's account.
          example: 100
        storeDetails:
          type: object
          description: >-
            Displays the following store details associated with the store. Note
            - If a store ID is provided with any action and it exists in the
            metadata, all associated attributes of that store will be displayed.
            If the store ID does not exist in the metadata, it will simply
            display the store ID itself.
          properties:
            storeId:
              type: string
              description: >-
                Displays an identifier for the specific store. It is a unique
                code assigned to each store.
              example: IN12369
            storeName:
              type: string
              description: Displays the name associated with the specific store.
              example: SHELL
            storeExtendedAttribute:
              type: string
              description: Displays all the store extended attributes.
              example: Store Location
        pointsAwarded:
          type: integer
          description: >-
            Displays the number of points awarded to the member’s account for
            performing the action.
          example: 100
        reason:
          type: string
          description: Displays the reason for awarding points to the member’s account.
          example: bonus
        updatedAvailablePoints:
          type: integer
          description: >-
            Displays the updated number of available points in the member’s
            account after points have been awarded or debited.
          example: 100
        updatedLifetimePoints:
          type: integer
          description: >-
            Displays the updated total number of points the member has earned in
            their lifetime with the loyalty program after points have been
            awarded.
          example: 200
        previousTier:
          type: string
          description: >-
            Displays the member’s previous tier before the points were awarded
            or debited.
          example: Silver
        updatedUserTier:
          type: string
          description: >-
            Displays the member’s updated tier after the points are awarded or
            debited.
          example: Gold
    getTiersInfo:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: '29235480'
        currentTier:
          type: string
          description: >-
            Displays the loyalty member's current tier name. For example,
            Bronze, Silver, Gold. The name of the tier is defined by the client
            during configuration of the loyalty program.
          example: Silver
        nextTier:
          type: string
          description: >-
            Displays the name of the next tier which is awarded to the member
            once the required milestones are achieved.
          example: Gold
        previousTier:
          type: string
          description: Displays the previous tier that was assigned to the member.
          example: Bronze
        pointsToNextTier:
          type: string
          description: >-
            Displays the number of points required to achieve the next tier.
            This depends on the point threshold required to reach the next tier
            and the number of points the member currently has in their account.
            Note - The type is dependent on the decimal points precision set at
            the super admin level.
          example: 210
        purchaseRatio:
          type: string
          description: >-
            Displays the purchase ratio defined in the Tier, which will be
            applied to the member’s purchases. For example, if the purchase
            ratio is 2 and purchase amount is 500, 1000  points are awarded to
            the member after completing the purchase.
          example: 2
        currentTierPurchaseRatio:
          type: string
          description: >-
            Displays the purchase ratio that is applied to the member for this
            tier while earning points for purchase.
          example: 2
        tierLimitType:
          type: string
          description: >-
            Displays the action points expiration date set for the tier. If
            ‘Rolling’ is selected, the result appears in days, whereas
            ‘Calendar’ shows the result in weeks, months, or years.
          example: Rolling
        tierLimitPeriod:
          type: string
          description: Displays the Tier limit period in days, weeks, months or year.
          example: Day
        maximumLimitPoints:
          type: integer
          description: >-
            Displays the maximum points that the member can earn in their
            current tier.
          example: 500
        completedLimitPoints:
          type: integer
          description: >-
            Displays the current number of points earned by the member, not
            exceeding the maximum limit.
          example: 200
        pendingLimitPoints:
          type: integer
          description: >-
            Displays the remaining points the member can earn until they reach
            the maximum point limit.
          example: 500
        tierLimitReachedFlag:
          type: integer
          description: >-
            Displays the tier limit reached flag. When the flag is ON, it
            returns 1. When the flag is OFF, it returns 0.
          example: 0
        tierLimitReachedStatus:
          type: string
          description: >-
            Displays whether the member has reached the maximum point limit or
            not.
          example: 'Yes'
        spendAmountToNextTier:
          type: integer
          description: >-
            Displays the amount the member must spend to achieve the next tier.
            This is only applicable to tiers where the metric is spend-based. If
            the tier metric is points-based or based on extended attributes, it
            will not show any additional values.
          example: 200
        tierAchievedDate:
          type: string
          description: >-
            Displays the current tier achievement date in yyyy-MM-dd'T'HH:mm:ssZ
            format.
          example: 2018-04-01T00:00:00-0700
        tierExpirationDate:
          type: string
          description: >-
            Displays the tier expiration date in yyyy-MM-dd'T'HH:mm:ssZ format.
            When the tier expiration date is reached, the current tier is no
            longer valID. The loyalty points are deducted, and the tier sequence
            restarts from the base tier.
          example: 2018-04-01T00:00:00-0700
        currentTierRewards:
          $ref: '#/components/schemas/getTiersInfo_currentTierRewards'
        pointsEarnedInTier:
          type: integer
          description: >-
            Displays the points earned by the members while they were in the
            current tier.
          example: 100
        spendAmountInTier:
          type: integer
          description: Displays the amount spent by the member in the current tier.
          example: 100
        blockedStatus:
          type: string
          description: >-
            Display the blocked status of the member. (If Show Blocked User
            Details functionality is enabled from the super admin.). If the
            member is blocked, then it shows YES otherwise it shows No.
          example: 'YES'
        blockedBy:
          type: string
          description: >-
            Displays the email address of who blocked the member. (If Show
            Blocked User Details functionality is enabled from the super admin.)
          example: user@domain.com
        blockedDate:
          type: string
          description: >-
            Displays the date on which the member was blocked in
            yyyy-MM-dd'T'HH:mm:ssZ format. (If Show Blocked User Details
            functionality is enabled from the super admin.)
          example: 2020-10-12T00:00:00+0000
        multiBucketsData:
          $ref: '#/components/schemas/gettiersinfouseridtiers'
    getTiersInfo_currentTierRewards:
      type: object
      description: Displays the current tier rewards details.
      properties:
        rewardId:
          type: integer
          description: Displays the specific reward ID associated with the current tier.
          example: 1234
        rewardName:
          type: string
          description: Displays the name of the reward.
          example: reward First
        tierEligible:
          type: string
          description: >-
            Displays whether the member qualifies for the reward based on tier
            benefits or not.
          example: 'YES'
        rewardLimit:
          type: integer
          description: >-
            Displays the limit for how many times a member can claim the reward.
            For example, If the maximum user claim count is set to five, the
            reward could be claimed only five times. If the maximum user claim
            count is set to zero, there is no restriction on claiming rewards
            based on availability.
          example: 2
        limitPeriod:
          type: string
          description: >-
            Displays the length of time the reward claim limit is in place. For
            example, if the claim limit was set to 4 and the limit period is
            “lifetime”, the member can only claim this reward 4 times in their
            lifetime with the loyalty program.
          example: Lifetime
        redeemCount:
          type: integer
          description: Displays the number of times the member has redeemed the reward.
          example: 0
        remainingCount:
          type: integer
          description: >-
            Displays the remaining reward redemption count which can be claimed
            by the member. For example, if the maximum limit to avail the reward
            is 5 and the member has already claimed the reward 3 times, then the
            remaining count would be 2.
          example: 1
    gettiersinfouseridtiers:
      type: object
      description: >-
        Displays an array of all multi bucket details with the following fields
        when the multi bucket is enabled.
      properties:
        '[bucketName]':
          $ref: '#/components/schemas/gettiersinfotierbucketname'
    gettiersinfotierbucketname:
      type: object
      description: Displays an array of all multi bucket names.
      properties:
        pointsToNextTier:
          type: integer
          description: >-
            Displays the number of points required in the bucket to achieve the
            next tier. This depends on the point threshold required to reach the
            next tier and the number of points the member currently has in their
            account.
          example: 100
        tier[bucketName]:
          $ref: '#/components/schemas/gettiersinfotierbucketname'
    getalltiers:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        tierMethod:
          type: string
          description: >-
            Displays whether the client's tier setup is sequential or
            non-sequential. When a system is set up with sequential tiers, such
            as Tier 1, Tier 2, and Tier 3, the tiers are assigned in that order.
            However, a non-sequential system does not assign tiers in a
            sequential manner, and as a result, the assigned tier may move up
            from Tier 1 to Tier 3. For example, if there are 3 tier levels
            called Bronze (Tier1), Silver (Tier2) and Gold (Tier3). In the case
            of Sequential setup, the member cannot jump directly from Bronze to
            Gold but in the case of non-Sequential setup, the member can jump
            directly from Bronze to Gold if they meet the criteria.
          example: sequential
        tierDetail:
          $ref: '#/components/schemas/getalltiers_tierDetail'
    getalltiers_tierDetail:
      type: object
      properties:
        tierId:
          type: integer
          description: Displays the system generated unique tier ID.
          example: 1592
        tierName:
          type: string
          description: Displays the tier name given while creating the tier.
          example: Gold
        tierLevel:
          type: integer
          description: >-
            Displays the tier level, which indicates the actual position of the
            tier in the hierarchy.
          example: 0
        tierStatus:
          type: string
          description: >-
            Displays is the current status of the tier that is, active or
            inactive.
          example: active
        tierType:
          type: string
          description: >-
            Displays the tier type selected, which indicates the points criteria
            of the threshold required to enter the tier.
          example: spent points based on calendar year
        tierPointsExpirationType:
          type: string
          description: >-
            Displays the tier expiration type that is, ‘Rolling’ or ‘Calendar’,
            which indicates if the points will expire in a number of days
            (Rolling) or in weeks, months, or years (Calendar). If the Tier
            Based Points Expiration flag is enabled for the action, then all the
            points earned for the action will have the tier expiration date in
            place of original action expiration date.
          example: Rolling
        tierPointsExpireIn:
          type: string
          description: >-
            Displays the expiration date set for the tier. If ‘Rolling’ is
            selected, the result appears in days, whereas ‘Calendar’ shows the
            result in weeks, months or years.
          example: 0 day
        tierPointsExpireYearValue:
          type: string
          description: >-
            Displays the date on which the tier points value expires in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2023-01-25'T'23:52:18+0000
        tierMaximumPointsLimit:
          type: integer
          description: >-
            Displays the maximum point limit for the tier. In this case Override
            Action Point Limit flag should be enabled.
          example: 100
        tierMilestone:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierMilestone'
        tierBenefitBracket:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierBenefitBracket'
        '[multibucket_name]TierPurchaseRatio':
          type: integer
          description: >-
            Displays the multibucket purchase ratio which will be applied to the
            member’s purchases while they are in this tier. (If Enable
            Multibucket Tier Purchase Ratio flag is enabled)
          example: 2
        tierBonus:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierBonus'
        tierRewards:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierRewards'
    getalltiers_tierDetail_tierMilestone:
      type: object
      description: Displays the following parameters.
      properties:
        tierThreshold:
          type: integer
          description: >-
            Displays the required number of points the member must earn to meet
            the tier threshold to enter the tier.
          example: 200
        extendedAttribute:
          type: string
          description: >-
            Displays the selected extended attributes if the extended attribute
            is set as a milestone for the tier.
          example: add the details of extended attribute as UserRole, location, uID.
        actionSeries:
          type: string
          description: >-
            Displays the selected action series if an action series is set as a
            milestone to enter the tier.
          example: milestone
    getalltiers_tierDetail_tierBenefitBracket:
      type: object
      description: Displays types of brackets set for the Tier.
      properties:
        tierBracketType:
          type: string
          description: >-
            Displays the selected benefit bracket type such as default, standard
            and custom.
          example: default
        tierPurchaseRatio:
          type: integer
          description: >-
            Displays the purchase ratio defined in the Tier, which will be
            applied to the member’s purchases. For example, if the purchase
            ratio is 2 and the purchase amount is 500, 1000 points are awarded
            to the member after completing the purchase.
          example: 1
    getalltiers_tierDetail_tierBonus:
      type: object
      description: Displays the following details.
      properties:
        tierBonusPoints:
          type: integer
          description: >-
            Displays the number of bonus points the member earns when they
            achieve this tier.
          example: 10
        tierBonusFrequency:
          type: string
          description: >-
            Displays the frequency at which the tier bonus is awarded. For
            example, only once, the first time the member enters this tier, or
            every time the member enters the tier.
          example: first time only
        tierBonusExpirationType:
          type: string
          description: Displays the tier expiration type as ‘Rolling’ or ‘Calendar’.
          example: Rolling
        tierBonusExpireIn:
          type: string
          description: >-
            Displays the expiration date set for the tier. If ‘Rolling’ is
            selected, the result appears in days, whereas ‘Calendar’ shows the
            result in weeks, months, or years.
          example: 5 days
        tierBonusPointsExpireYearValue:
          type: integer
          description: Displays the value added for Point Expiration under tier settings.
          example: 0
    getalltiers_tierDetail_tierRewards:
      type: object
      properties:
        rewardId:
          type: integer
          description: Displays the specific reward ID.
          example: 123
        rewardName:
          type: string
          description: Displays the name of the reward.
          example: reward two
        tierEligible:
          type: string
          description: >-
            Displays whether the member qualifies for the reward based on tier
            benefits or not.
          example: 'YES'
        rewardLimit:
          type: integer
          description: Displays the reward limit.
          example: 2
        limitPeriod:
          type: string
          description: Displays the tier limit period.
          example: Month
    getalltierspage:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        tierMethod:
          type: string
          description: >-
            Displays whether the client's tier setup is sequential or
            non-sequential. When a system is set up with sequential tiers, such
            as Tier 1, Tier 2, and Tier 3, the tiers are assigned in that order.
            However, a non-sequential system does not assign tiers in a
            sequential manner, and as a result, the assigned tier may move up
            from Tier 1 to Tier 3. For example, if there are 3 tier levels
            called Bronze (Tier1), Silver (Tier2) and Gold (Tier3). In the case
            of Sequential setup, the member cannot jump directly from Bronze to
            Gold but in the case of non-Sequential setup, the member can jump
            directly from Bronze to Gold if they meet the criteria.
          example: Sequential
        tierDetail:
          $ref: '#/components/schemas/getalltiers_tierDetailpage'
        pages:
          type: string
          description: Displays total number of pages associated with the tiers.
          example: 1
        currentPage:
          type: string
          description: >-
            Displays the current page number containing information related to
            the tier.
          example: 2
    getalltiers_tierDetailpage:
      type: object
      description: Displays the tier details.
      properties:
        tierId:
          type: integer
          description: Displays the system generated unique tier ID.
          example: 1592
        tierName:
          type: string
          description: Displays the tier name given while creating the tier.
          example: Test
        tierLevel:
          type: integer
          description: >-
            Displays the tier level, which indicates the actual position of the
            tier in the hierarchy.
          example: 0
        tierStatus:
          type: string
          description: Displays the current status of the tier that is, active or inactive.
          example: active
        tierType:
          type: string
          description: >-
            Displays the tier type selected, which indicates the points criteria
            of the threshold required to enter the tier.
          example: spent points based on calendar year
        tierPointsExpirationType:
          type: string
          description: >-
            Displays the tier expiration type that is, ‘Rolling’ or ‘Calendar’,
            which indicates if the points will expire in a number of days
            (Rolling) or in weeks, months, or years (Calendar). If the Tier
            Based Points Expiration flag is enabled for the action, then all the
            points earned for the action will have the tier expiration date in
            place of original action expiration date.
          example: rolling
        tierPointsExpireIn:
          type: string
          description: >-
            Displays the expiration date set for the tier. If ‘Rolling’ is
            selected, the result appears in days, whereas ‘Calendar’ shows the
            result in weeks, months or years.
          example: 5 days
        tierPointsExpireYearValue:
          type: string
          description: >-
            Displays the date on which the tier points value expires in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2023-01-25T23:52:18+0000
        tierMaximumPointsLimit:
          type: integer
          description: >-
            Displays the maximum point limit for the tier. In this case Override
            Action Point Limit flag should be enabled.
          example: 1
        tierMilestone:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierMilestone'
        tierBenefitBracket:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierBenefitBracket'
        '[multibucket_name]TierPurchaseRatio':
          type: integer
          description: >-
            Displays the multibucket purchase ratio which will be applied to the
            member’s purchases while they are in this tier. (If Enable
            Multibucket Tier Purchase Ratio flag is enabled)
          example: 2
        tierBonus:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierBonus'
        tierRewards:
          $ref: '#/components/schemas/getalltiers_tierDetail_tierRewardspage'
    getalltiers_tierDetail_tierRewardspage:
      type: object
      description: Displays the tier rewards for the tier.
      properties:
        rewardId:
          type: integer
          description: >-
            Displays the unique ID for the reward configured in the loyalty
            program.
          example: 123
        rewardName:
          type: string
          description: Displays the name of the reward.
          example: reward two
        tierEligible:
          type: string
          description: >-
            Displays whether the member qualifies for the reward based on tier
            benefits or not.
          example: 'YES'
        rewardLimit:
          type: integer
          description: >-
            Displays the limit for how many times a member can claim the reward.
            For example, If the maximum user claim count is set to five, the
            reward could be claimed only five times. If the maximum user claim
            count is set to zero, there is no restriction on claiming rewards
            based on availability.
          example: 2
        limitPeriod:
          type: string
          description: >-
            Displays the length of time the reward claim limit is in place. For
            example, if the claim limit was set to 4 and the limit period is
            “lifetime”, the member can only claim this reward 4 times in their
            lifetime with the loyalty program.
          example: Lifetime
    GetStore:
      type: object
      properties:
        siteId:
          type: string
          description: >-
            Displays an identifier for the specific site. It is a unique
            numerical code assigned to each site provided by Annex Cloud.
          example: '29235480'
        storeId:
          type: string
          description: >-
            Displays an identifier for the specific store. It is a unique
            numerical code assigned to each store.
          example: IN12369
        storeName:
          type: string
          description: Displays the name associated with the particular store.
          example: Mobile galaxy
        storeAttribute:
          type: object
          description: Displays the following attribute details associated with the store.
          properties:
            attribute:
              type: string
              description: >-
                Displays attribute name and value information, such as
                “country”.
              example: USA
    getRewardsByUser:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        creditsToCurrencyRatio:
          type: string
          description: >-
            Displays the credits to currency ratio defined by the admin.
            Multiplying this ratio by the member's available points results in
            total currency values of the available points.
          example: 0.25
        creditsToCurrencyValue:
          type: string
          description: >-
            Displays the total currency value after multiplying the available
            points with credit to currency ratio up to a defined decimal place.
          example: 6656.678
        rewardDetail:
          type: object
          properties:
            rewardId:
              type: string
              description: >-
                Displays the unique ID for the reward configured in the loyalty
                program.
              example: '2345'
            rewardCategory:
              type: string
              description: >-
                Displays the category assigned to the loyalty member's reward,
                used to differentiate rewards based on various member types or
                orders.
              example: Nee Reward01
            rewardCategoryId:
              type: integer
              description: Displays the unique identifier assigned to each reward category.
              example: 413
            displayText:
              type: string
              description: Displays a brief description of the reward.
              example: Winter Wear Offer | Save Up To 60% | Winter Sale
            rewardType:
              type: string
              description: >-
                Displays the nature of the reward, making it easier for members
                and administrators to understand its purpose or value when
                interacting with the system. Note - This field is solely
                intended for display purposes within the API and does not
                influence its functionality, regardless of the value provided.
                Annex Cloud does not perform validation on the entered values,
                meaning that the system will accept and displays the input
                exactly as it is submitted, without modification or checks for
                accuracy.
              example: Gift Card
            rewardTerms:
              type: string
              description: Displays the terms and conditions for the reward.
              example: >-
                Points can be redeemed for rewards according to the current
                redemption schedule. Rewards may include discounts, merchandise,
                or other specified offers. Rewards are subject to availability
                and may be changed or discontinued at any time without notice.
                By participating in the Loyalty Program, you acknowledge that
                you have read, understood, and agree to abide by these terms and
                conditions.
            rewardDescription:
              type: string
              description: Displays the additional information related to the reward.
              example: Get 25% off your first product purchase.
            creditRequired:
              type: integer
              description: Displays the number of points required to claim the reward.
              example: 245
            multiBucketData:
              type: object
              description: >-
                Displays the following fields when the multi point bucket flag
                is enabled. Note - To redeem the reward, the reward eligibility
                threshold and multibucket criteria must be completed.
              properties:
                action[bucketName]:
                  type: object
                  description: >-
                    Displays the details of the action bucket which the member
                    must complete to redeem the reward.
                  properties:
                    credit:
                      type: integer
                      description: >-
                        Displays the minimum number of points required to
                        satisfy action bucket criteria to redeem the reward.
                      example: 10
                tier[bucketName]:
                  type: object
                  description: >-
                    Displays the details of the tier bucket which the member
                    must complete to redeem the reward.
                  properties:
                    credit:
                      type: integer
                      description: >-
                        Displays the minimum number of points required to
                        satisfy tier bucket criteria to redeem the reward.
                      example: 100
            deductAmount:
              type: integer
              description: >-
                Displays the monetary value of the reward to be applied to the
                order as a discount.
              example: 20
            rewardCurrency:
              type: string
              description: Displays the reward currency.
              example: USD
            rewardUrl:
              type: string
              description: >-
                Displays the URL for the reward page where the member can claim
                this reward.
              example: https://winteroffer.com
            rewardImageUrl:
              type: string
              description: >-
                Displays the reward image URL.[Note -string If enable rewards
                multiple images upload flag is active then this will appear as
                an object.][Note - The image value is in base64 encoded format.
                For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==]
              example: https://image.winteroffer.com
            defaultThumbnailImageURL:
              type: string
              description: >-
                Displays the thumbnail image for the reward. Note - The image
                value is in base64 encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: https://image.winteroffer.com
            videoImageURL:
              type: string
              description: Displays the URL for the video image associated with the reward.
              example: https://videoimagewinteroffer.com
            productId:
              type: string
              description: >-
                Displays the product ID for the product associated with the
                reward.
              example: p567
            userTierId:
              type: integer
              description: Displays the ID for the member’s current tier.
              example: 6755
            userTierName:
              type: string
              description: Displays the name of the member’s current tier.
              example: Gold
            tierAchievedDate:
              type: string
              description: >-
                Displays the date the member achieved their current tier in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            rewardExpirationType:
              type: string
              description: Displays the reward expiration type as rolling or calendar.
              example: Rolling
            rewardExpirationPeriod:
              type: string
              description: >-
                Displays the time after which the reward expires in days,
                months, or years. If ‘Rolling’ is selected, the result appears
                in days, whereas ‘Calendar’ shows the result in a date range.
              example: 2 days
            eligible:
              type: string
              description: >-
                Displays YES if the member is eligible for the reward, otherwise
                it displays NO.
              example: 'YES'
            rewardExpirationStartDate:
              type: string
              description: >-
                In the reward, you have a date range within which it must be
                used to get the benefits. This displays the start date of the
                date range.
              example: 2022-08-01T00:00:00-0700
            rewardExpirationEndDate:
              type: string
              description: >-
                Displays the reward expiration date in yyyy-MM-dd'T'HH:mm:ssZ
                format. Once the reward expiration date is reached, the reward
                is no longer valID.
              example: 2022-08-01T00:00:00-0700
            nonEligibleReason:
              type: string
              description: >-
                Displays the reason why the member is not eligible for the
                reward.
              example: The reward can only be awarded once.
            additionalPointsRequired:
              type: integer
              description: >-
                Displays the number of additional points the member must earn to
                qualify for the reward. For example, if the reward threshold is
                set to 300 points and a member currently has 250 points, the
                member must earn 50 more points to get the benefit of the
                reward.
              example: 50
            yearSelected:
              type: integer
              description: >-
                Displays the year in which loyalty members are eligible to
                redeem the reward (if defined upon award configuration).
              example: 2022
            period:
              type: string
              description: >-
                Displays the period that the reward is available to eligible
                members. For example, monthly, quarterly, half-yearly or
                annually.
              example: Monthlly
            periodDetails:
              type: string
              description: >-
                Displays the month, quarter, or year in which the reward can be
                claimed based on the period defined upon configuration.
              example: January
            rewardLimit:
              type: integer
              description: >-
                Displays the limit for how many times a member can claim the
                reward. For example, If the maximum user claim count is set to
                five, the reward could be claimed only five times. If the
                maximum user claim count is set to zero, there is no restriction
                on claiming rewards based on availability.
              example: 3
            limitPeriod:
              type: string
              description: >-
                Displays the length of time the reward claim limit is in place.
                For example, if the claim limit was set to 4 and the limit
                period is “lifetime”, the member can only claim this reward 4
                times in their lifetime with the loyalty program.
              example: Lifetime
            redeemCount:
              type: integer
              description: >-
                Displays the number of times the reward has been redeemed by the
                member.
              example: 5
            remainingCount:
              type: integer
              description: >-
                Displays the remaining number of times the member can claim the
                reward. (Based on the Maximum User Claim Count). For example, if
                the maximum user claim count is 5 and the member has already
                claimed the reward 3 times, then the remaining count would be 2.
              example: 2
            reccuringLimit:
              type: integer
              description: >-
                Displays the maximum number of times the member can claim the
                reward if the Reward Eligibility is set to “Recurring” upon
                configuration.
              example: 2
            rewardEligibilityType:
              type: string
              description: Displays the type of reward eligibility as fixed or recurring.
              example: Fixed
            rewardEligibilityBasedOn:
              type: string
              description: >-
                Displays the eligibility criteria based on which the member can
                qualify for the reward. If reward eligibility type is “Fixed”,
                the member’s eligibility will be based on lifetime points,
                purchase amount, segment, or tier. If reward eligibility type is
                “Recurring”, the member’s eligibility will be based on earned
                points in a calendar year.
              example: Lifetime Points
            rewardEligibilityThreshold:
              type: integer
              description: >-
                Displays the number of points earned or amount to be spent by
                the member to qualify for the reward. (If eligibility is based
                on points earned or amount spent)
              example: 400
            eligibleSegmentId:
              type: integer
              description: >-
                Displays the segment ID for the segment of users eligible for
                the reward.
              example: 4567
            tierData:
              type: object
              properties:
                tierId:
                  type: integer
                  description: Displays the unique tier ID.
                  example: 1592
                tierName:
                  type: string
                  description: >-
                    Displays the name of the tier which the member must be a
                    part of to redeem the reward if reward eligibility is based
                    on tier.
                  example: Silver
                tierEligible:
                  type: string
                  description: >-
                    Displays YES if the member satisfies the tier criteria
                    otherwise NO.
                  example: 'YES'
                rewardLimit:
                  type: integer
                  description: >-
                    Displays the limit for how many times a member can claim the
                    reward. For example, If the maximum user claim count is set
                    to five, the reward could be claimed only five times. If the
                    maximum user claim count is set to zero, there is no
                    restriction on claiming rewards based on availability.
                  example: 10
                limitPeriod:
                  type: string
                  description: >-
                    Displays the length of time the reward claim limit is in
                    place.For example, if the claim limit was set to 4 and the
                    limit period is “lifetime”, the member can only claim this
                    reward 4 times in their lifetime with the loyalty program.
                  example: Lifetime
                overallRewardLimit:
                  type: integer
                  description: >-
                    Displays the maximum number of times the reward can be
                    claimed in total. For example, if the limit is 50, once the
                    reward has been claimed 50 times by any member or group of
                    members, the reward can no longer be claimed.
                  example: 50
                overallClaimCount:
                  type: integer
                  description: >-
                    Displays the number of times the reward has been claimed by
                    members.
                  example: 20
                rewardBalanceQuantity:
                  type: integer
                  description: >-
                    Displays the remaining number of times the reward can be
                    claimed by the member.
                  example: 30
            autoRewardStatus:
              type: string
              description: >-
                Displays whether the automate reward flag is enabled within the
                reward’s additional settings. If it is enabled, the response
                will display as YES. If it is not enabled, the response will be
                NO. If the flag is turned on, the following parameters will also
                appear.
              example: 'YES'
            autoRewardBasedOn:
              type: string
              description: >-
                Displays what criteria the automated reward is based on-
                Purchase Amount or Lifetime Points.
              example: Lifetime Points
            autoRewardClaimThresholdType:
              type: string
              description: >-
                Displays the threshold type to claim the reward automatically.
                It can be either rolling or fixed.
              example: Rolling
            autoRewardClaimThresholdValue:
              type: integer
              description: >-
                Displays the number of points or spend amount required by the
                member to claim the reward automatically.
              example: 1000
            autoRewardClaimLimit:
              type: integer
              description: >-
                Displays the number of times the reward can be claimed
                automatically.
              example: 5
            autoRewardClaimReason:
              type: string
              description: >-
                Displays the reason the member can claim the reward
                automatically.
              example: Auto Voucher claimed
            campaignDetails:
              type: object
              description: >-
                Displays the following data for the campaign associated with the
                reward if the member has completed the campaign milestones and
                qualified for the reward.
              properties:
                campaignId:
                  type: integer
                  description: Displays the unique campaign ID.
                  example: 12360
                campaignStatus:
                  type: string
                  description: >-
                    Displays the status of the campaign associated with the
                    reward as active, inactive or expired.
                  example: Expired
                memberCampaignStatus:
                  type: string
                  description: >-
                    Displays the member’s status in the campaign as completed or
                    uncompleted.
                  example: Completed
                campaignCompletionDate:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the member completed the campaign milestones.
                  example: 2018-04-01T00:00:00-0700
                totalMiletstone:
                  type: string
                  description: Displays the total number of milestones in the campaign.
                  example: 2
            campaignBenefit:
              type: object
              description: Displays the following details of the campaign benefit.
              properties:
                campaignBenefitType:
                  type: string
                  description: Displays the type of campaign benefit as a reward.
                  example: Reward
                campaignBenefitExpirationType:
                  type: string
                  description: >-
                    Displays the campaign benefit expiration type as rolling or
                    calendar. If ‘Rolling’ is selected, the result appears in
                    days, whereas ‘Calendar’ shows the result in weeks, months,
                    or years.
                  example: Fixed
                campaignBenefitExpirationStartDate:
                  type: string
                  description: >-
                    Displays the start date for when members are able to use the
                    reward earned for completing the campaign. (Based on Reward
                    Usage Date Range if the Reward Expiration is set to
                    Calendar.)
                  example: 2018-04-01T00:00:00-0700
                campaignBenefitExpirationDate:
                  type: string
                  description: >-
                    Displays the expiration date, when members can no longer use
                    the reward earned for completing the campaign. (Based on
                    Reward Usage Date Range if the Reward Expiration is set to
                    Calendar.)
                  example: 2018-04-01T00:00:00-0700
                campaignBenefitExpirationRollingPeriod:
                  type: string
                  description: >-
                    Displays the number of days members have to use the reward
                    after completing the campaign before it expires.
                  example: 1 Day
    getUsedRewards:
      type: object
      properties:
        rewardDetail:
          $ref: '#/components/schemas/getUsedRewards_rewardDetail'
    getUsedRewards_rewardDetail:
      type: object
      properties:
        rewardCode:
          type: string
          description: Displays the reward code used by the member.
          example: AP232
        rewardCodeExpDate:
          type: string
          description: >-
            Displays the reward code expiration date in yyyy-MM-dd’T’HH:mm:ssZ
            format if the reward code expiration flag is enabled at the site
            level.
          example: 2021-08-08T07:00:12+0000
        claimedDate:
          type: string
          description: >-
            Displays the date on which the reward was claimed by the member in
            DD-mon-YYYY mm:ssZ format.(The date format displayed within the
            platform is determined by the specific configuration settings of the
            site. These settings allow customization to align with regional
            preferences or organizational standards.)
          example: 29-Nov-2024 07:00:12+0000
        usedDate:
          type: string
          description: >-
            Displays the date on which the loyalty member used the Reward Code
            for a purchase in DD-mon-YYYY mm:ssZ format.(The date format
            displayed within the platform is determined by the specific
            configuration settings of the site. These settings allow
            customization to align with regional preferences or organizational
            standards.)
          example: 29-Nov-2024 07:00:12+0000
        pointsUsed:
          type: integer
          description: Displays the points used by the member to redeem the reward.
          example: 100
        rewardId:
          type: integer
          description: Displays the unique ID of the reward used by the member.
          example: 650767
        rewardName:
          type: string
          description: Displays the name of the reward used by the member.
          example: Jockey $15.00 off purchase
        rewardCategoryId:
          type: integer
          description: Displays the unique identifier assigned to each reward category.
          example: 413
        rewardCategory:
          type: string
          description: >-
            Displays the category assigned to the loyalty member's reward, used
            to differentiate rewards based on various member types or orders.
          example: New Reward01
        rewardType:
          type: string
          description: >-
            Displays the nature of the reward, making it easier for members and
            administrators to understand its purpose or value when interacting
            with the system. Note - This field is solely intended for display
            purposes within the API and does not influence its functionality,
            regardless of the value provided. Annex Cloud does not perform
            validation on the entered values, meaning that the system will
            accept and displays the input exactly as it is submitted, without
            modification or checks for accuracy.
          example: Gift Card
        rewardTerms:
          type: string
          description: Displays the terms and conditions for the reward.
          example: >-
            Points can be redeemed for rewards according to the current
            redemption schedule. Rewards may include discounts, merchandise, or
            other specified offers. Rewards are subject to availability and may
            be changed or discontinued at any time without notice. By
            participating in the Loyalty Program, you acknowledge that you have
            read, understood, and agree to abide by these terms and conditions.
        rewardDescription:
          type: string
          description: Displays the additional information related to the reward.
          example: Get 25% off your first product purchase.
        couponUsageLimit:
          type: integer
          description: >-
            Displays the limit for how many times a member can use the coupon.
            For example, if the coupon limit is set to five, it can only be
            redeemed five times.
          example: 5
        couponUsageCount:
          type: integer
          description: Displays the number of times the coupon has been used by the member.
          example: 3
        couponUsageRemainingCount:
          type: integer
          description: >-
            Displays the remaining number of times the member can claim the
            reward coupon. For example, if the maximum limit to avail the coupon
            is 5 and the member has already claimed the coupon 3 times, then the
            remaining count would be 2.
          example: 2
        couponUsageLimitPeriod:
          type: string
          description: >-
            Displays the time after which the coupon expires in days, months, or
            years.
          example: 2 Days
        rewardStatus:
          type: string
          description: Displays the reward status as claimed, used, or expired.
          example: Claimed
        reason:
          type: string
          description: Displays the reason for the current status of the reward.
          example: The reward has been claimed.
        sectionId:
          type: string
          description: >-
            If the reward is associated with a section of a survey, the section
            ID will be displayed.
          example: 654
        sectionName:
          type: string
          description: >-
            If the reward is associated with a section of a survey, the section
            name will be displayed.
          example: Sports Product
        surveyId:
          type: integer
          description: >-
            If the reward is associated with the completion of a survey, the
            survey ID will be displayed.
          example: 123
        surveyName:
          type: string
          description: >-
            If the reward is associated with the completion of a survey, the
            name of the survey will be displayed.
          example: General Survey
        createDate:
          type: string
          description: >-
            Displays the date and time the reward was created in
            yyyy-MM-dd’T’HH:mm:ssZ format.
          example: 2021-08-08T07:00:12+0000
        autoRewardStatus:
          type: string
          description: >-
            Displays whether the automate reward flag is enabled within the
            reward’s additional settings. If it is enabled, the response will
            display as YES. If it is not enabled, the response will be NO. If
            the flag is turned on, the following parameters will also appear.
          example: 'YES'
        autoRewardBasedOn:
          type: string
          description: >-
            Displays what criteria the automated reward is based on -Purchase
            Amount or Lifetime Points.
          example: Purchase Amount
        autoRewardClaimThresholdType:
          type: string
          description: >-
            Displays the points threshold type to claim the reward
            automatically. It can be either rolling or fixed.
          example: Rolling
        autoRewardClaimThresholdValue:
          type: integer
          description: >-
            Displays the number of points or spend amount required by the member
            to claim the reward automatically.
          example: 1000
        autoRewardClaimLimit:
          type: integer
          description: >-
            Displays the number of times the reward can be claimed
            automatically.
          example: 5
        autoRewardClaimReason:
          type: string
          description: Displays the reason the member can claim the reward automatically.
          example: Auto Voucher Claimed
        overallRewardLimit:
          type: integer
          description: >-
            Displays the maximum number of times the reward can be claimed in
            total. For example, if the limit is 50, once the reward has been
            claimed 50 times by any member or group of members, the reward can
            no longer be claimed.
          example: 50
        overallClaimCount:
          type: integer
          description: Displays the number of times the reward has been claimed by members.
          example: 20
        rewardBalanceQuantity:
          type: integer
          description: >-
            Displays the remaining number of times the reward can be claimed by
            the member.
          example: 30
        actionAttribute:
          type: object
          description: >-
            Action attributes allow you to capture additional metadata about an
            action. If configured, the following data will display.Note - This
            information will only be displayed if the Validate Extended
            Attribute Values flag is enabled in the action rules.
          properties:
            userRole:
              type: string
              description: >-
                Displays the user role defined by the administrator. This can be
                customized as per the client's request.
              example: Admin
        pages:
          type: integer
          description: Displays the total number of pages containing used rewards.
          example: 7
        current_page:
          type: integer
          description: >-
            Displays the current page number, that contains information related
            to the used rewards.
          example: 5
    postcampaignsResp:
      type: object
      properties:
        getCampaignByUserAndCampaignId:
          type: object
          description: >-
            NOTE 1- The following API response body displays when Super Admin
            flag - Update API structure to display complete campaign data is
            “Enabled”. NOTE 2- when Super admin flag - Update API structure to
            display complete campaign data is “disabled”, the audience object is
            shown at the header level after the campaignTagline parameter and
            only the first milestone audience is visible. Therefore, to see the
            audience details for each milestone the above flag should be
            enabled.
          properties:
            Campaign Details by Campaign ID and User ID:
              type: object
              properties:
                siteId:
                  type: string
                  description: Displays the unique internal Site ID.
                  example: '29235480'
                campaignId:
                  type: integer
                  description: Displays the unique internal Campaign ID.
                  example: 4700
                campaignGroupId:
                  type: integer
                  description: >-
                    Displays the ID of the campaign group to which the campaign
                    belongs. This parameter is visible only when the "Campaign
                    Group" super admin flag is enabled.
                  example: 3
                campaignName:
                  type: string
                  description: Displays the name of the campaign.
                  example: Back to School Savings!
                campaignDateFrom:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign becomes active.
                  example: 2023-02-25T15:32:00+0000
                campaignDateTo:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign stops being active.
                  example: 2023-02-25T15:32:00+0000
                individualValidityEnabled:
                  type: string
                  description: >-
                    Displays the status as "Yes" if Apply Individual Validity is
                    ON (enabled), or "No" if Apply Individual Validity is OFF
                    (disabled). For campaigns with “Apply Individual Validity “
                    enabled, provide start and end dates for each member based
                    on their user ID via individual validity API. Members can
                    only earn benefits during their individual validity period.
                  example: 'Yes'
                campaignImageUrl:
                  type: string
                  description: Displays the URL for the campaign image.
                  example: https://summeroffer.com/image/
                campaignDescription:
                  type: string
                  description: Displays the description of the campaign in encoded HTML.
                  example: Promotions for Back to School products.
                campaignTerms:
                  type: string
                  description: >-
                    Displays the terms and conditions of the campaign in encoded
                    HTML.
                  example: Only for Silver and Gold members.
                campaignTagline:
                  type: string
                  description: Displays the tagline of the campaign in encoded HTML.
                  example: Best deals ever.
                campaignStatus:
                  type: string
                  description: >-
                    Displays the status of the campaign. Active, Inactive,
                    Upcoming or Expired.
                  example: Active
                activationRequired:
                  type: string
                  description: >-
                    Displays the status as "Yes" if activation required is ON
                    (enabled), or "No" if activation required is OFF (disabled).
                    If "Activation Required" is enabled, members can achieve the
                    campaign benefits only after activating the campaign through
                    the Activation API.
                  example: 'Yes'
                campaignActivation:
                  type: object
                  description: Displays the details regarding the activation of campaigns
                  properties:
                    activated:
                      type: string
                      description: >-
                        Displays the value as “Yes” if the member has activated
                        the campaign; otherwise, it displays as “No”.
                      example: 'Yes'
                    activatedOn:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on
                        which the campaign was activated by the member.
                      example: 2024-07-10T15:32:00+0000
                memberCampaignStatus:
                  type: string
                  description: >-
                    Displays the member’s status in the campaign. Complete,
                    Incomplete
                  example: Complete
                memberCampaignCompletedDate:
                  type: string
                  description: >-
                    If memberCampaignStatus is Complete, Displays the date in
                    yyyy-MM-dd'T'HH:mm:ssZ format on which the member completed
                    the campaign. Otherwise, blank.
                  example: 2023-02-25T15:32:00+0000
                campaignAttributes:
                  type: object
                  description: >-
                    Displays the campaign data related to the Campaign extended
                    attributes configured for the program. These extended
                    attributes can be configured under Additional Loyalty
                    Settings to capture additional metadata for campaigns.
                  properties:
                    partnerCode:
                      type: string
                      description: >-
                        Displays the unique identifier used to associate the
                        campaign with a specific partner. This is an example of
                        a Campaign extended attribute. “partnerCode” could be
                        used to display the unique identifier used to associate
                        the campaign with a specific partner.
                      example: '411211'
                campaignCreateDate:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign was created.
                  example: 2023-02-25T15:32:00+0000
                campaignUpdateDate:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign was last updated.
                  example: 2023-02-25T15:32:00+0000
                campaignGroupName:
                  type: string
                  description: Displays the name of the campaign group, if any.
                  example: Group One
                totalMileStones:
                  type: integer
                  description: >-
                    Displays the total number of milestones created in the
                    campaign.
                  example: 1
                completedMileStones:
                  type: integer
                  description: Displays the number of milestones the member completed.
                  example: 1
                pendingMileStones:
                  type: integer
                  description: >-
                    Displays the number of milestones the member has not
                    completed.
                  example: 0
                audience:
                  type: object
                  description: >-
                    Displays the audience selected for the campaign (segment and
                    tier).
                  properties:
                    segmentId:
                      type: string
                      description: >-
                        Displays the ID of the segment selected for the
                        respective campaign milestone, if any.
                      example: 1338d
                    segment:
                      type: string
                      description: >-
                        Displays the name of the segment selected for the
                        campaign milestone , if any.
                      example: California
                    tier:
                      type: string
                      description: >-
                        Displays the name of the tier(s) selected for the
                        campaign milestone, if any.
                      example: Gold
                totalPurchaseCount:
                  type: integer
                  description: >-
                    Displays the member’s total number of purchases in the
                    campaign. Some purchases in the campaign may not return a
                    reward or benefit.
                  example: 3
                qualifiedPurchaseCount:
                  type: integer
                  description: >-
                    Displays the number of purchases by the member that generate
                    rewards or benefits in the campaign.
                  example: 2
                mileStone:
                  type: object
                  description: >-
                    Displays an array containing the details of milestones
                    included in the campaign.
                  properties:
                    name:
                      type: string
                      description: Displays the name of the milestone.
                      example: Week 1 Incentives
                    milestoneStatus:
                      type: string
                      description: Displays the member’s status in the milestone.
                      example: 2024-07-11T15:32:00+0000
                    milestoneCompletedDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on
                        which the member completed the milestone.
                      example: 2023-02-25T15:32:00+0000
                    description:
                      type: string
                      description: Displays a summary of the milestone.
                      example: Earn points on beer, wine, and spirits!
                    type:
                      type: string
                      description: >-
                        Displays the type of milestone - Action or Action
                        Series.
                      example: Action
                    typeDetail:
                      type: string
                      description: Displays the name of the Action or Action Series
                      example: Purchase
                    actionId:
                      type: integer
                      description: Displays the internal ID for the Action or Action Series
                      example: 109
                    actionDescription:
                      type: string
                      description: Displays a description of the Action.
                      example: Purchase
                    requiredCredit:
                      type: integer
                      description: >-
                        Displays the points or count required to complete the
                        Action Series. It only appears when the milestone is
                        based on Action Series.
                      example: 3
                    completedCredit:
                      type: integer
                      description: >-
                        Displays the points or count completed by the member to
                        achieve the Action Series. It only appears when the
                        milestone is based on Action Series.
                      example: 1
                    pendingCredit:
                      type: integer
                      description: >-
                        Displays the points or count pending to complete the
                        Action Series. It only appears when the milestone is
                        based on Action Series.
                      example: 2
                    benefitName:
                      type: string
                      description: Displays the name of the milestone benefit as Bonus
                      example: Bonus
                    benefitvalue:
                      type: string
                      description: Displays the value of the milestone bonus.
                      example: 400
                    benefitActiveImageUrl:
                      type: string
                      description: >-
                        Displays the URL of the milestone benefit image when the
                        benefit is active.
                      example: https://developer.mozilla.org
                    benefitInactiveImageUrl:
                      type: string
                      description: >-
                        Displays the URL of the milestone benefit image when the
                        benefit is inactive.
                      example: https://developer.mozilla.org
                    benefitRedemptionDate:
                      type: string
                      description: >-
                        Displays the points expiration date after member
                        completes the milestone.
                      example: 2023-02-25T15:32:00+0000
                    benefitStatus:
                      type: string
                      description: >-
                        Displays the status of the benefit offered to the member
                        as part of the campaign. These are
                        Unavailable/Available/Awarded/Used/Expired. 
                        UNAVAILABLE-  The benefit is not accessible or eligible
                        for the member.  AVAILABLE- The benefit is active and
                        ready for the member to claim or use.  AWARDED- The
                        benefit has been successfully granted to the member’s
                        account.  USED- The member has redeemed or utilized the
                        benefit.  EXPIRED- The benefit is no longer valid due to
                        the expiration of the campaign or time limit.
                      example: Awarded
                    bonusPoints:
                      type: string
                      description: >-
                        Displays the campaign points earned against the
                        milestone.
                      example: 50
                campaignBenefit:
                  type: object
                  description: Displays benefit set up for the campaign.
                  properties:
                    campaignBenefitType:
                      type: string
                      description: >-
                        Displays the type of the campaign benefit - Campaign
                        Bonus Points or Reward.
                      example: Campaign Bonus Points
                    campaignBenefitName:
                      type: string
                      description: Displays the name of the campaign benefit.
                      example: 400 bonus points
                    campaignBenefitValue:
                      type: string
                      description: >-
                        Displays the value of the campaign benefit.In case of
                        bonus, it displays the campaign bonus points.In case of
                        Reward, it displays the associated reward name.
                      example: '200'
                    campaignBenefitCode:
                      type: string
                      description: >-
                        Displays the reward code associated with the campaign
                        benefit.
                      example: '654321'
                    campaignBenefitImageUrl:
                      type: string
                      description: Displays the URL of the campaign benefit image.
                      example: https://developer.mozilla.org
                    campaignBenefitExpirationDate:
                      type: string
                      description: Displays the campaign benefit expiration date.
                      example: 2023-02-25T15:32:00+0000
                    campaignBenefitStatus:
                      type: string
                      description: >-
                        Options for this field include - UNAVAILABLE - The
                        campaign benefit is set as Reward and there is no code
                        available in the associated Reward. AVAILABLE - The
                        campaign benefit is set as Bonus or Reward (code must
                        exist in the reward) and the member has not achieved the
                        campaign milestone(s). That is, the campaign is not yet
                        completed. AWARDED - The member has completed the
                        campaign, and the campaign benefit as bonus or reward is
                        awarded to them. USED - The campaign benefit is set as
                        Reward and the awarded Reward has been used by the
                        member. EXPIRED -The campaign benefit is set as Reward
                        and the reward code expired without use.
                      example: AWARDED
                individualValidity:
                  type: object
                  description: >-
                    Displays array details only when the
                    individualValidityEnabled = Yes.
                  properties:
                    individualValidityStartDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when
                        the individual validity started. If a user’s time zone
                        is specified, dates should be sent in that respective
                        time zone. If no time zone is set, dates should be sent
                        in UTC.
                      example: 2024-07-11T15:32:00+0000
                    individualValidityEndDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when
                        the individual validity ended. If a user’s time zone is
                        specified, dates should be sent in that respective time
                        zone. If no time zone is set, dates should be sent in
                        UTC.
                      example: 2024-07-11T15:32:00+0000
            Campaign Details by Campaign Status and User ID:
              type: object
              properties:
                siteId:
                  type: string
                  description: Displays the unique internal Site ID.
                  example: '29235480'
                id:
                  type: string
                  description: Displays the member’s unique internal User ID.
                  example: db25
                email:
                  type: string
                  description: >-
                    Displays the member’s email address. This may or may not be
                    the same as the User ID.
                  example: user@domain.com
                firstName:
                  type: string
                  description: Displays the member’s first name.
                  example: John
                lastName:
                  type: string
                  description: Displays the member’s last name.
                  example: Carter
                userCampaignDetails:
                  type: object
                  description: >-
                    Displays an array containing the member’s details for the
                    campaign.
                  properties:
                    campaignId:
                      type: integer
                      description: Displays the unique internal Campaign ID.
                      example: 4700
                    campaignGroupId:
                      type: integer
                      description: >-
                        Displays the ID of the campaign group to which the
                        campaign belongs. This parameter is visible only when
                        the "Campaign Group" super admin flag is enabled.
                      example: 3
                    campaignName:
                      type: string
                      description: Displays the name of the campaign.
                      example: Back to School Savings!
                    campaignDateFrom:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on
                        which the campaign becomes active.
                      example: 2021-08-08T07:00:12+0000
                    campaignDateTo:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on
                        which the campaign stops being active.
                      example: 2021-08-08T07:00:12+0000
                    individualValidityEnabled:
                      type: string
                      description: >-
                        Displays the status as "Yes" if Apply Individual
                        Validity is ON (enabled), or "No" if Apply Individual
                        Validity is OFF (disabled). For campaigns with “Apply
                        Individual Validity “ enabled, provide start and end
                        dates for each member based on their user ID via
                        individual validity API. Members can only earn benefits
                        during their individual validity period.
                      example: 'Yes'
                    campaignImageUrl:
                      type: string
                      description: Displays the URL for the campaign image.
                      example: https://summeroffer.com/image/
                    campaignDescription:
                      type: string
                      description: >-
                        Displays the description of the campaign in encoded
                        HTML.
                      example: Promotions for Back to School products.
                    campaignTerms:
                      type: string
                      description: >-
                        Displays the terms and conditions of the campaign in
                        encoded HTML.
                      example: Only for Silver and Gold members.
                    campaignTagline:
                      type: string
                      description: Displays the tagline of the campaign in encoded HTML.
                      example: Best deals ever.
                    campaignGroupName:
                      type: string
                      description: Displays the group associated with the campaign, if any.
                      example: Group One
                    campaignStatus:
                      type: string
                      description: >-
                        Displays the status of the campaign. Active, Inactive,
                        Upcoming or Expired.
                      example: Active
                    activationRequired:
                      type: string
                      description: >-
                        Displays the status as "Yes" if activation required is
                        ON (enabled), or "No" if activation required is OFF
                        (disabled). If "Activation Required" is enabled, members
                        can achieve the campaign benefits only after activating
                        the campaign through the Activation API.
                      example: 'Yes'
                    campaignActivation:
                      type: object
                      description: >-
                        Displays the details regarding the activation of
                        campaigns
                      properties:
                        activated:
                          type: string
                          description: >-
                            Displays the value as “Yes” if the member has
                            activated the campaign; otherwise, it displays as
                            “No”.
                          example: 'Yes'
                        activatedOn:
                          type: string
                          description: >-
                            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format
                            on which the campaign was activated by the member.
                          example: 2024-07-10T15:32:00+0000
                    memberCampaignStatus:
                      type: string
                      description: >-
                        Displays the member’s status in the campaign. Complete,
                        Incomplete
                      example: Complete
                    memberCampaignCompletedDate:
                      type: string
                      description: >-
                        If memberCampaignStatus is Complete, Displays the date
                        in yyyy-MM-dd'T'HH:mm:ssZ format on which the member
                        completed the campaign. Otherwise, blank.
                      example: 2023-02-25T15:32:00+0000
                    campaignAttributes:
                      type: object
                      description: >-
                        Displays the campaign data related to the Campaign
                        extended attributes configured for the program. These
                        extended attributes can be configured under Additional
                        Loyalty Settings to capture additional metadata for
                        campaigns.
                      properties:
                        partnerCode:
                          type: string
                          description: >-
                            Displays the unique identifier used to associate the
                            campaign with a specific partner. This is an example
                            of a Campaign extended attribute. “partnerCode”
                            could be used to display the unique identifier used
                            to associate the campaign with a specific partner.
                          example: '411211'
                    campaignCreateDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on
                        which the campaign was created.
                      example: 2023-02-25T15:32:00+0000
                    campaignUpdateDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on
                        which the campaign was last updated.
                      example: 2023-02-25T15:32:00+0000
                    totalMileStones:
                      type: integer
                      description: >-
                        Displays the total number of milestones created in the
                        campaign.
                      example: 1
                    completedMileStones:
                      type: integer
                      description: Displays the number of milestones the member completed.
                      example: 1
                    pendingMileStones:
                      type: integer
                      description: >-
                        Displays the number of milestones the member has not
                        completed.
                      example: 0
                    audience:
                      type: object
                      description: >-
                        Displays the audience selected for the campaign (segment
                        and tier).
                      properties:
                        segmentId:
                          type: string
                          description: >-
                            Displays the ID of the segment selected for the
                            respective campaign milestone, if any.
                          example: 1338
                        segment:
                          type: string
                          description: >-
                            Displays the name of the segment selected for the
                            campaign milestone , if any.
                          example: California
                        tier:
                          type: string
                          description: >-
                            Displays the name of the tier(s) selected for the
                            campaign milestone, if any.
                          example: Gold
                    totalPurchaseCount:
                      type: integer
                      description: >-
                        Displays the member’s total number of purchases in the
                        campaign. Some purchases in the campaign may not return
                        a reward or benefit.
                      example: 3
                    qualifiedPurchaseCount:
                      type: integer
                      description: >-
                        Displays the number of purchases by the member that
                        generate rewards or benefits in the campaign.
                      example: 2
                    mileStone:
                      type: object
                      description: >-
                        Displays an array containing the details of milestones
                        included in the campaign.
                      properties:
                        name:
                          type: string
                          description: Displays the name of the milestone.
                          example: Week 1 Incentives
                        milestoneStatus:
                          type: string
                          description: Displays the member’s status in the milestone.
                          example: Completed
                        milestoneCompletedDate:
                          type: string
                          description: >-
                            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format
                            on which the member completed the milestone.
                          example: 2023-02-25T15:32:00+0000
                        description:
                          type: string
                          description: Displays a summary of the milestone.
                          example: Earn points on beer, wine, and spirits!
                        type:
                          type: string
                          description: >-
                            Displays the type of milestone - Action or Action
                            Series.
                          example: Action
                        typeDetail:
                          type: string
                          description: Displays the name of the Action or Action Series
                          example: Purchase
                        actionId:
                          type: integer
                          description: >-
                            Displays the internal ID for the Action or Action
                            Series
                          example: 109
                        actionDescription:
                          type: string
                          description: Displays a description of the Action.
                          example: Purchase
                        requiredCredit:
                          type: integer
                          description: >-
                            Displays the points or count required to complete
                            the Action Series. It only appears when the
                            milestone is based on Action Series.
                          example: 3
                        completedCredit:
                          type: integer
                          description: >-
                            Displays the points or count completed by the member
                            to achieve the Action Series. It only appears when
                            the milestone is based on Action Series.
                          example: 1
                        pendingCredit:
                          type: integer
                          description: >-
                            Displays the points or count pending to complete the
                            Action Series. It only appears when the milestone is
                            based on Action Series.
                          example: 2
                        benefitName:
                          type: string
                          description: Displays the name of the milestone benefit as Bonus
                          example: Bonus
                        benefitvalue:
                          type: string
                          description: Displays the value of the milestone bonus.
                          example: 400
                        benefitactiveImageUrl:
                          type: string
                          description: >-
                            Displays the URL of the milestone benefit image when
                            the benefit is active.
                          example: https://developer.mozilla.org
                        benefitInactiveImageUrl:
                          type: string
                          description: >-
                            Displays the URL of the milestone benefit image when
                            the benefit is inactive.
                          example: https://developer.mozilla.org
                        benefitRedemptionDate:
                          type: string
                          description: >-
                            Displays the points expiration date after member
                            completes the milestone.
                          example: 2023-02-25T15:32:00+0000
                        benefitStatus:
                          type: string
                          description: >-
                            Displays the status of the benefit offered to the
                            member as part of the campaign. These are
                            Unavailable/Available/Awarded/Used/Expired. 
                            UNAVAILABLE-  The benefit is not accessible or
                            eligible for the member.  AVAILABLE- The benefit is
                            active and ready for the member to claim or use. 
                            AWARDED- The benefit has been successfully granted
                            to the member’s account.  USED- The member has
                            redeemed or utilized the benefit.  EXPIRED- The
                            benefit is no longer valid due to the expiration of
                            the campaign or time limit.
                          example: Awarded
                        bonusPoints:
                          type: integer
                          description: >-
                            Displays the campaign points earned against the
                            milestone.
                          example: 50
                    campaignBenefit:
                      type: object
                      description: Displays benefit set up for the campaign.
                      properties:
                        campaignBenefitType:
                          type: string
                          description: >-
                            Displays the type of the campaign benefit - Campaign
                            Bonus Points or Reward.
                          example: Campaign Bonus Points
                        campaignBenefitName:
                          type: string
                          description: Displays the name of the campaign benefit.
                          example: 400 bonus points
                        campaignBenefitValue:
                          type: integer
                          description: >-
                            Displays the value of the campaign benefit.In case
                            of bonus, it Displays the Campaign Bonus points.In
                            case of Reward, it Displays the associated Reward
                            Name.
                          example: 200
                        campaignBenefitCode:
                          type: string
                          description: >-
                            Displays the reward code associated with the
                            campaign benefit.
                          example: 654321
                        campaignBenefitImageUrl:
                          type: string
                          description: Displays the URL of the campaign benefit image.
                          example: https://developer.mozilla.org
                        campaignBenefitExpirationDate:
                          type: string
                          description: Displays the campaign benefit expiration date.
                          example: 2023-02-25T15:32:00+0000
                        campaignBenefitStatus:
                          type: string
                          description: >-
                            Options for this field include - UNAVAILABLE - The
                            campaign benefit is set as Reward and there is no
                            code available in the associated Reward. AVAILABLE -
                            The campaign benefit is set as Bonus or Reward (code
                            must exist in the reward) and the member has not
                            achieved the campaign milestone(s). That is, the
                            campaign is not yet completed. AWARDED - The member
                            has completed the campaign, and the campaign benefit
                            as bonus or reward is awarded to them. USED - The
                            campaign benefit is set as Reward and the awarded
                            Reward has been used by the member. EXPIRED -The
                            campaign benefit is set as Reward and the reward
                            code expired without use.
                          example: AWARDED
                    individualValidity:
                      type: object
                      description: >-
                        Displays array details only when the
                        individualValidityEnabled = Yes.
                      properties:
                        individualValidityStartDate:
                          type: string
                          description: >-
                            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format
                            when the individual validity started. If a user’s
                            time zone is specified, dates should be sent in that
                            respective time zone. If no time zone is set, dates
                            should be sent in UTC.
                          example: 2024-07-11T15:32:00+0000
                        individualValidityEndDate:
                          type: string
                          description: >-
                            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format
                            when the individual validity ended. If a user’s time
                            zone is specified, dates should be sent in that
                            respective time zone. If no time zone is set, dates
                            should be sent in UTC.
                          example: 2024-07-11T15:32:00+0000
                records:
                  type: integer
                  description: >-
                    Displays the total number of records found related to the
                    campaign.
                  example: 7
                pages:
                  type: integer
                  description: Displays the total number of pages.
                  example: 7
                currentPage:
                  type: integer
                  description: Displays the current page number
                  example: 1
    getcampaignstatusresp:
      type: object
      properties:
        allCampaignDetails:
          type: object
          description: >-
            Displays details for campaigns according to the campaignStatus
            parameter
          properties:
            siteId:
              type: string
              description: Displays the unique internal Site ID.
              example: '29235480'
            campaignId:
              type: integer
              description: Displays the unique internal Campaign ID.
              example: 6776
            campaignGroupId:
              type: integer
              description: >-
                Displays the ID of the campaign group to which the campaign
                belongs. This parameter is visible only when the "Campaign
                Group" super admin flag is enabled.
              example: 3
            campaignName:
              type: string
              description: Displays the name of the campaign.
              example: End of Summer
            campaignDateFrom:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign becomes active.
              example: 2021-08-08T07:00:12+0000
            campaignDateTo:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign stops being active.
              example: 2021-08-08T07:00:12+0000
            individualValidityEnabled:
              type: string
              description: >-
                Displays the status as "Yes" if Apply Individual Validity is ON
                (enabled), or "No" if Apply Individual Validity is OFF
                (disabled). For campaigns with “Apply Individual Validity “
                enabled, provide start and end dates for each member based on
                their user ID via individual validity API. Members can only earn
                benefits during their individual validity period.
              example: 'No'
            campaignImageUrl:
              type: string
              description: Displays the URL for the campaign image.
              example: https://summeroffer.com/image
            campaignDescription:
              type: string
              description: Displays the description of the campaign in encoded HTML.
              example: Promotions for Back to School products.
            campaignTerms:
              type: string
              description: >-
                Displays the terms and conditions of the campaign in encoded
                HTML.
              example: Limited to Gold members. Valid from 8/1/2023 to 8/31/2023.
            campaignTagline:
              type: string
              description: Displays the tagline of the campaign in encoded HTML.
              example: Best campaign ever.
            audience:
              type: object
              description: >-
                Displays the audience selected for the campaign (segment and
                tier) [When the Super Admin flag - Update API structure to
                display complete campaign data is “disabled”, then the audience
                array appears at the header level as described below.].
              properties:
                segmentId:
                  type: string
                  description: >-
                    Displays the ID of the segment selected for the respective
                    campaign milestone, if any.
                  example: 1338d
                segment:
                  type: string
                  description: >-
                    Displays the name of the segment selected for the campaign
                    milestone , if any.
                  example: California
                tier:
                  type: string
                  description: >-
                    Displays the name of the tier(s) selected for the campaign
                    milestone, if any.
                  example: Silver
            campaignStatus:
              type: string
              description: >-
                Displays the status of the campaign. Active, Inactive, Upcoming
                or Expired.
              example: Active
            activationRequired:
              type: string
              description: >-
                Displays the status as "Yes" if activation required is ON
                (enabled), or "No" if activation required is OFF (disabled). If
                "Activation Required" is enabled, members can achieve the
                campaign benefits only after activating the campaign through the
                Activation API.
              example: 'No'
            campaignGroupName:
              type: string
              description: Displays the group selected for the campaign, if any.
              example: Group One
            numberofMilestones:
              type: integer
              description: Displays the number of milestones present in the campaign.
              example: 1
            campaignAttributes:
              type: object
              description: >-
                Displays the campaign data related to the Campaign extended
                attributes configured for the program. These extended attributes
                can be configured under Additional Loyalty Settings to capture
                additional metadata for campaigns.
              properties:
                partnerCode:
                  type: string
                  description: >-
                    Displays the unique identifier used to associate the
                    campaign with a specific partner. This is an example of a
                    Campaign extended attribute. “partnerCode” could be used to
                    display the unique identifier used to associate the campaign
                    with a specific partner.
                  example: '411211'
            campaignCreateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign was created.
              example: 2021-08-08T07:00:12+0000
            campaignUpdateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign was updated.
              example: 2021-08-08T07:00:12+0000
        pages:
          type: integer
          description: Displays the total number of pages.
          example: 7
        currentPage:
          type: integer
          description: Displays the current page number
          example: 1
    getcampaigncampaignidresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the unique internal Site ID.
          example: '29235480'
        campaignId:
          type: integer
          description: Displays the unique internal Campaign ID.
          example: 4872
        campaignGroupId:
          type: integer
          description: >-
            Displays the ID of the campaign group to which the campaign belongs.
            This parameter is visible only when the "Campaign Group" super admin
            flag is enabled.
          example: 3
        campaignName:
          type: string
          description: Displays the name of the campaign.
          example: Back to School Savings
        campaignDateFrom:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign becomes active.
          example: 2021-08-08T07:00:12+0000
        campaignDateTo:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign stops being active.
          example: 2021-08-08T07:00:12+0000
        individualValidityEnabled:
          type: string
          description: >-
            Displays the status as "Yes" if Apply Individual Validity is ON
            (enabled), or "No" if Apply Individual Validity is OFF (disabled).
            For campaigns with “Apply Individual Validity “ enabled, provide
            start and end dates for each member based on their user ID via
            individual validity API. Members can only earn benefits during their
            individual validity period.
          example: 'Yes'
        campaignImageUrl:
          type: string
          description: Displays the URL for the campaign image.
          example: https://summeroffer.com/image
        campaignDescription:
          type: string
          description: Displays the description of the campaign in encoded HTML.
          example: Promotions for Back to School products.
        campaignTerms:
          type: string
          description: Displays the terms and conditions of the campaign in encoded HTML.
          example: Limited to Gold members. Valid from 8/1/2023 to 8/31/2023.
        campaignTagline:
          type: string
          description: Displays the tagline of the campaign in encoded HTML.
          example: JTNDcCUzRXBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcHBwcCUzQyUyRnAlM0UlMEE
        audience:
          type: object
          description: >-
            Displays the audience selected for the campaign (segment and tier)
            [When the Super Admin flag - Update API structure to display
            complete campaign data is “disabled”, then the audience array
            appears at the header level as described below.].
          properties:
            segmentId:
              type: string
              description: >-
                Displays the ID of the segment selected for the respective
                campaign milestone, if any.
              example: 1338d
            segment:
              type: string
              description: >-
                Displays the name of the segment selected for the campaign
                milestone , if any.
              example: California
            tier:
              type: string
              description: >-
                Displays the name of the tier(s) selected for the campaign
                milestone, if any.
              example: Silver
        campaignStatus:
          type: string
          description: >-
            Displays the status of the campaign. Active, Inactive, Upcoming or
            Expired.
          example: Active
        activationRequired:
          type: string
          description: >-
            Displays the status as "Yes" if activation required is ON (enabled),
            or "No" if activation required is OFF (disabled). If "Activation
            Required" is enabled, members can achieve the campaign benefits only
            after activating the campaign through the Activation API.
          example: 'Yes'
        campaignGroupName:
          type: string
          description: Displays the group selected for the campaign, if any.
          example: Elite group
        campaignAttributes:
          type: object
          description: >-
            Displays the campaign data related to the Campaign extended
            attributes configured for the program. These extended attributes can
            be configured under Additional Loyalty Settings to capture
            additional metadata for campaigns.
          properties:
            partnerCode:
              type: string
              description: >-
                Displays the unique identifier used to associate the campaign
                with a specific partner. This is an example of a Campaign
                extended attribute. “partnerCode” could be used to display the
                unique identifier used to associate the campaign with a specific
                partner.
              example: '411211'
        campaignCreateDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign was created.
          example: 2021-08-08T07:00:12+0000
        campaignUpdateDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign was last updated.
          example: 2021-08-08T07:00:12+0000
        milestone:
          type: object
          description: >-
            Displays an array containing the details of milestones included in
            the campaign.
          properties:
            name:
              type: string
              description: Displays the name of the milestone.
              example: Elite Milestone
            description:
              type: string
              description: Displays the milestone description.
              example: Applicable for specific Stores
            type:
              type: string
              description: Displays the type of milestone - Action or Action Series.
              example: Action
            detail:
              type: string
              description: Displays the name of the Action or Action Series.
              example: Purchase
            actionId:
              type: integer
              description: Displays the Action ID of the selected Action.
              example: 109
            actionDescription:
              type: string
              description: Displays the description of the action.
              example: 2x for all purchases made from the Segment listed stores.
            benefitName:
              type: string
              description: Displays the name of the benefit as Bonus
              example: Bonus
            benefitValue:
              type: string
              description: Displays the value of the benefit.
              example: 2
            benefitActiveImageUrl:
              type: string
              description: >-
                Displays the URL assigned to the benefit if the member has
                completed the milestone.
              example: MDN Web Docs
            benefitInactiveImageUrl:
              type: string
              description: >-
                Displays the URL assigned to the benefit if the member has not
                completed the milestone.
              example: MDN Web Docs
            benefitRedemptionDate:
              type: string
              description: >-
                Displays the date the benefit was redeemed. For example,
                spending bonus points or ordering a free item.
              example: 2024-08-08T07:00:12+0000
        campaignBenefit:
          type: object
          description: Displays any additional benefit set up for campaign
          properties:
            campaignBenefitType:
              type: string
              description: >-
                Displays the type of campaign benefit. Campaign Bonus Points or
                Reward.
              example: Campaign Bonus Points
            campaignBenefitName:
              type: string
              description: Displays the name of the campaign benefit.
              example: Even More Bonus Points
            campaignBenefitValue:
              type: integer
              description: >-
                Displays the value of the campaign benefit. In case of bonus, it
                displays the Campaign Bonus points. In case of Reward, it
                displays the associated Reward ID.
              example: 100
            campaignBenefitImageUrl:
              type: string
              description: Displays the URL of the campaign benefit image.
              example: MDN Web Docs
            campaignBenefitExpirationType:
              type: string
              description: Displays the campaign benefit expiration type.
              example: Rolling
            campaignBenefitExpirationRollingPeriod:
              type: string
              description: >-
                Displays the time frame during which a benefit associated with a
                campaign remains valid from the date it is issued.
              example: 0 days
            campaignBenefitExpirationDate:
              type: string
              description: >-
                Displays the campaign benefit expiration date in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
    getusersidcampaignresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the unique internal Site ID.
          example: '29235480'
        id:
          type: string
          description: Displays the member’s unique internal member ID
          example: 252927
        email:
          type: string
          description: >-
            Displays the member’s email address. This may or may not be the same
            as the member ID.
          example: user@domain.com
        firstName:
          type: string
          description: Displays the member’s first name.
          example: Frank
        lastName:
          type: string
          description: Displays the member’s last name.
          example: Jones
        userCampaignDetails:
          type: object
          description: Displays an array containing the member’s details for the campaign.
          properties:
            campaignId:
              type: integer
              description: Displays the unique internal Campaign ID.
              example: 4700
            campaignGroupId:
              type: integer
              description: >-
                Displays the ID of the campaign group to which the campaign
                belongs. This parameter is visible only when the "Campaign
                Group" super admin flag is enabled.
              example: 123
            campaignName:
              type: string
              description: Displays the name of the campaign.
              example: Back to School Savings
            campaignDateFrom:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign becomes active.
              example: 2021-08-08T07:00:12+0000
            campaignDateTo:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign stops being active.
              example: 2021-08-08T07:00:12+0000
            individualValidityEnabled:
              type: string
              description: >-
                Displays the status as "Yes" if Apply Individual Validity is ON
                (enabled), or "No" if Apply Individual Validity is OFF
                (disabled). For campaigns with “Apply Individual Validity “
                enabled, provide start and end dates for each member based on
                their user ID via individual validity API. Members can only earn
                benefits during their individual validity period.
              example: 'Yes'
            campaignImageUrl:
              type: string
              description: Displays the URL for the campaign image.
              example: https://summeroffer.com/image
            campaignDescription:
              type: string
              description: Displays the description of the campaign in encoded HTML.
              example: Promotions for Back to School products.
            campaignTerms:
              type: string
              description: >-
                Displays the terms and conditions of the campaign in encoded
                HTML.
              example: Limited to Gold members. Valid from 8/1/2023 to 8/31/2023.
            campaignTagline:
              type: string
              description: Displays the tagline of the campaign in encoded HTML.
              example: Best Deals ever
            campaignGroupName:
              type: string
              description: Displays the group selected the campaign, if any.
              example: Elite Group
            campaignStatus:
              type: string
              description: >-
                Displays the status of the campaign. Active, Inactive, Upcoming
                or Expired.
              example: Active
            activationRequired:
              type: string
              description: >-
                Displays the status as "Yes" if activation required is ON
                (enabled), or "No" if activation required is OFF (disabled). If
                "Activation Required" is enabled, members can achieve the
                campaign benefits only after activating the campaign through the
                Activation API.
              example: 'Yes'
            campaignActivation:
              type: object
              description: Displays the details regarding the activation of campaigns
              properties:
                activated:
                  type: string
                  description: >-
                    Displays the value as “Yes” if the member has activated the
                    campaign; otherwise, it displays as “No”.
                  example: 'Yes'
                activatedOn:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign was activated by the member.
                  example: 2024-07-10T15:32:00+0000
            audience:
              type: object
              description: >-
                Displays the audience selected for the campaign (segment and
                tier)  [ When the Super Admin flag - Update API structure to
                display complete campaign data is “disabled”, then the audience
                array appears at the header level as described below.].
              properties:
                segmentId:
                  type: string
                  description: >-
                    Displays the ID of the segment selected for the respective
                    campaign milestone, if any.
                  example: 1338d
                segment:
                  type: string
                  description: >-
                    Displays the name of the segment selected for the campaign
                    milestone , if any.
                  example: California
                tier:
                  type: string
                  description: >-
                    Displays the name of the tier(s) selected for the campaign
                    milestone, if any.
                  example: Silver
            memberCampaignStatus:
              type: string
              description: >-
                Displays the member’s status in the campaign. Complete,
                incomplete
              example: Complete
            memberCampaignCompletedDate:
              type: string
              description: >-
                If memberCampaignStatus is Complete, displays the date in
                yyyy-MM-dd'T'HH:mm:ssZ format on which the member completed the
                campaign. Otherwise, blank.
              example: 2020-02-25T15:32:00+0000
            campaignAttributes:
              type: object
              description: >-
                Displays the campaign data related to the Campaign extended
                attributes configured for the program. These extended attributes
                can be configured under Additional Loyalty Settings to capture
                additional metadata for campaigns.
              properties:
                partnerCode:
                  type: string
                  description: >-
                    Displays the unique identifier used to associate the
                    campaign with a specific partner. This is an example of a
                    Campaign extended attribute. “partnerCode” could be used to
                    display the unique identifier used to associate the campaign
                    with a specific partner.
                  example: '411211'
            campaignCreateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign was created.
              example: 2021-08-08T07:00:12+0000
            campaignUpdateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign was last updated.
              example: 2021-08-08T07:00:12+0000
            qualifiedPurchaseCount:
              type: string
              description: >-
                Displays the number of purchases by the member that generate
                rewards or benefits in the campaign.
              example: '2'
            totalPurchaseCount:
              type: string
              description: >-
                Displays the member’s total number of purchases in the campaign.
                Some purchases in the campaign may not return a reward or
                benefit.
              example: '5'
            milestone:
              type: object
              description: >-
                Displays an array containing the details of milestones included
                in the campaign.
              properties:
                name:
                  type: string
                  description: Displays the name of the milestone.
                  example: Week 1 Incentives
                milestoneStatus:
                  type: string
                  description: Displays the member’s status of the milestone.
                  example: Completed
                milestoneCompletedDate:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the member completed the milestone.
                  example: 2020-03-25T15:32:00+0000
                description:
                  type: string
                  description: Displays the milestone description.
                  example: Applicable for specific Stores
                type:
                  type: string
                  description: Displays the type of milestone - Action or Action Series.
                  example: Action
                typeDetail:
                  type: string
                  description: Displays the name of the Action or Action Series.
                  example: Purchase
                actionId:
                  type: integer
                  description: Displays the Action ID of the selected Action.
                  example: 109
                actionDescription:
                  type: string
                  description: Displays the description of the action.
                  example: 2x for all purchases made from the Segment listed stores.
                requiredCredit:
                  type: string
                  description: >-
                    Displays the points or count required to complete the Action
                    Series. It only appears when the milestone is based on
                    Action Series.
                  example: 3
                completedCredit:
                  type: string
                  description: >-
                    Displays the points or count completed by the member to
                    achieve the Action Series. It only appears when the
                    milestone is based on Action Series.
                  example: 1
                pendingCredit:
                  type: string
                  description: >-
                    Displays the points or count pending to complete the Action
                    Series. It only appears when the milestone is based on
                    Action Series.
                  example: 2
                benefitName:
                  type: string
                  description: Displays the name of the benefit as Bonus
                  example: Bonus
                benefitValue:
                  type: string
                  description: Displays the value of the milestone bonus.
                  example: 2
                benefitActiveImageUrl:
                  type: string
                  description: >-
                    Displays the URL assigned to the benefit if the member has
                    completed the milestone.
                  example: https://summeroffer.com/image
                benefitInactiveImageUrl:
                  type: string
                  description: >-
                    Displays the URL assigned to the benefit if the member has
                    not completed the milestone.
                  example: https://summeroffer.com/image
                benefitRedemptionDate:
                  type: string
                  description: >-
                    Displays the date the benefit was redeemed. For example,
                    spending bonus points or ordering a free item.
                  example: 2021-08-08T07:00:12+0000
                bonusPoints:
                  type: string
                  description: Displays the campaign points earned against the milestone.
                  example: 200
            campaignBenefit:
              type: object
              description: Displays any additional benefit set up for campaign
              properties:
                campaignBenefitType:
                  type: string
                  description: >-
                    Displays the type of campaign benefit. Campaign Bonus Points
                    or Reward.
                  example: Campaign Bonus Points
                campaignBenefitName:
                  type: string
                  description: Displays the name of the campaign benefit.
                  example: Even More Bonus Points
                campaignBenefitValue:
                  type: string
                  description: >-
                    Displays the value of the campaign benefit. In case of
                    bonus, it displays the Campaign Bonus points. In case of
                    Reward, it displays the associated Reward ID.
                  example: 100
                campaignBenefitCode:
                  type: string
                  description: >-
                    Displays the reward code associated with the campaign
                    benefit.
                  example: 654321
                campaignBenefitImageUrl:
                  type: string
                  description: Displays the URL of the campaign benefit image.
                  example: https://summeroffer.com/image
                campaignBenefitExpirationDate:
                  type: string
                  description: Displays the campaign benefit expiration date.
                  example: 2021-08-08T07:00:12+0000
                campaignBenefitStatus:
                  type: string
                  description: >-
                    Options for this field include - UNAVAILABLE- The campaign
                    benefit is set as Reward and there is no code available in
                    the associated Reward. AVAILABLE- The campaign benefit is
                    set as Bonus or Reward (code must exist in the reward) and
                    the member has not achieved the campaign milestone(s). That
                    is, the campaign is not yet completed. AWARDED- The member
                    has completed the campaign, and the campaign benefit as
                    bonus or reward is awarded to them. USED- The campaign
                    benefit is set as Reward and the awarded Reward has been
                    used by the member. EXPIRED- The campaign benefit is set as
                    Reward and the reward code expired without use.
                  example: MDN Web Docs
            individualValidity:
              type: object
              description: >-
                Displays array details only when the individualValidityEnabled =
                Yes.
              properties:
                individualValidityStartDate:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
                    individual validity started. If a user’s time zone is
                    specified, dates should be sent in that respective time
                    zone. If no time zone is set, dates should be sent in UTC.
                  example: 2024-07-11T15:32:00+0000
                individualValidityEndDate:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
                    individual validity ended. If a user’s time zone is
                    specified, dates should be sent in that respective time
                    zone. If no time zone is set, dates should be sent in UTC.
                  example: 2024-07-11T15:32:00+0000
        pages:
          type: integer
          description: Displays the total number of pages.
          example: 7
        currentPage:
          type: integer
          description: Displays the current page number
          example: 1
    postcampaignindividualvalidityresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the unique internal Site ID.
          example: '29235480'
        campaignId:
          type: integer
          description: Displays the unique internal Campaign ID.
          example: 179
        campaignName:
          type: string
          description: Displays the name of the campaign.
          example: Back to School Savings
        campaignDateFrom:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign becomes active.
          example: 2021-08-08T07:00:12+0000
        campaignDateTo:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign stops being active.
          example: 2021-08-08T07:00:12+0000
        campaignStatus:
          type: string
          description: >-
            Displays the status of the campaign. Active, Inactive, Upcoming or
            Expired.
          example: Active
        memberDetails:
          type: object
          description: Displays the details of the members.
          properties:
            userId:
              type: string
              description: Displays the unique internal member ID.
              example: user@domain.com
            individualValidityStartDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
                individual validity started.
              example: 2024-07-11T15:32:00+0000
            individualValidityEndDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
                individual validity ended.
              example: 2024-07-11T15:32:00+0000
        statusData:
          type: object
          description: Displays the details regarding the status of the campaigns.
          properties:
            total:
              type: integer
              description: Displays the total number of campaigns.
              example: 1
            success:
              type: integer
              description: >-
                Displays the number of campaigns that have been successfully
                completed.
              example: 1
            failed:
              type: integer
              description: Displays the number of campaigns that have not been completed.
              example: 0
    patchcampaignactivationresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique internal member ID.
          example: user@domain.com
        campaignId:
          type: integer
          description: Displays the unique internal campaign ID.
          example: 179
        campaignName:
          type: string
          description: Displays the name of the campaign.
          example: Back to School Savings
        campaignDateFrom:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign becomes active.
          example: 2024-07-10T15:32:00+0000
        campaignDateTo:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign stops being active.
          example: 2024-07-10T15:32:00+0000
        campaignStatus:
          type: string
          description: >-
            Displays the status of the campaign. Active, Inactive, Upcoming or
            Expired.
          example: Active
        activationRequired:
          type: string
          description: >-
            Displays the status as "Yes" if activation required is ON (enabled),
            or "No" if activation required is OFF (disabled). If "Activation
            Required" is enabled, members can achieve the campaign benefits only
            after activating the campaign through the Activation API.
          example: 'Yes'
        activated:
          type: string
          description: >-
            Displays the value as “Yes” if the member has activated the
            campaign  successfully.
          example: 'Yes'
        activatedOn:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign is activated by the member.
          example: 2024-07-10T15:32:00+0000
        individualValidityEnabled:
          type: string
          description: >-
            Displays the status as "Yes" if Apply Individual Validity is ON
            (enabled), or "No" if Apply Individual Validity is OFF (disabled).
            For campaigns with “Apply Individual Validity “ enabled, provide
            start and end dates for each member based on their user ID via
            individual validity API. Members can only earn benefits during their
            individual validity period.
          example: 'Yes'
        individualValidityStartDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
            individual validity started.
          example: 2024-07-11T15:32:00+0000
        individualValidityEndDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
            individual validity ended.
          example: 2024-07-11T15:32:00+0000
    postcampaignactivationresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique internal member ID.
          example: user@domain.com
        campaignId:
          type: integer
          description: Displays the unique internal Campaign ID.
          example: 179
        campaignName:
          type: string
          description: Displays the name of the campaign.
          example: Back to School Savings
        campaignDateFrom:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign becomes active.
          example: 2021-08-08T07:00:12+0000
        campaignDateTo:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign stops being active.
          example: 2021-08-08T07:00:12+0000
        campaignStatus:
          type: string
          description: >-
            Displays the status of the campaign. Active, Inactive, Upcoming or
            Expired.
          example: Active
        activationRequired:
          type: string
          description: >-
            Displays the status as "Yes" if activation required is ON (enabled),
            or "No" if activation required is OFF (disabled). If "Activation
            Required" is enabled, members can achieve the campaign benefits only
            after activating the campaign through the Activation API.
          example: 'Yes'
        activated:
          type: string
          description: >-
            Displays the value as “Yes” if the member has activated the
            campaign  successfully.
          example: 'Yes'
        activatedOn:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign is activated by the member.
          example: 2024-07-10T15:32:00+0000
        individualValidityEnabled:
          type: string
          description: >-
            Displays the status as "Yes" if Apply Individual Validity is ON
            (enabled), or "No" if Apply Individual Validity is OFF (disabled).
            For campaigns with “Apply Individual Validity “ enabled, provide
            start and end dates for each member based on their user ID via
            individual validity API. Members can only earn benefits during their
            individual validity period.
          example: 'Yes'
        individualValidityStartDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
            individual validity started.
          example: 2024-07-11T15:32:00+0000
        individualValidityEndDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format when the
            individual validity ended.
          example: 2024-07-11T15:32:00+0000
    getcampaigngroupstatusresp:
      type: object
      properties:
        allCampaignDetails:
          type: object
          properties:
            siteId:
              type: string
              description: Displays the unique internal Site ID.
              example: '29235480'
            campaignGroupId:
              type: integer
              description: Displays the campaign group ID.
              example: 3
            campaignGroupName:
              type: string
              description: Display the name of the campaign group.
              example: Group A
            status:
              type: string
              description: Displays the campaign group status.
              example: Active
            rule:
              type: string
              description: Displays the selected precedence rule.
              example: All eligible campaigns should be applied.
            campaignDetails:
              type: object
              description: >-
                Displays the details of all campaigns linked to the campaign
                group.
              properties:
                campaignId:
                  type: integer
                  description: Displays the unique internal campaign ID.
                  example: 4700
                campaignName:
                  type: string
                  description: Displays the name of the campaign.
                  example: Campaign A
                campaignSequenceNumber:
                  type: integer
                  description: >-
                    Displays the campaign sequence number in case the
                    sequence-based precedence rules were selected.
                  example: 1
                campaignDateFrom:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign becomes active.
                  example: 2024-08-08T07:00:12+0000
                campaignDateTo:
                  type: string
                  description: >-
                    Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which
                    the campaign stops being active.
                  example: 2024-08-08T07:00:12+0000
                campaignStatus:
                  type: string
                  description: Displays the status of the campaign.
                  example: Active
            campaignGroupCreateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign group was created.
              example: 2024-08-08T07:00:12+0000
            campaignGroupUpdateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign group was last updated.
              example: 2024-08-08T07:00:12+0000
        pages:
          type: integer
          description: Displays the total number of pages for the campaign group response.
          example: 7
        currentPage:
          type: integer
          description: >-
            Displays the current page number on which the campaign group
            information is displayed.
          example: 7
    getcampaigngroupcampaigngroupidresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the unique internal Site ID.
          example: '29235480'
        campaignGroupId:
          type: integer
          description: Displays the campaign group ID.
          example: 123
        campaignGroupName:
          type: string
          description: Display the name of the campaign group.
          example: Group B
        status:
          type: string
          description: Displays the campaign group status.
          example: Active
        rule:
          type: string
          description: Displays the selected precedence rule..
          example: All eligible campaigns should be applied.
        campaignDetails:
          type: object
          description: Displays the details of all campaigns linked to the campaign group.
          properties:
            campaignId:
              type: integer
              description: Displays the unique internal campaign ID.
              example: 4700
            campaignName:
              type: string
              description: Displays the name of the campaign.
              example: Campaign A
            campaignSequenceNumber:
              type: integer
              description: >-
                Displays the campaign sequence number in case the sequence-based
                precedence rules were selected.
              example: 1
            campaignDateFrom:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign becomes active.
              example: 2020-03-25T15:32:00+0000
            campaignDateTo:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign stops being active.
              example: 2020-03-25T15:32:00+0000
            campaignStatus:
              type: string
              description: Displays the status of the campaign.
              example: Active
            campaignCreateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign was created.
              example: 2020-03-25T15:32:00+0000
            campaignUpdateDate:
              type: string
              description: >-
                Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
                campaign was created.
              example: 2020-03-25T15:32:00+0000
        campaignGroupCreateDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign group was created.
          example: 2024-08-08T07:00:12+0000
        campaignGroupUpdateDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd'T'HH:mm:ssZ format on which the
            campaign group was last updated.
          example: 2024-08-08T07:00:12+0000
    postMergeUserResp:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following details-
          properties:
            siteID:
              type: string
              description: Displays the Annex Cloud site ID for the loyalty program.
              example: '29235480'
            primaryUID:
              type: string
              description: >-
                Displays the primary member ID. The primary member survives post
                merge.
              example: User1@domain.com
            secondaryUID:
              type: string
              description: >-
                Displays the secondary member user ID. The data of secondary
                member is deleted post merge as all the information is added to
                primary member.
              example: User2@domain.com
            id:
              type: string
              description: >-
                Displays the updated primary member ID. All the information of
                the secondary member is merged with the updated primary member.
              example: User3@domain.com
            mergedBy:
              type: string
              description: >-
                Displays the email address of the individual who initiated the
                merge.
              example: User4@domain.com
            reason:
              type: string
              description: >-
                Displays the reason for which the individual wanted to perform
                the merge operation.
              example: Duplicate records
            mergeDate:
              type: string
              description: Displays the date the merge occured.
              example: '2022-11-30'
            userDetail:
              type: object
              description: Displays the following details of the loyalty member-
              properties:
                firstName:
                  type: string
                  description: Displays the first name of the loyalty member.
                  example: John
                lastName:
                  type: string
                  description: Displays the last name of the loyalty member.
                  example: Deo
                zipCode:
                  type: integer
                  description: Displays the zip code of the loyalty member's residence.
                  example: 51750
                optInStatus:
                  type: string
                  description: >-
                    Displays the opt-in status as YES for opt-in or NO for
                    opt-out. The default opt-in status is YES.
                  example: 'YES'
                status:
                  type: string
                  description: >-
                    Displays the loyalty member’s status as active or inactive.
                    By default, it is active and can be changed to inactive as
                    per the client’s request.
                  example: ACTIVE
                phone:
                  type: integer
                  description: Displays the phone number of the loyalty member.
                  example: 8975498777
                birthDate:
                  type: string
                  description: >-
                    Displays the date of birth of the loyalty member in
                    yyyy-MM-dd format.
                  example: '1989-12-11'
                anniversaryDate:
                  type: string
                  description: >-
                    Displays the loyalty member's anniversary date, which can be
                    their birthdate, the date they joined the loyalty program or
                    marriage date in yyyy-MM-dd format.
                  example: '2023-12-11'
                createDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member was created in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2024-08-08T07:00:12+0000
                updateDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member’s information
                    was updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2024-08-08T07:00:12+0000
                source:
                  type: string
                  description: >-
                    Displays the source of the loyalty member's profile
                    creation, whether it was from a website, application, or
                    in-store.
                  example: website
                optInDate:
                  type: string
                  description: >-
                    Displays the earliest opt-in date out of the two member
                    accounts in yyyy-MM-dd'T'HH:mm:ssZ format. For example, if
                    the primary and secondary members opted for the loyalty
                    program on 2020-04-02 and 2020-05-02, respectively,
                    post-merge, the earliest opt-in date would be selected, that
                    is, 2020-04-02.
                  example: 2024-08-08T07:00:12+0000
                totalSpendCurrency:
                  type: integer
                  description: Displays the total currency spent by the loyalty member.
                  example: 134
                lastPurchaseDate:
                  type: string
                  description: Displays the date when the member last made a purchase.
                  example: '2024-11-15'
                lastActivityDate:
                  type: string
                  description: >-
                    Displays the date when the member last engaged in an
                    activity.
                  example: '2024-11-15'
                hierarchyData:
                  type: object
                  description: >-
                    Displays the following information about the group with
                    which the member is associated.
                  properties:
                    groupId:
                      type: string
                      description: >-
                        Displays the ID of the group that the loyalty member
                        belongs to.
                      example: '91'
                    addedOn:
                      type: string
                      description: >-
                        Displays the date on which the loyalty member was added
                        to the group in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2020-10-12T00:00:00+0000
                    groupAvailablePoints:
                      type: string
                      description: >-
                        Displays the total available points for the group. It is
                        the cumulative points of the group members.
                      example: '500'
                raf:
                  type: object
                  description: Displays the details regarding RAF.(If applicable)
            pointsDetail:
              type: object
              description: Displays the following details-
              properties:
                availablePoints:
                  type: integer
                  description: >-
                    Displays the available points in the loyalty member’s
                    account.
                  example: 10
                usedPoints:
                  type: integer
                  description: Displays the points used by the loyalty member.
                  example: 0
                expiredPoints:
                  type: integer
                  description: Displays the points which have expired.
                  example: 0
                lifetimePoints:
                  type: integer
                  description: Displays the lifetime points earned by the loyalty member.
                  example: 10
                holdPoints:
                  type: integer
                  description: Displays the points on hold.
                  example: 0
                pointsToExpire:
                  type: integer
                  description: Displays the points which are about to expire.
                  example: 10
                pointsToNextTier:
                  type: integer
                  description: >-
                    Displays the number of points required to achieve the next
                    tier. This depends on the point threshold required to reach
                    the next tier and the number of points the member currently
                    has in their account.
                  example: 50
                spendToNextTier:
                  type: integer
                  description: >-
                    Displays the amount the member must spend to achieve the
                    next tier. This is only applicable to tiers where the metric
                    is spend-based. If the tier metric is points-based or based
                    on extended attributes, it will not show any additional
                    values.
                  example: 200
                pointsToExpireDate:
                  type: string
                  description: Displays the next immediate expiration date of the points.
                  example: '2023-06-30 23:59:59'
                totalSpent:
                  type: integer
                  description: Displays the total amount spent by the loyalty member.
                  example: 50
                availableRedemptionPoints:
                  type: integer
                  description: >-
                    Displays the available points which can be redeemed by the
                    loyalty member.
                  example: 40
                usedRedemptionPoints:
                  type: integer
                  description: Displays the used redemption points by the loyalty member.
                  example: 60
                groupDetails:
                  type: object
                  description: >-
                    Displays the following information about the group with
                    which the member is associated.
                  properties:
                    groupId:
                      type: string
                      description: >-
                        Displays the unique group ID generated during group
                        creation.
                      example: '91'
                    groupName:
                      type: string
                      description: >-
                        Displays the name of the group to which the member
                        belongs.
                      example: Loyalty Circle
                    groupAvailablePoints:
                      type: string
                      description: >-
                        Displays the total available points for the group. It is
                        the cumulative points of the group members.
                      example: '500'
                    groupLifetimePoints:
                      type: string
                      description: >-
                        Displays the total number of group points accumulated
                        throughout its time in the loyalty program.
                      example: '100'
                    groupUsedPoints:
                      type: string
                      description: >-
                        Displays the number of points used from the group
                        account.
                      example: '200'
                    groupExpiredPoints:
                      type: string
                      description: >-
                        Displays the number of expired points from the group
                        account.
                      example: '0'
    getMergeUserResp:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following details-
          properties:
            siteID:
              type: string
              description: Displays the Annex Cloud site ID for the loyalty program.
              example: '29235480'
            id:
              type: string
              description: Displays the updated primary member ID.
              example: User3@domain.com
            userDetail:
              type: object
              description: Displays the following details of the loyalty member-
              properties:
                primaryUID:
                  type: string
                  description: >-
                    Displays the primary member ID. The primary member survives
                    post merge.
                  example: User1@domain.com
                secondaryUID:
                  type: string
                  description: >-
                    Displays the secondary member user ID. The data of secondary
                    member is deleted post merge as all the information is added
                    to primary member.
                  example: User2@domain.com
                mergedBy:
                  type: string
                  description: >-
                    Displays the email address of the individual who initiated
                    the merge.
                  example: User4@domain.com
                mergeDate:
                  type: string
                  description: Displays the date the merge occured.
                  example: '2022-11-30'
                updateDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member’s information
                    was updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2024-08-08T07:00:12+0000
                pages:
                  type: integer
                  description: >-
                    Displays the total number of pages on which the loyalty
                    member's information is displayed.
                  example: 15
                currentPage:
                  type: integer
                  description: >-
                    Displays the current page number on which the loyalty
                    member's information is displayed.
                  example: 1
                userDetailCount:
                  type: integer
                  description: >-
                    Displays the total number of times the primary member has
                    gone through the merge process.
                  example: 1
    getuseridactivitysummaryactionidresp:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            actionId:
              type: integer
              description: >-
                Displays the unique action ID used during the debit or credit
                activity.
              example: 109
            sumOfCredit:
              type: integer
              description: Displays the total number of points credited due to the action.
              example: 20
            sumOfDebit:
              type: integer
              description: Displays the total number of points debited due to the action.
              example: 50
    postbulkpostusersresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud site ID for the loyalty program.
          example: 146032020
        id:
          type: string
          description: Displays the unique ID of the loyalty member.
          example: advinsap24
        email:
          type: string
          description: Displays the email address of the loyalty member.
          example: advinsap24@gmail.com
        firstName:
          type: string
          description: Displays the first name of the loyalty member.
          example: Advin
        lastName:
          type: string
          description: Displays the last name of the loyalty member.
          example: Roy
        optInStatus:
          type: string
          description: >-
            Displays the opt-in status as YES for opt-in or NO for opt-out. The
            default opt-in status is YES.
          example: 'YES'
        status:
          type: string
          description: >-
            If the activity-based membership status flag is OFF- Displays the
            loyalty member’s status as active or inactive. By default, the
            status is active and can be changed to inactive as per the client’s
            request. If the activity-based membership status flag is ON-
            Displays the member status based on the defined activity-based
            criteria.
          example: ACTIVE
        phone:
          type: integer
          description: Displays the phone number of the loyalty member.
          example: 4532678800
        birthDate:
          type: string
          description: >-
            Displays the date of birth of the loyalty member in
            yyyy-MM-dd’T’HH:mm:ssZ format.
          example: '2001-11-04T00:00:00-07:00'
        anniversaryDate:
          type: string
          description: >-
            Displays the loyalty member's anniversary date, which can be the
            date they joined the loyalty program or marriage date in
            yyyy-MM-dd’T’HH:mm:ssZ format.
          example: '2021-11-04T00:00:00-07:00'
        createDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the loyalty member profile was created.
          example: 2024-04-25T04:17:39+0000
        updateDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the loyalty member was updated.
          example: 2024-04-25T04:17:39+0000
        extendedAttribute:
          type: object
          description: >-
            Displays the member attributes defined in your program
            configuration. This can be customized according to requirements. It
            accepts multiple parameters; however, these parameters must be
            defined under Products > Additional Loyalty Settings > Extended
            Attributes. Note - The extended attributes listed below are examples
            only. All extended attributes must be configured for the program as
            stated above.
          properties:
            userType:
              description: >-
                Displays the employment status of the member as employed,
                unemployed, or student.
              example: Employed
              type: string
            userStatus:
              description: >-
                Displays the unique referrer code provided by the Refer-a-Friend
                program (if applicable), when creating a loyalty member profile.
              example: Enabled
              type: string
    postbulkpatchusersresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud site ID for the loyalty program.
          example: 146032020
        id:
          type: string
          description: Displays the unique ID of the loyalty member.
          example: advinsap24
        email:
          type: string
          description: Displays the email address of the loyalty member.
          example: advinsap24@gmail.com
        firstName:
          type: string
          description: Displays the first name of the loyalty member.
          example: Advin
        lastName:
          type: string
          description: Displays the last name of the loyalty member.
          example: Roy
        optInStatus:
          type: string
          description: >-
            Displays the opt-in status as YES for opt-in or NO for opt-out. The
            default opt-in status is YES.
          example: 'YES'
        status:
          type: string
          description: >-
            If the activity-based membership status flag is OFF- Displays the
            loyalty member’s status as active or inactive. By default, the
            status is active and can be changed to inactive as per the client’s
            request. If the activity-based membership status flag is ON-
            Displays the member status based on the defined activity-based
            criteria.
          example: ACTIVE
        phone:
          type: integer
          description: Displays the phone number of the loyalty member.
          example: 4532678800
        birthDate:
          type: string
          description: >-
            Displays the date of birth of the loyalty member in
            yyyy-MM-dd’T’HH:mm:ssZ format.
          example: '2001-11-04T00:00:00-07:00'
        anniversaryDate:
          type: string
          description: >-
            Displays the loyalty member's anniversary date, which can be their
            birthdate, the date they joined the loyalty program or marriage
            date, in yyyy-MM-dd’T’HH:mm:ssZ format.
          example: '2021-11-04T00:00:00-07:00'
        createDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the loyalty member profile was created.
          example: 2024-04-25T04:17:39+0000
        updateDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the loyalty member was updated.
          example: 2024-04-25T04:17:39+0000
        extendedAttribute:
          type: object
          description: >-
            Displays the member attributes defined in your program
            configuration. This can be customized according to requirements. It
            accepts multiple parameters; however, these parameters must be
            defined under Products > Additional Loyalty Settings > Extended
            Attributes. Note - The extended attributes listed below are examples
            only. All extended attributes must be configured for the program as
            stated above.
          properties:
            userType:
              description: >-
                Displays the employment status of the member as employed,
                unemployed, or student.
              example: Employed
              type: string
            userStatus:
              description: >-
                Displays the unique referrer code provided by the Refer-a-Friend
                program (if applicable), when creating a loyalty member profile.
              example: Enabled
              type: string
    getTransactionErasureResp:
      type: object
      properties:
        transactiondetails:
          type: object
          description: Displays the following parameters-
          properties:
            userId:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: user@domain.com
            siteId:
              type: string
              description: Displays the Annex Cloud site ID for the loyalty program.
              example: '29235480'
            data:
              type: object
              description: Displays the following details-
              properties:
                orderId:
                  type: string
                  description: >-
                    Displays the unique order ID for the order placed by the
                    loyalty member.
                  example: A2034354570
                orderDate:
                  type: string
                  description: >-
                    Displays the date the order was placed in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: '2022-03-01 00:00:00'
                eligibleForErasure:
                  type: string
                  description: Displays if the transaction is eligible for erasure or not.
                  example: 'Yes'
                pointsRequired:
                  type: integer
                  description: >-
                    Displays the number of points required for a transaction to
                    erase an eligible transaction.
                  example: 300
                previouslyErased:
                  type: integer
                  description: >-
                    Displays whether the transaction was previously erased or
                    not. In this particular instance, 0 implies previously not
                    erased and 1 means previously erased.
                  example: 0
                pointsRefunded:
                  type: integer
                  description: >-
                    Displays the points refunded to the loyalty member following
                    the reversal of transaction erasure or the cancellation of
                    an order. (In this scenario, the 100 points in the example
                    indicate that the points were utilized to complete
                    transaction erasure. The points are being reimbursed to the
                    member when the transaction erasure is reversed).
                  example: 100
                reversal:
                  type: string
                  description: >-
                    Displays the status of the transaction erasure. In this
                    case, 0 indicates that the transaction has not been
                    reversed, while 1 indicates that it has been reversed.
                  example: 0
            orderAttribute:
              type: object
              description: Displays the following details-
              properties:
                attribute_1:
                  type: string
                  description: >-
                    Displays a description of the attributes associated with an
                    order. The order attributes are completely configurable
                    based on the needs of the client.
                  example: Value1
                pages:
                  type: integer
                  description: >-
                    Displays the total number of pages that include information
                    on orders placed by a member.
                  example: 4
                currentPage:
                  type: integer
                  description: >-
                    Displays the current page number that contains the
                    information related to transaction being erased.
                  example: 1
                totalOrderCount:
                  type: integer
                  description: >-
                    Displays the total number of orders placed by the loyalty
                    member.
                  example: 18
    posttransactionerasureResp:
      type: object
      properties:
        transactiondetails:
          type: object
          description: Displays the following parameters-
          properties:
            orderId:
              type: string
              description: >-
                Displays the loyalty member's unique order ID for the order they
                placed.
              example: A2034354570
            erasureDate:
              type: string
              description: >-
                Displays the date of the transaction erasure in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            userId:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: user@domain.com
            pointsUsed:
              type: integer
              description: Displays the number of points used to erase the transaction.
              example: 100
            orderAttribute:
              type: object
              description: Displays the following details-
              properties:
                attribute_1:
                  type: string
                  description: >-
                    Displays a description of the attributes associated with the
                    order. The order attributes are completely configurable
                    based on the needs of the client.
                  example: Value1
    postsurveyresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveyThankyouMessage:
              type: string
              description: >-
                Displays the survey completion message set by the administrator.
                Note - The message only appears if the member has completed the
                survey and this is the last question of the survey.
              example: >-
                Thanks for your feedback. Your feedback is important for us to
                modify the products as per your requirement.
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyBenefit:
              type: object
              description: >-
                Displays the survey’s benefits received upon completing the
                survey. Note - The survey benefit is only displayed if the
                survey has been completed and this is the last question the
                member submitted.
              properties:
                points:
                  type: object
                  description: Displays the points awarded upon completing the survey.
                  properties:
                    pointsAwarded:
                      type: integer
                      description: >-
                        Displays the points awarded to members once they
                        complete the survey.
                      example: 10
                    reason:
                      type: string
                      description: Displays the reason for awarding points.
                      example: Survey Completed
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                sectionId:
                  type: integer
                  description: >-
                    Displays the unique ID for the section that was completed by
                    the member.
                  example: 654
                sectionName:
                  type: string
                  description: >-
                    Displays the section name as specified by the administrator.
                    (If the member just completes one section of the survey, the
                    name of the survey and the section are both displayed).
                  example: Customer Interest
                sectionGoToValue:
                  type: string
                  description: >-
                    Displays the next value to be executed upon completing the
                    section. It may be next section or end survey.
                  example: End Survey
                sectionBenefit:
                  type: object
                  description: >-
                    Displays the benefits awarded to members once they complete
                    the section. Note - This object is only displayed if the
                    section benefit is selected while creating the survey.
                  properties:
                    points:
                      type: object
                      description: Displays the points awarded upon completing the survey.
                      properties:
                        pointsAwarded:
                          type: integer
                          description: >-
                            Displays the points awarded to members once they
                            complete the survey.
                          example: 10
                        reason:
                          type: string
                          description: Displays the reason for awarding points.
                          example: Survey Completed
                sectionCreateDate:
                  type: string
                  description: >-
                    Displays the section creation date and time in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2023-01-13T05:59:13+0000
                sectionUpdateDate:
                  type: string
                  description: >-
                    Displays the date and time, the section was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2023-01-13T11:46:35+0000
                sectionThankyouMessage:
                  type: string
                  description: >-
                    Displays the thank you message once the section is
                    completed.
                  example: Thank you for completing the section.
                question:
                  type: object
                  description: >-
                    Displays the following information for the list of questions
                    within the section.
                  properties:
                    questionId:
                      type: integer
                      description: >-
                        Displays the unique question ID for which the member
                        submitted the response.
                      example: 155
                    questionName:
                      type: string
                      description: Displays the question being asked.
                      example: Where do you live?
                    questionType:
                      type: integer
                      description: >-
                        Displays the type of response this question accepts. 1-
                        checkbox 2-radiobutton 3-scale 4- textbox 5-text area
                        6-dropdown 7-upload an image.
                      example: 2
                    questionTypeName:
                      type: string
                      description: >-
                        Displays the name of the response type this question
                        accepts.
                      example: Radiobutton
                    questionImage:
                      type: string
                      description: >-
                        Displays the image url for the image associated with the
                        question.
                      example: https://surveyquestionimage.com
                    questionImageCaption:
                      type: string
                      description: Displays the question’s image caption.
                      example: Survey question
                    questionSequence:
                      type: integer
                      description: >-
                        Displays the number of the question within the sequence
                        of questions in the section. Multiple questions can be
                        configured in the section, and the sequence of the
                        questions is determined by the admin at the time of
                        configuration.
                      example: 1
                    questionGoToValue:
                      type: string
                      description: >-
                        Displays the next question to be executed when the
                        current question is completed. It may be the next
                        question or the end of this section.
                      example: NEXT QUESTION
                    questionGoToId:
                      type: integer
                      description: >-
                        Displays the next question ID to be executed by the
                        loyalty member.This helps the loyalty members to go to
                        that particular question directly.
                      example: 156
                    questionCreateDate:
                      type: string
                      description: >-
                        Displays the date and time when this question was
                        created in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T05:59:13+0000
                    questionUpdateDate:
                      type: string
                      description: >-
                        Displays the last date and time, the question was
                        updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T11:46:35+0000
                    questionAnsweredDate:
                      type: string
                      description: >-
                        Displays the date when an answer was provided for a
                        particular question.
                      example: 2023-01-13T11:46:35+0000
                    answer:
                      type: object
                      description: >-
                        Displays the following information for each answer
                        option configured for the question.
                      properties:
                        answerId:
                          type: integer
                          description: >-
                            Displays the unique ID of the answer that was
                            selected by the member while answering the question.
                          example: 155
                        answerOption | answerValue:
                          type: string
                          description: >-
                            Displays the answer option/answerValue for the
                            question. Note - when we are using Checkbox, Radio
                            Button, Dropdown, and Scale in the request body then
                            answerOption will be displayed but in case of
                            Textbox, Text Area, and Upload Image Type
                            answerValue will be displayed.
                          example: USA
                        answerResponseCount:
                          type: integer
                          description: >-
                            Displays the number of times the answer has been
                            selected by members who have answered the question
                            on the survey.
                          example: 0
                        answerResponsePercentage:
                          type: string
                          description: >-
                            Displays the percentage of members who selected this
                            answer to the question. Suppose we have the
                            following statistics- Option A was chosen by 5
                            members. Option B was chosen by 10 members. Option C
                            was chosen by 20 members. Option D was chosen by 15
                            members. Then the percentage of members who selected
                            Option A is (5/50)*100 = 10%.
                          example: 10%
                        answerImage:
                          type: string
                          description: >-
                            Displays the URL for the image associated with the
                            answer option (if applicable).
                          example: >-
                            https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                        answerIsTrue:
                          type: string
                          description: >-
                            Displays YES if this is the correct answer to the
                            question. Otherwise, NO will display.
                          example: 'No'
                        answerSubmittedDate:
                          type: string
                          description: >-
                            Displays the date and time when the answer response
                            was submitted.
                          example: 2023-01-13T11:46:35+0000
                    answerStat:
                      type: object
                      description: >-
                        Displays the following details and statistics for the
                        response options configured for the question.
                      properties:
                        answerId:
                          type: integer
                          description: >-
                            Displays the unique ID of the answer that was
                            selected by the member while answering the question.
                          example: 155
                        answerValue:
                          type: string
                          description: >-
                            Displays the required answer, that must appear
                            alongside the question. These responses alter
                            depending on the survey questions.
                          example: Extremely Well
                        answerResponseCount:
                          type: integer
                          description: >-
                            Displays the number of times the answer has been
                            selected by members who have answered the question
                            on the survey.
                          example: 0
                        answerResponsePercentage:
                          type: string
                          description: >-
                            Displays the percentage of members who selected this
                            answer to the question. Suppose we have the
                            following statistics- Option A was chosen by 5
                            members. Option B was chosen by 10 members. Option C
                            was chosen by 20 members. Option D was chosen by 15
                            members. Then the percentage of members who selected
                            Option A is (5/50)*100 = 10%.
                          example: 10%
                        answerImage:
                          type: string
                          description: >-
                            Displays the URL for the image associated with the
                            answer option (if applicable).
                          example: >-
                            https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                        answerIsTrue:
                          type: string
                          description: >-
                            Displays YES if this is the correct answer to the
                            question. Otherwise, NO will display.
                          example: 'No'
    getsurveyallresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: >-
                Displays the unique survey ID that is auto generated on creation
                of a new survey on the site.This identifier helps in tracking
                and organizing survey responses, ensuring that each response is
                linked to the correct survey.
              example: 63
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration. This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-12-31T11:59:59+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site.A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members. This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyCriteria:
              type: object
              description: >-
                Displays the following information on the eligibility criteria
                established for the survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the eligibility rules established for the
                    survey.Rule types include Survey and Segment and are
                    established as part of the survey configuration.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey listed as an eligibility rule.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that is listed
                            as part of the eligibility criteria for the current
                            survey.
                          example: 123d
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey that is listed as
                            part of the eligibility criteria for the current
                            survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with survey eligibility.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: >-
                            Displays the name of the segment members must belong
                            to in order to access the current survey.
                          example: Survey Segment
            pages:
              type: integer
              description: Displays the total number of pages containing surveys.
              example: 5
            limit:
              type: integer
              description: >-
                Displays the maximum number of surveys on a page.If it is set to
                10, only 10 surveys are displayed per page.
              example: 10
            totalSurveyCount:
              type: integer
              description: Displays the total number of surveys configured for the site.
              example: 15
            current_page:
              type: integer
              description: >-
                Displays the current page number, that contains information
                related to the survey.
              example: 1
    getsurveysurveyidresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: >-
                Displays the unique survey ID that is auto generated on creation
                of a new survey on the site.This identifier helps in tracking
                and organizing survey responses, ensuring that each response is
                linked to the correct survey.
              example: 63
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-12-31T11:59:59+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyCriteria:
              type: object
              description: >-
                Displays the following information on the eligibility criteria
                established for the survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the eligibility rules established for the
                    survey.Rule types include Survey and Segment and are
                    established as part of the survey configuration.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey listed as an eligibility rule.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that is listed
                            as part of the eligibility criteria for the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey that is listed as
                            part of the eligibility criteria for the current
                            survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with survey eligibility.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: >-
                            Displays the name of the segment members must belong
                            to in order to access the current survey.
                          example: Survey Segment
    getsurveyalluseremailidresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-12-31T11:59:59+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            surveyCriteria:
              type: object
              description: >-
                Displays the following information required to complete the
                survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the terms and conditions (rules, restrictions)
                    required to qualify for the survey. Only members who have
                    completed the survey, qualify for the segment, or both are
                    eligible to take the survey.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that must be
                            completed by the member to access the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey members must
                            complete to access the current survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with the survey.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: Displays the name of the segment.
                          example: Survey Segment
            pages:
              type: integer
              description: Displays the total number of pages containing surveys.
              example: 5
            limit:
              type: integer
              description: >-
                Displays the maximum number of surveys on a page.If it is set to
                10, only 10 surveys are displayed per page.
              example: 10
            totalSurveyCount:
              type: integer
              description: Displays the total number of surveys configured for the site.
              example: 15
            current_page:
              type: integer
              description: >-
                Displays the current page number, that contains information
                related to the survey.
              example: 1
    getsurveysurveyiduseremailidresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            surveyCriteria:
              type: object
              description: >-
                Displays the following information required to complete the
                survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the terms and conditions (rules, restrictions)
                    required to qualify for the survey. Only members who have
                    completed the survey, qualify for the segment, or both are
                    eligible to take the survey.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that must be
                            completed by the member to access the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey members must
                            complete to access the current survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with the survey.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: Displays the name of the segment.
                          example: Survey Segment
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                sectionId:
                  type: integer
                  description: >-
                    Displays the unique section ID. (A survey includes multiple
                    questions for loyalty members to answer, and the questions
                    are split into various sections to help them comprehend the
                    context of the survey).
                  example: 654
                sectionName:
                  type: string
                  description: >-
                    Displays the section name as specified by the administrator.
                    (If the member just completes one section of the survey, the
                    name of the survey and the section are both displayed).
                  example: Customer Interest
                sectionSequence:
                  type: integer
                  description: >-
                    Displays the number of the section within the sequence of
                    sections in the survey.Multiple sections can be configured
                    in the survey, and the sequence of the sections are
                    determined by the admin at the time the survey is
                    configured.
                  example: 4
                sectionSubmissionType:
                  type: string
                  description: >-
                    Displays the section submission type as single or
                    multiple.In single submission, only one question is
                    displayed per page for answering while in multiple
                    submissions, all questions are displayed on a single page.
                  example: Multiple Submission
                sectionSubmissionTypeValue:
                  type: integer
                  description: >-
                    Displays the value as 0 or 1.“0” indicates a single
                    submission and “1” indicates multiple submissions.
                  example: 0
                questionCount:
                  type: integer
                  description: Displays the number of questions within the section.
                  example: 7
                sectionBenefitType:
                  type: string
                  description: >-
                    Displays the section benefits type as points or reward
                    coupon. A section benefit is provided to members who
                    successfully complete the survey’s section.
                  example: Points
                sectionBenefitsValue:
                  type: string
                  description: >-
                    Displays the points or coupons which members receive upon
                    completion of the section. If the benefit type is points,
                    members will receive a defined number of points. If the
                    benefit type is reward coupon, members will receive a coupon
                    code.
                  example: 100
                sectionBenefitsExpirationType:
                  type: string
                  description: >-
                    Displays the benefit expiration type as rolling or calendar.
                    Rolling- The section benefits expire within a set number of
                    days from when the section is completed. Calendar- The
                    section benefits expire based on a calendar time frame, such
                    as weeks, months, or years.
                  example: Rolling
                sectionBenefitsExpiration:
                  type: string
                  description: >-
                    Displays the time after which the benefits expire. The
                    benefit expiration can be either a rolling or calendar. If
                    the expiration type is rolling, the period displayed will be
                    in number of days. If the expiration type is calendar, the
                    period displayed will be in weeks, months, quarters, or
                    years.
                  example: 10 Days
                enablePreview:
                  type: string
                  description: >-
                    Displays YES if the preview functionality is enabled and NO
                    if it is disabled.This is a draft review for internal use.
                    It allows admin to catch and correct any errors before
                    sharing the information with external parties.
                  example: 'No'
                sectionGoToValue:
                  type: string
                  description: >-
                    Displays the next value to be executed upon completing the
                    section. It may be next section or end survey.
                  example: End Survey
                sectionGoToId:
                  type: integer
                  description: >-
                    Displays the section ID for the next section members will be
                    directed to upon completion of the current section. If
                    members are taken to the end of the survey upon completion
                    of the section, there will be no data included in this
                    field.
                  example: 18
                sectionGoToName:
                  type: string
                  description: Displays the name of the subsequent section.
                  example: Loyalty Services
                sectionCreateDate:
                  type: string
                  description: >-
                    Displays the section creation date and time in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2023-01-13T05:59:13+0000
                sectionUpdateDate:
                  type: string
                  description: >-
                    Displays the date and time, the section was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2023-01-13T11:46:35+0000
                question:
                  type: object
                  description: >-
                    Displays the following information for the list of questions
                    within the section.
                  properties:
                    questionId:
                      type: integer
                      description: Displays the unique question ID.
                      example: 155
                    questionName:
                      type: string
                      description: Displays the question being asked.
                      example: What is your age?
                    questionType:
                      type: integer
                      description: >-
                        Displays the type of response this question accepts. 1-
                        checkbox 2-radiobutton 3-scale 4- textbox 5-text area
                        6-dropdown 7-upload an image.
                      example: 2
                    questionTypeName:
                      type: string
                      description: >-
                        Displays the name of the response type this question
                        accepts.
                      example: Radiobutton
                    questionImage:
                      type: string
                      description: >-
                        Displays the image url for the image associated with the
                        question.
                      example: https://surveyquestionimage.com
                    questionImageCaption:
                      type: string
                      description: Displays the question’s image caption.
                      example: Survey question
                    questionSequence:
                      type: integer
                      description: >-
                        Displays the number of the question within the sequence
                        of questions in the section. Multiple questions can be
                        configured in the section, and the sequence of the
                        questions is determined by the admin at the time of
                        configuration.
                      example: 1
                    questionMinOption:
                      type: integer
                      description: >-
                        Displays the minimum number of answers that can be
                        submitted in response to the question. This is only
                        relevant for Checkbox response questions where members
                        have the option to select and submit multiple answers to
                        the question.
                      example: 1
                    questionMaxOption:
                      type: integer
                      description: >-
                        Displays the maximum number of answers that can be
                        submitted in response to the question. This is only
                        relevant for Checkbox response questions where members
                        have the option to select and submit multiple answers to
                        the question.
                      example: 3
                    isRequired:
                      type: string
                      description: >-
                        Displays YES if the question is mandatory and NO if it
                        is optional.
                      example: 'YES'
                    enableShuffle:
                      type: string
                      description: >-
                        Displays YES if shuffle is enabled and NO if it is
                        disabled. If shuffle is enabled, the response options
                        for the question will shuffle in order when presented to
                        members. If it is not enabled the response options will
                        remain in the order set at the time the question was
                        configured.
                      example: 'NO'
                    questionCreateDate:
                      type: string
                      description: >-
                        Displays the date and time when this question was
                        created in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T05:59:13+0000
                    questionUpdateDate:
                      type: string
                      description: >-
                        Displays the last date and time, the question was
                        updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T11:46:35+0000
                    answer:
                      type: object
                      description: >-
                        Displays the following information for each answer
                        option configured for the question.
                      properties:
                        answerId:
                          type: integer
                          description: >-
                            Displays the unique answer ID which is
                            auto-generated at the time of creating an answer.
                          example: 155
                        answerOption:
                          type: string
                          description: Displays the answer option for the question.
                          example: USA
                        answerImage:
                          type: string
                          description: >-
                            Displays the URL for the image associated with the
                            answer option (if applicable).
                          example: >-
                            https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                        answerImageCaption:
                          type: string
                          description: >-
                            Displays the caption for the image associated with
                            the answer option (if applicable).
                          example: Question’s answer
                        answerSequence:
                          type: integer
                          description: >-
                            Displays the number of the answer option within the
                            sequence of possible answers listed for the
                            question.Multiple answer options can be configured
                            for one question. The sequence of possible answers
                            is determined by the administrator when configuring
                            the question. Please note that the sequence will
                            change if Shuffle is enabled.
                          example: 1
                        answerIsTrue:
                          type: string
                          description: >-
                            Displays YES if this is the correct answer to the
                            question. Otherwise, NO will display.
                          example: 'No'
                        answerOtherOption:
                          type: string
                          description: >-
                            Displays YES if this is the ‘Other’ answer option
                            and NO if this is not. When questions are configured
                            for a survey, administrators have the ability to
                            include an ‘Other’ response option where members can
                            enter their own unique response to the question.
                          example: 'No'
                        answerGoToValue:
                          type: string
                          description: >-
                            Displays ‘Question’ or ‘End Section’ to indicate if
                            the member is directed to another question or the
                            end of the section upon answering this question.
                          example: Next Question
                        answerGoToQuestionId:
                          type: integer
                          description: >-
                            Displays the question ID for the next question
                            members will be directed to upon answering the
                            current question (if applicable).
                          example: 156
                        answerGoToQuestionName:
                          type: string
                          description: >-
                            Displays the next question members will be asked
                            upon answering the current question (if applicable).
                          example: What is your favorite vacation place?
                        answerResponseCount:
                          type: integer
                          description: >-
                            Displays the number of times the answer has been
                            selected by members who have answered the question
                            on the survey.
                          example: 0
                        answerResponsePercentage:
                          type: string
                          description: >-
                            Displays the percentage of members who selected this
                            answer to the question. Suppose we have the
                            following statistics- Option A was chosen by 5
                            members. Option B was chosen by 10 members. Option C
                            was chosen by 20 members. Option D was chosen by 15
                            members. Then the percentage of members who selected
                            Option A is (5/50)*100 = 10%.
                          example: 10%
                        answerCreateDate:
                          type: string
                          description: >-
                            Displays the date and time when this qanswer was
                            created in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T05:59:13+0000
                        answerUpdateDate:
                          type: string
                          description: >-
                            Displays the last date and time, the answer was
                            updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T11:46:35+0000
    getsurveysurveyiduseremailidsectionallresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            surveyCriteria:
              type: object
              description: >-
                Displays the following information required to complete the
                survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the terms and conditions (rules, restrictions)
                    required to qualify for the survey. Only members who have
                    completed the survey, qualify for the segment, or both are
                    eligible to take the survey.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that must be
                            completed by the member to access the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey members must
                            complete to access the current survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with the survey.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: Displays the name of the segment.
                          example: Survey Segment
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                sectionId:
                  type: integer
                  description: >-
                    Displays the unique section ID. (A survey includes multiple
                    questions for loyalty members to answer, and the questions
                    are split into various sections to help them comprehend the
                    context of the survey).
                  example: 654
                sectionName:
                  type: string
                  description: >-
                    Displays the section name as specified by the administrator.
                    (If the member just completes one section of the survey, the
                    name of the survey and the section are both displayed).
                  example: Customer Interest
                sectionSequence:
                  type: integer
                  description: >-
                    Displays the number of the section within the sequence of
                    sections in the survey.Multiple sections can be configured
                    in the survey, and the sequence of the sections are
                    determined by the admin at the time the survey is
                    configured.
                  example: 4
                sectionSubmissionType:
                  type: string
                  description: >-
                    Displays the section submission type as single or
                    multiple.In single submission, only one question is
                    displayed per page for answering while in multiple
                    submissions, all questions are displayed on a single page.
                  example: Multiple Submission
                sectionSubmissionTypeValue:
                  type: integer
                  description: >-
                    Displays the value as 0 or 1.“0” indicates a single
                    submission and “1” indicates multiple submissions.
                  example: 0
                questionCount:
                  type: integer
                  description: Displays the number of questions within the section.
                  example: 7
                sectionBenefitType:
                  type: string
                  description: >-
                    Displays the section benefits type as points or reward
                    coupon. A section benefit is provided to members who
                    successfully complete the survey’s section.
                  example: Points
                sectionBenefitsValue:
                  type: string
                  description: >-
                    Displays the points or coupons which members receive upon
                    completion of the section. If the benefit type is points,
                    members will receive a defined number of points. If the
                    benefit type is reward coupon, members will receive a coupon
                    code.
                  example: 100
                sectionBenefitsExpirationType:
                  type: string
                  description: >-
                    Displays the benefit expiration type as rolling or calendar.
                    Rolling- The section benefits expire within a set number of
                    days from when the section is completed. Calendar- The
                    section benefits expire based on a calendar time frame, such
                    as weeks, months, or years.
                  example: Rolling
                sectionBenefitsExpiration:
                  type: string
                  description: >-
                    Displays the time after which the benefits expire. The
                    benefit expiration can be either a rolling or calendar. If
                    the expiration type is rolling, the period displayed will be
                    in number of days. If the expiration type is calendar, the
                    period displayed will be in weeks, months, quarters, or
                    years.
                  example: 10 Days
                enablePreview:
                  type: string
                  description: >-
                    Displays YES if the preview functionality is enabled and NO
                    if it is disabled.This is a draft review for internal use.
                    It allows admin to catch and correct any errors before
                    sharing the information with external parties.
                  example: 'No'
                sectionGoToValue:
                  type: string
                  description: >-
                    Displays the next value to be executed upon completing the
                    section. It may be next section or end survey.
                  example: End Survey
                sectionGoToId:
                  type: integer
                  description: >-
                    Displays the section ID for the next section members will be
                    directed to upon completion of the current section. If
                    members are taken to the end of the survey upon completion
                    of the section, there will be no data included in this
                    field.
                  example: 18
                sectionGoToName:
                  type: string
                  description: Displays the name of the subsequent section.
                  example: Loyalty Services
                sectionCreateDate:
                  type: string
                  description: >-
                    Displays the section creation date and time in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2023-01-13T05:59:13+0000
                sectionUpdateDate:
                  type: string
                  description: >-
                    Displays the date and time, the section was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2023-01-13T11:46:35+0000
    getsurveysurveyiduseremailidsectionsectionidresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            surveyCriteria:
              type: object
              description: >-
                Displays the following information required to complete the
                survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the terms and conditions (rules, restrictions)
                    required to qualify for the survey. Only members who have
                    completed the survey, qualify for the segment, or both are
                    eligible to take the survey.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that must be
                            completed by the member to access the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey members must
                            complete to access the current survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with the survey.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: Displays the name of the segment.
                          example: Survey Segment
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                sectionId:
                  type: integer
                  description: >-
                    Displays the unique section ID. (A survey includes multiple
                    questions for loyalty members to answer, and the questions
                    are split into various sections to help them comprehend the
                    context of the survey).
                  example: 654
                sectionName:
                  type: string
                  description: >-
                    Displays the section name as specified by the administrator.
                    (If the member just completes one section of the survey, the
                    name of the survey and the section are both displayed).
                  example: Customer Interest
                sectionSequence:
                  type: integer
                  description: >-
                    Displays the number of the section within the sequence of
                    sections in the survey.Multiple sections can be configured
                    in the survey, and the sequence of the sections are
                    determined by the admin at the time the survey is
                    configured.
                  example: 4
                sectionSubmissionType:
                  type: string
                  description: >-
                    Displays the section submission type as single or
                    multiple.In single submission, only one question is
                    displayed per page for answering while in multiple
                    submissions, all questions are displayed on a single page.
                  example: Multiple Submission
                sectionSubmissionTypeValue:
                  type: integer
                  description: >-
                    Displays the value as 0 or 1.“0” indicates a single
                    submission and “1” indicates multiple submissions.
                  example: 0
                questionCount:
                  type: integer
                  description: Displays the number of questions within the section.
                  example: 7
                sectionBenefitType:
                  type: string
                  description: >-
                    Displays the section benefits type as points or reward
                    coupon. A section benefit is provided to members who
                    successfully complete the survey’s section.
                  example: Points
                sectionBenefitsValue:
                  type: string
                  description: >-
                    Displays the points or coupons which members receive upon
                    completion of the section. If the benefit type is points,
                    members will receive a defined number of points. If the
                    benefit type is reward coupon, members will receive a coupon
                    code.
                  example: 100
                sectionBenefitsExpirationType:
                  type: string
                  description: >-
                    Displays the benefit expiration type as rolling or calendar.
                    Rolling- The section benefits expire within a set number of
                    days from when the section is completed. Calendar- The
                    section benefits expire based on a calendar time frame, such
                    as weeks, months, or years.
                  example: Rolling
                sectionBenefitsExpiration:
                  type: string
                  description: >-
                    Displays the time after which the benefits expire. The
                    benefit expiration can be either a rolling or calendar. If
                    the expiration type is rolling, the period displayed will be
                    in number of days. If the expiration type is calendar, the
                    period displayed will be in weeks, months, quarters, or
                    years.
                  example: 10 Days
                enablePreview:
                  type: string
                  description: >-
                    Displays YES if the preview functionality is enabled and NO
                    if it is disabled.This is a draft review for internal use.
                    It allows admin to catch and correct any errors before
                    sharing the information with external parties.
                  example: 'No'
                sectionGoToValue:
                  type: string
                  description: >-
                    Displays the next value to be executed upon completing the
                    section. It may be next section or end survey.
                  example: End Survey
                sectionGoToId:
                  type: integer
                  description: >-
                    Displays the section ID for the next section members will be
                    directed to upon completion of the current section. If
                    members are taken to the end of the survey upon completion
                    of the section, there will be no data included in this
                    field.
                  example: 18
                sectionGoToName:
                  type: string
                  description: Displays the name of the subsequent section.
                  example: Loyalty Services
                sectionCreateDate:
                  type: string
                  description: >-
                    Displays the section creation date and time in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2023-01-13T05:59:13+0000
                sectionUpdateDate:
                  type: string
                  description: >-
                    Displays the date and time, the section was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2023-01-13T11:46:35+0000
    getsurveysurveyiduseremailidsectionsectionidquestionallresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            surveyCriteria:
              type: object
              description: >-
                Displays the following information required to complete the
                survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the terms and conditions (rules, restrictions)
                    required to qualify for the survey. Only members who have
                    completed the survey, qualify for the segment, or both are
                    eligible to take the survey.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that must be
                            completed by the member to access the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey members must
                            complete to access the current survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with the survey.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: Displays the name of the segment.
                          example: Survey Segment
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                sectionId:
                  type: integer
                  description: >-
                    Displays the unique section ID. (A survey includes multiple
                    questions for loyalty members to answer, and the questions
                    are split into various sections to help them comprehend the
                    context of the survey).
                  example: 654
                sectionName:
                  type: string
                  description: >-
                    Displays the section name as specified by the administrator.
                    (If the member just completes one section of the survey, the
                    name of the survey and the section are both displayed).
                  example: Customer Interest
                sectionSequence:
                  type: integer
                  description: >-
                    Displays the number of the section within the sequence of
                    sections in the survey.Multiple sections can be configured
                    in the survey, and the sequence of the sections are
                    determined by the admin at the time the survey is
                    configured.
                  example: 4
                sectionSubmissionType:
                  type: string
                  description: >-
                    Displays the section submission type as single or
                    multiple.In single submission, only one question is
                    displayed per page for answering while in multiple
                    submissions, all questions are displayed on a single page.
                  example: Multiple Submission
                sectionSubmissionTypeValue:
                  type: integer
                  description: >-
                    Displays the value as 0 or 1.“0” indicates a single
                    submission and “1” indicates multiple submissions.
                  example: 0
                questionCount:
                  type: integer
                  description: Displays the number of questions within the section.
                  example: 7
                sectionBenefitType:
                  type: string
                  description: >-
                    Displays the section benefits type as points or reward
                    coupon. A section benefit is provided to members who
                    successfully complete the survey’s section.
                  example: Points
                sectionBenefitsValue:
                  type: string
                  description: >-
                    Displays the points or coupons which members receive upon
                    completion of the section. If the benefit type is points,
                    members will receive a defined number of points. If the
                    benefit type is reward coupon, members will receive a coupon
                    code.
                  example: 100
                sectionBenefitsExpirationType:
                  type: string
                  description: >-
                    Displays the benefit expiration type as rolling or calendar.
                    Rolling- The section benefits expire within a set number of
                    days from when the section is completed. Calendar- The
                    section benefits expire based on a calendar time frame, such
                    as weeks, months, or years.
                  example: Rolling
                sectionBenefitsExpiration:
                  type: string
                  description: >-
                    Displays the time after which the benefits expire. The
                    benefit expiration can be either a rolling or calendar. If
                    the expiration type is rolling, the period displayed will be
                    in number of days. If the expiration type is calendar, the
                    period displayed will be in weeks, months, quarters, or
                    years.
                  example: 10 Days
                enablePreview:
                  type: string
                  description: >-
                    Displays YES if the preview functionality is enabled and NO
                    if it is disabled.This is a draft review for internal use.
                    It allows admin to catch and correct any errors before
                    sharing the information with external parties.
                  example: 'No'
                sectionGoToValue:
                  type: string
                  description: >-
                    Displays the next value to be executed upon completing the
                    section. It may be next section or end survey.
                  example: End Survey
                sectionGoToId:
                  type: integer
                  description: >-
                    Displays the section ID for the next section members will be
                    directed to upon completion of the current section. If
                    members are taken to the end of the survey upon completion
                    of the section, there will be no data included in this
                    field.
                  example: 18
                sectionGoToName:
                  type: string
                  description: Displays the name of the subsequent section.
                  example: Loyalty Services
                sectionCreateDate:
                  type: string
                  description: >-
                    Displays the section creation date and time in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2023-01-13T05:59:13+0000
                sectionUpdateDate:
                  type: string
                  description: >-
                    Displays the date and time, the section was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2023-01-13T11:46:35+0000
                question:
                  type: object
                  description: >-
                    Displays the following information for the list of questions
                    within the section.
                  properties:
                    questionId:
                      type: integer
                      description: Displays the unique question ID.
                      example: 155
                    questionName:
                      type: string
                      description: Displays the question being asked.
                      example: What is your age?
                    questionType:
                      type: integer
                      description: >-
                        Displays the type of response this question accepts. 1-
                        checkbox 2-radiobutton 3-scale 4- textbox 5-text area
                        6-dropdown 7-upload an image.
                      example: 2
                    questionTypeName:
                      type: string
                      description: >-
                        Displays the name of the response type this question
                        accepts.
                      example: Radiobutton
                    questionImage:
                      type: string
                      description: >-
                        Displays the image url for the image associated with the
                        question.
                      example: https://surveyquestionimage.com
                    questionImageCaption:
                      type: string
                      description: Displays the question’s image caption.
                      example: Survey question
                    questionSequence:
                      type: integer
                      description: >-
                        Displays the number of the question within the sequence
                        of questions in the section. Multiple questions can be
                        configured in the section, and the sequence of the
                        questions is determined by the admin at the time of
                        configuration.
                      example: 1
                    questionMinOption:
                      type: integer
                      description: >-
                        Displays the minimum number of answers that can be
                        submitted in response to the question. This is only
                        relevant for Checkbox response questions where members
                        have the option to select and submit multiple answers to
                        the question.
                      example: 1
                    questionMaxOption:
                      type: integer
                      description: >-
                        Displays the maximum number of answers that can be
                        submitted in response to the question. This is only
                        relevant for Checkbox response questions where members
                        have the option to select and submit multiple answers to
                        the question.
                      example: 3
                    isRequired:
                      type: string
                      description: >-
                        Displays YES if the question is mandatory and NO if it
                        is optional.
                      example: 'YES'
                    enableShuffle:
                      type: string
                      description: >-
                        Displays YES if shuffle is enabled and NO if it is
                        disabled. If shuffle is enabled, the response options
                        for the question will shuffle in order when presented to
                        members. If it is not enabled the response options will
                        remain in the order set at the time the question was
                        configured.
                      example: 'NO'
                    questionCreateDate:
                      type: string
                      description: >-
                        Displays the date and time when this question was
                        created in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T05:59:13+0000
                    questionUpdateDate:
                      type: string
                      description: >-
                        Displays the last date and time, the question was
                        updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T11:46:35+0000
                    answer:
                      type: object
                      description: >-
                        Displays the following information for each answer
                        option configured for the question.
                      properties:
                        answerId:
                          type: integer
                          description: >-
                            Displays the unique answer ID which is
                            auto-generated at the time of creating an answer.
                          example: 155
                        answerOption:
                          type: string
                          description: Displays the answer option for the question.
                          example: USA
                        answerImage:
                          type: string
                          description: >-
                            Displays the URL for the image associated with the
                            answer option (if applicable).
                          example: >-
                            https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                        answerImageCaption:
                          type: string
                          description: >-
                            Displays the caption for the image associated with
                            the answer option (if applicable).
                          example: Question’s answer
                        answerSequence:
                          type: integer
                          description: >-
                            Displays the number of the answer option within the
                            sequence of possible answers listed for the
                            question.Multiple answer options can be configured
                            for one question. The sequence of possible answers
                            is determined by the administrator when configuring
                            the question. Please note that the sequence will
                            change if Shuffle is enabled.
                          example: 1
                        answerIsTrue:
                          type: string
                          description: >-
                            Displays YES if this is the correct answer to the
                            question. Otherwise, NO will display.
                          example: 'No'
                        answerOtherOption:
                          type: string
                          description: >-
                            Displays YES if this is the ‘Other’ answer option
                            and NO if this is not. When questions are configured
                            for a survey, administrators have the ability to
                            include an ‘Other’ response option where members can
                            enter their own unique response to the question.
                          example: 'No'
                        answerGoToValue:
                          type: string
                          description: >-
                            Displays ‘Question’ or ‘End Section’ to indicate if
                            the member is directed to another question or the
                            end of the section upon answering this question.
                          example: Next Question
                        answerGoToQuestionId:
                          type: integer
                          description: >-
                            Displays the question ID for the next question
                            members will be directed to upon answering the
                            current question (if applicable).
                          example: 156
                        answerGoToQuestionName:
                          type: string
                          description: >-
                            Displays the next question members will be asked
                            upon answering the current question (if applicable).
                          example: What is your favorite vacation place?
                        answerResponseCount:
                          type: integer
                          description: >-
                            Displays the number of times the answer has been
                            selected by members who have answered the question
                            on the survey.
                          example: 0
                        answerResponsePercentage:
                          type: string
                          description: >-
                            Displays the percentage of members who selected this
                            answer to the question. Suppose we have the
                            following statistics- Option A was chosen by 5
                            members. Option B was chosen by 10 members. Option C
                            was chosen by 20 members. Option D was chosen by 15
                            members. Then the percentage of members who selected
                            Option A is (5/50)*100 = 10%.
                          example: 10%
                        answerCreateDate:
                          type: string
                          description: >-
                            Displays the date and time when this qanswer was
                            created in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T05:59:13+0000
                        answerUpdateDate:
                          type: string
                          description: >-
                            Displays the last date and time, the answer was
                            updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T11:46:35+0000
    getsurveysurveyiduseremailidsectionsectionidquestionquestionidresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveySubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times the survey can be completed
                in total. For example, if the limit is 40, once the survey has
                been completed 40 times by any member or group of members,
                submissions will no longer be accepted.
              example: 40
            surveySubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                members.
              example: 20
            surveySubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted.
              example: 20
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            surveyCriteria:
              type: object
              description: >-
                Displays the following information required to complete the
                survey.
              properties:
                rules:
                  type: object
                  description: >-
                    Displays the terms and conditions (rules, restrictions)
                    required to qualify for the survey. Only members who have
                    completed the survey, qualify for the segment, or both are
                    eligible to take the survey.
                  properties:
                    survey:
                      type: object
                      description: >-
                        Displays the following parameters associated with the
                        survey.
                      properties:
                        surveyId:
                          type: string
                          description: >-
                            Displays the unique ID of the survey that must be
                            completed by the member to access the current
                            survey.
                          example: 123
                        surveyName:
                          type: string
                          description: >-
                            Displays the name of the survey members must
                            complete to access the current survey.
                          example: Customer Interests
                        status:
                          type: string
                          description: >-
                            Displays whether the criteria is that the member
                            ‘Has Completed’ or ‘Has Not Completed’ this survey
                            to become eligible for the current survey.
                          example: Has Completed
                    segment:
                      type: object
                      description: >-
                        Displays the following information for the segment
                        associated with the survey.
                      properties:
                        segmentId:
                          type: integer
                          description: >-
                            Displays the ID of the segment members must belong
                            to in order to access the current survey.
                          example: 2206
                        segmentName:
                          type: string
                          description: Displays the name of the segment.
                          example: Survey Segment
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                sectionId:
                  type: integer
                  description: >-
                    Displays the unique section ID. (A survey includes multiple
                    questions for loyalty members to answer, and the questions
                    are split into various sections to help them comprehend the
                    context of the survey).
                  example: 654
                sectionName:
                  type: string
                  description: >-
                    Displays the section name as specified by the administrator.
                    (If the member just completes one section of the survey, the
                    name of the survey and the section are both displayed).
                  example: Customer Interest
                sectionSequence:
                  type: integer
                  description: >-
                    Displays the number of the section within the sequence of
                    sections in the survey.Multiple sections can be configured
                    in the survey, and the sequence of the sections are
                    determined by the admin at the time the survey is
                    configured.
                  example: 4
                sectionSubmissionType:
                  type: string
                  description: >-
                    Displays the section submission type as single or
                    multiple.In single submission, only one question is
                    displayed per page for answering while in multiple
                    submissions, all questions are displayed on a single page.
                  example: Multiple Submission
                sectionSubmissionTypeValue:
                  type: integer
                  description: >-
                    Displays the value as 0 or 1.“0” indicates a single
                    submission and “1” indicates multiple submissions.
                  example: 0
                questionCount:
                  type: integer
                  description: Displays the number of questions within the section.
                  example: 7
                sectionBenefitType:
                  type: string
                  description: >-
                    Displays the section benefits type as points or reward
                    coupon. A section benefit is provided to members who
                    successfully complete the survey’s section.
                  example: Points
                sectionBenefitsValue:
                  type: string
                  description: >-
                    Displays the points or coupons which members receive upon
                    completion of the section. If the benefit type is points,
                    members will receive a defined number of points. If the
                    benefit type is reward coupon, members will receive a coupon
                    code.
                  example: 100
                sectionBenefitsExpirationType:
                  type: string
                  description: >-
                    Displays the benefit expiration type as rolling or calendar.
                    Rolling- The section benefits expire within a set number of
                    days from when the section is completed. Calendar- The
                    section benefits expire based on a calendar time frame, such
                    as weeks, months, or years.
                  example: Rolling
                sectionBenefitsExpiration:
                  type: string
                  description: >-
                    Displays the time after which the benefits expire. The
                    benefit expiration can be either a rolling or calendar. If
                    the expiration type is rolling, the period displayed will be
                    in number of days. If the expiration type is calendar, the
                    period displayed will be in weeks, months, quarters, or
                    years.
                  example: 10 Days
                enablePreview:
                  type: string
                  description: >-
                    Displays YES if the preview functionality is enabled and NO
                    if it is disabled.This is a draft review for internal use.
                    It allows admin to catch and correct any errors before
                    sharing the information with external parties.
                  example: 'No'
                sectionGoToValue:
                  type: string
                  description: >-
                    Displays the next value to be executed upon completing the
                    section. It may be next section or end survey.
                  example: End Survey
                sectionGoToId:
                  type: integer
                  description: >-
                    Displays the section ID for the next section members will be
                    directed to upon completion of the current section. If
                    members are taken to the end of the survey upon completion
                    of the section, there will be no data included in this
                    field.
                  example: 18
                sectionGoToName:
                  type: string
                  description: Displays the name of the subsequent section.
                  example: Loyalty Services
                sectionCreateDate:
                  type: string
                  description: >-
                    Displays the section creation date and time in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2023-01-13T05:59:13+0000
                sectionUpdateDate:
                  type: string
                  description: >-
                    Displays the date and time, the section was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2023-01-13T11:46:35+0000
                question:
                  type: object
                  description: >-
                    Displays the following information for the list of questions
                    within the section.
                  properties:
                    questionId:
                      type: integer
                      description: Displays the unique question ID.
                      example: 155
                    questionName:
                      type: string
                      description: Displays the question being asked.
                      example: What is your age?
                    questionType:
                      type: integer
                      description: >-
                        Displays the type of response this question accepts. 1-
                        checkbox 2-radiobutton 3-scale 4- textbox 5-text area
                        6-dropdown 7-upload an image.
                      example: 2
                    questionTypeName:
                      type: string
                      description: >-
                        Displays the name of the response type this question
                        accepts.
                      example: Radiobutton
                    questionImage:
                      type: string
                      description: >-
                        Displays the image url for the image associated with the
                        question.
                      example: https://surveyquestionimage.com
                    questionImageCaption:
                      type: string
                      description: Displays the question’s image caption.
                      example: Survey question
                    questionSequence:
                      type: integer
                      description: >-
                        Displays the number of the question within the sequence
                        of questions in the section. Multiple questions can be
                        configured in the section, and the sequence of the
                        questions is determined by the admin at the time of
                        configuration.
                      example: 1
                    questionMinOption:
                      type: integer
                      description: >-
                        Displays the minimum number of answers that can be
                        submitted in response to the question. This is only
                        relevant for Checkbox response questions where members
                        have the option to select and submit multiple answers to
                        the question.
                      example: 1
                    questionMaxOption:
                      type: integer
                      description: >-
                        Displays the maximum number of answers that can be
                        submitted in response to the question. This is only
                        relevant for Checkbox response questions where members
                        have the option to select and submit multiple answers to
                        the question.
                      example: 3
                    isRequired:
                      type: string
                      description: >-
                        Displays YES if the question is mandatory and NO if it
                        is optional.
                      example: 'YES'
                    enableShuffle:
                      type: string
                      description: >-
                        Displays YES if shuffle is enabled and NO if it is
                        disabled. If shuffle is enabled, the response options
                        for the question will shuffle in order when presented to
                        members. If it is not enabled the response options will
                        remain in the order set at the time the question was
                        configured.
                      example: 'NO'
                    questionCreateDate:
                      type: string
                      description: >-
                        Displays the date and time when this question was
                        created in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T05:59:13+0000
                    questionUpdateDate:
                      type: string
                      description: >-
                        Displays the last date and time, the question was
                        updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T11:46:35+0000
                    answer:
                      type: object
                      description: >-
                        Displays the following information for each answer
                        option configured for the question.
                      properties:
                        answerId:
                          type: integer
                          description: >-
                            Displays the unique answer ID which is
                            auto-generated at the time of creating an answer.
                          example: 155
                        answerOption:
                          type: string
                          description: Displays the answer option for the question.
                          example: USA
                        answerImage:
                          type: string
                          description: >-
                            Displays the URL for the image associated with the
                            answer option (if applicable).
                          example: >-
                            https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                        answerImageCaption:
                          type: string
                          description: >-
                            Displays the caption for the image associated with
                            the answer option (if applicable).
                          example: Question’s answer
                        answerSequence:
                          type: integer
                          description: >-
                            Displays the number of the answer option within the
                            sequence of possible answers listed for the
                            question.Multiple answer options can be configured
                            for one question. The sequence of possible answers
                            is determined by the administrator when configuring
                            the question. Please note that the sequence will
                            change if Shuffle is enabled.
                          example: 1
                        answerIsTrue:
                          type: string
                          description: >-
                            Displays YES if this is the correct answer to the
                            question. Otherwise, NO will display.
                          example: 'No'
                        answerOtherOption:
                          type: string
                          description: >-
                            Displays YES if this is the ‘Other’ answer option
                            and NO if this is not. When questions are configured
                            for a survey, administrators have the ability to
                            include an ‘Other’ response option where members can
                            enter their own unique response to the question.
                          example: 'No'
                        answerGoToValue:
                          type: string
                          description: >-
                            Displays ‘Question’ or ‘End Section’ to indicate if
                            the member is directed to another question or the
                            end of the section upon answering this question.
                          example: Next Question
                        answerGoToQuestionId:
                          type: integer
                          description: >-
                            Displays the question ID for the next question
                            members will be directed to upon answering the
                            current question (if applicable).
                          example: 156
                        answerGoToQuestionName:
                          type: string
                          description: >-
                            Displays the next question members will be asked
                            upon answering the current question (if applicable).
                          example: What is your favorite vacation place?
                        answerResponseCount:
                          type: integer
                          description: >-
                            Displays the number of times the answer has been
                            selected by members who have answered the question
                            on the survey.
                          example: 0
                        answerResponsePercentage:
                          type: string
                          description: >-
                            Displays the percentage of members who selected this
                            answer to the question. Suppose we have the
                            following statistics- Option A was chosen by 5
                            members. Option B was chosen by 10 members. Option C
                            was chosen by 20 members. Option D was chosen by 15
                            members. Then the percentage of members who selected
                            Option A is (5/50)*100 = 10%.
                          example: 10%
                        answerCreateDate:
                          type: string
                          description: >-
                            Displays the date and time when this qanswer was
                            created in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T05:59:13+0000
                        answerUpdateDate:
                          type: string
                          description: >-
                            Displays the last date and time, the answer was
                            updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T11:46:35+0000
    getsurveysurveyiduseremailidstatusresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            userSubmissionLimit:
              type: integer
              description: >-
                Displays the maximum number of times an individual member is
                allowed to complete the survey.
              example: 5
            userSubmitted:
              type: integer
              description: >-
                Displays the number of times the survey has been submitted by
                the member.
              example: 2
            userSubmissionRemaining:
              type: integer
              description: >-
                Displays the remaining number of times the survey can be
                submitted by the member.
              example: 3
            userSurveyStatus:
              type: string
              description: >-
                Displays whether the member has completed the survey or not.The
                status can have one of these values- pending, in progress, or
                completed.
              example: IN PROGRESS
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            activeSectionId:
              type: integer
              description: >-
                Displays the unique identification number of the active survey
                section.
              example: 154
            activeQuestionId:
              type: integer
              description: >-
                Displays the unique identification number of the active survey
                question.
              example: 195
            userEligible:
              type: string
              description: >-
                Displays whether the member is eligible for the survey or not.It
                shows true if the member is eligible, otherwise false.
              example: true
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                pendingSection:
                  type: object
                  description: >-
                    Displays the following parameters for the pending section
                    that needs to be completed by the member.
                  properties:
                    sectionId:
                      type: integer
                      description: >-
                        Displays the unique section ID. (A survey includes
                        multiple questions for loyalty members to answer, and
                        the questions are split into various sections to help
                        them comprehend the context of the survey).
                      example: 654
                    sectionName:
                      type: string
                      description: >-
                        Displays the section name as specified by the
                        administrator. (If the member just completes one section
                        of the survey, the name of the survey and the section
                        are both displayed).
                      example: Customer Interest
                    sectionSequence:
                      type: integer
                      description: >-
                        Displays the number of the section within the sequence
                        of sections in the survey.Multiple sections can be
                        configured in the survey, and the sequence of the
                        sections are determined by the admin at the time the
                        survey is configured.
                      example: 4
                    questionCount:
                      type: integer
                      description: Displays the number of questions within the section.
                      example: 7
                    sectionBenefitType:
                      type: string
                      description: >-
                        Displays the section benefits type as points or reward
                        coupon. A section benefit is provided to members who
                        successfully complete the survey’s section.
                      example: Points
                    sectionBenefitsValue:
                      type: string
                      description: >-
                        Displays the points or coupons which members receive
                        upon completion of the section. If the benefit type is
                        points, members will receive a defined number of points.
                        If the benefit type is reward coupon, members will
                        receive a coupon code.
                      example: 100
                    sectionBenefitsExpirationType:
                      type: string
                      description: >-
                        Displays the benefit expiration type as rolling or
                        calendar. Rolling- The section benefits expire within a
                        set number of days from when the section is completed.
                        Calendar- The section benefits expire based on a
                        calendar time frame, such as weeks, months, or years.
                      example: Rolling
                    sectionBenefitsExpiration:
                      type: string
                      description: >-
                        Displays the time after which the benefits expire. The
                        benefit expiration can be either a rolling or calendar.
                        If the expiration type is rolling, the period displayed
                        will be in number of days. If the expiration type is
                        calendar, the period displayed will be in weeks, months,
                        quarters, or years.
                      example: 10 Days
                    enablePreview:
                      type: string
                      description: >-
                        Displays YES if the preview functionality is enabled and
                        NO if it is disabled.This is a draft review for internal
                        use. It allows admin to catch and correct any errors
                        before sharing the information with external parties.
                      example: 'No'
                    sectionGoToValue:
                      type: string
                      description: >-
                        Displays the next value to be executed upon completing
                        the section. It may be next section or end survey.
                      example: End Survey
                    sectionGoToId:
                      type: integer
                      description: >-
                        Displays the section ID for the next section members
                        will be directed to upon completion of the current
                        section. If members are taken to the end of the survey
                        upon completion of the section, there will be no data
                        included in this field.
                      example: 18
                    sectionGoToName:
                      type: string
                      description: Displays the name of the subsequent section.
                      example: Loyalty Services
                    sectionActiveQuestion:
                      type: string
                      description: Displays the active question of the section.
                      example: How would you rate the quality of the product?
                    sectionCreateDate:
                      type: string
                      description: >-
                        Displays the section creation date and time in
                        yyyy-MM-dd’T’HH:mm:ssZ format.
                      example: 2023-01-13T05:59:13+0000
                    sectionUpdateDate:
                      type: string
                      description: >-
                        Displays the date and time, the section was last updated
                        in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T11:46:35+0000
                    pendingQuestion:
                      type: object
                      description: >-
                        Displays the following information for the pending
                        questions that need to be answered by the member.
                      properties:
                        questionId:
                          type: integer
                          description: Displays the unique question ID.
                          example: 155
                        questionName:
                          type: string
                          description: Displays the question being asked.
                          example: What is your age?
                        questionType:
                          type: integer
                          description: >-
                            Displays the type of response this question accepts.
                            1- checkbox 2-radiobutton 3-scale 4- textbox 5-text
                            area 6-dropdown 7-upload an image.
                          example: 2
                        questionTypeName:
                          type: string
                          description: >-
                            Displays the name of the response type this question
                            accepts.
                          example: Radiobutton
                        questionImage:
                          type: string
                          description: >-
                            Displays the image url for the image associated with
                            the question.
                          example: https://surveyquestionimage.com
                        questionImageCaption:
                          type: string
                          description: Displays the question’s image caption.
                          example: Survey question
                        isRequired:
                          type: string
                          description: >-
                            Displays YES if the question is mandatory and NO if
                            it is optional.
                          example: 'YES'
                        enableShuffle:
                          type: string
                          description: >-
                            Displays YES if shuffle is enabled and NO if it is
                            disabled. If shuffle is enabled, the response
                            options for the question will shuffle in order when
                            presented to members. If it is not enabled the
                            response options will remain in the order set at the
                            time the question was configured.
                          example: 'NO'
                        questionCreateDate:
                          type: string
                          description: >-
                            Displays the date and time when this question was
                            created in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T05:59:13+0000
                        questionUpdateDate:
                          type: string
                          description: >-
                            Displays the last date and time, the question was
                            updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T11:46:35+0000
                        answer:
                          type: object
                          description: >-
                            Displays the following information for each answer
                            option configured for the question.
                          properties:
                            answerId:
                              type: integer
                              description: >-
                                Displays the unique answer ID which is
                                auto-generated at the time of creating an
                                answer.
                              example: 155
                            answerOption:
                              type: string
                              description: Displays the answer option for the question.
                              example: USA
                            answerImage:
                              type: string
                              description: >-
                                Displays the URL for the image associated with
                                the answer option (if applicable).
                              example: >-
                                https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                            answerImageCaption:
                              type: string
                              description: >-
                                Displays the caption for the image associated
                                with the answer option (if applicable).
                              example: Question’s answer
                            answerSequence:
                              type: integer
                              description: >-
                                Displays the number of the answer option within
                                the sequence of possible answers listed for the
                                question.Multiple answer options can be
                                configured for one question. The sequence of
                                possible answers is determined by the
                                administrator when configuring the question.
                                Please note that the sequence will change if
                                Shuffle is enabled.
                              example: 1
                            answerIsTrue:
                              type: string
                              description: >-
                                Displays YES if this is the correct answer to
                                the question. Otherwise, NO will display.
                              example: 'No'
                            answerOtherOption:
                              type: string
                              description: >-
                                Displays YES if this is the ‘Other’ answer
                                option and NO if this is not. When questions are
                                configured for a survey, administrators have the
                                ability to include an ‘Other’ response option
                                where members can enter their own unique
                                response to the question.
                              example: 'No'
                            answerGoToValue:
                              type: string
                              description: >-
                                Displays ‘Question’ or ‘End Section’ to indicate
                                if the member is directed to another question or
                                the end of the section upon answering this
                                question.
                              example: Next Question
                            answerGoToQuestionId:
                              type: integer
                              description: >-
                                Displays the question ID for the next question
                                members will be directed to upon answering the
                                current question (if applicable).
                              example: 156
                            answerGoToQuestionName:
                              type: string
                              description: >-
                                Displays the next question members will be asked
                                upon answering the current question (if
                                applicable).
                              example: What is your favorite vacation place?
                            answerResponseCount:
                              type: integer
                              description: >-
                                Displays the number of times the answer has been
                                selected by members who have answered the
                                question on the survey.
                              example: 0
                            answerResponsePercentage:
                              type: string
                              description: >-
                                Displays the percentage of members who selected
                                this answer to the question. Suppose we have the
                                following statistics- Option A was chosen by 5
                                members. Option B was chosen by 10 members.
                                Option C was chosen by 20 members. Option D was
                                chosen by 15 members. Then the percentage of
                                members who selected Option A is (5/50)*100 =
                                10%.
                              example: 10%
                            answerCreateDate:
                              type: string
                              description: >-
                                Displays the date and time when this qanswer was
                                created in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2023-01-13T05:59:13+0000
                            answerUpdateDate:
                              type: string
                              description: >-
                                Displays the last date and time, the answer was
                                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2023-01-13T11:46:35+0000
            completedQuestion:
              type: object
              description: >-
                Displays the following details for the question the member has
                answered within the survey.
              properties:
                questionId:
                  type: integer
                  description: Displays the unique question ID of the completed question.
                  example: 347
                questionName:
                  type: string
                  description: Displays the question being asked.
                  example: How well do our products meet your needs?
                answer:
                  type: object
                  description: >-
                    Displays the following information for each answer option
                    configured for the question.
                  properties:
                    answerId:
                      type: integer
                      description: >-
                        Displays the unique answer ID which is auto-generated at
                        the time of creating an answer.
                      example: 155
                    answerOption:
                      type: string
                      description: Displays the answer option for the question.
                      example: Very well
            completedSection:
              type: object
              description: >-
                Displays the list of all sections of the survey that have been
                completed by the member.
    getsurveysurveyiduseremailidsectionsectionidstatusresp:
      type: object
      properties:
        surveyData:
          type: object
          description: Displays the following parameters associated with the survey.
          properties:
            surveyId:
              type: string
              description: Displays the unique survey ID.
              example: 63
            userId:
              type: string
              description: >-
                Displays the unique member ID which was automatically generated
                when the member signed up for the loyalty program.
              example: user@domain.com
            surveyName:
              type: string
              description: Displays the name of the survey.
              example: Customer Interests
            surveyDescription:
              type: string
              description: >-
                Displays detailed information about the survey. It helps loyalty
                members understand the survey's purpose.
              example: >-
                The purpose of the survey is to acquire information about
                consumer habits.
            surveyImage:
              type: string
              description: >-
                Displays the image URL for the image associated with the survey
                upon survey configuration. Note - The image value is in base64
                encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
              example: >-
                https://admin.socialannexuat.com/assets/v1/media/logos/AC-logo.png
            surveyImageCaption:
              type: string
              description: Displays the caption provided for the image in the survey.
              example: Customer feedback
            surveySequence:
              type: integer
              description: >-
                Displays the sequence number for the current survey established
                upon survey configuration.This is applicable when there is more
                than one survey.Suppose there are five surveys that the
                administrator has created, named Survey 1, Survey 2, Survey 3,
                Survey 4, and Survey 5. If a loyalty member needs to complete
                all of them, it can be confusing for them to navigate through
                each survey. In such cases, the survey sequence comes in handy
                as it helps the member to easily move from one survey to the
                other.
              example: 2
            surveyType:
              type: string
              description: >-
                Displays the survey type as product feedback, display a score,
                vote/poll, community survey or other type.
              example: Product Feedback
            surveyStartDate:
              type: string
              description: >-
                Displays the start date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-13T00:00:00+0000
            surveyEndDate:
              type: string
              description: >-
                Displays the end date of the survey in yyyy-MM-dd'T'HH:mm:ssZ
                format.
              example: 2023-01-31T00:00:00+0000
            surveyBenefitsType:
              type: string
              description: >-
                Displays the benefits provided upon completing the survey as
                points or reward coupon. In order to award the survey benefit to
                members the administrator must enable the survey benefit flag on
                the site. A survey benefit is provided to members who
                successfully complete the survey.
              example: Points
            surveyBenefitsValue:
              type: integer
              description: >-
                Displays the benefit's value that is awarded to members.This
                will appear as the number of points members will be awarded or
                the monetary value of the reward coupon members will receive
                upon completing the survey.
              example: 100
            surveyBenefitsReason:
              type: string
              description: Displays the reason for which the survey benefit is provided.
              example: Survey Completed
            surveyBenefitsExpirationType:
              type: string
              description: >-
                Displays the benefit expiration type as rolling or calendar.
                Rolling- The survey benefits expire within a set number of days
                from the date the survey is completed and the member is awarded
                the benefit.Calendar- The survey benefits expire based on a
                calendar time frame, such as weeks, months, or years.
              example: Rolling
            surveyBenefitsExpiration:
              type: string
              description: >-
                Displays the period of time after which the benefits expire. The
                benefit expiration can be either rolling or calendar.If the
                expiration type is rolling, the period displayed will be in
                number of days. If the expiration type is calendar, the period
                displayed will be in weeks, months, quarters, or years.
              example: 365 Days
            surveyStatus:
              type: string
              description: Displays the survey’s status as active or inactive.
              example: Active
            surveyCreateDate:
              type: string
              description: >-
                Displays the survey creation date and time in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            surveyUpdateDate:
              type: string
              description: >-
                Displays the date on which the survey information was last
                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2023-01-13T05:58:27+0000
            activeSectionId:
              type: integer
              description: >-
                Displays the unique identification number of the active survey
                section.
              example: 154
            activeQuestionId:
              type: integer
              description: >-
                Displays the unique identification number of the active survey
                question.
              example: 195
            sections:
              type: object
              description: >-
                Displays the following information related to the survey's
                section.
              properties:
                pendingSection:
                  type: object
                  description: >-
                    Displays the following parameters for the pending section
                    that needs to be completed by the member.
                  properties:
                    sectionId:
                      type: integer
                      description: >-
                        Displays the unique section ID. (A survey includes
                        multiple questions for loyalty members to answer, and
                        the questions are split into various sections to help
                        them comprehend the context of the survey).
                      example: 654
                    sectionName:
                      type: string
                      description: >-
                        Displays the section name as specified by the
                        administrator. (If the member just completes one section
                        of the survey, the name of the survey and the section
                        are both displayed).
                      example: Customer Interest
                    sectionSequence:
                      type: integer
                      description: >-
                        Displays the number of the section within the sequence
                        of sections in the survey.Multiple sections can be
                        configured in the survey, and the sequence of the
                        sections are determined by the admin at the time the
                        survey is configured.
                      example: 4
                    questionCount:
                      type: integer
                      description: Displays the number of questions within the section.
                      example: 7
                    sectionBenefitType:
                      type: string
                      description: >-
                        Displays the section benefits type as points or reward
                        coupon. A section benefit is provided to members who
                        successfully complete the survey’s section.
                      example: Points
                    sectionBenefitsValue:
                      type: string
                      description: >-
                        Displays the points or coupons which members receive
                        upon completion of the section. If the benefit type is
                        points, members will receive a defined number of points.
                        If the benefit type is reward coupon, members will
                        receive a coupon code.
                      example: 100
                    sectionBenefitsExpirationType:
                      type: string
                      description: >-
                        Displays the benefit expiration type as rolling or
                        calendar. Rolling- The section benefits expire within a
                        set number of days from when the section is completed.
                        Calendar- The section benefits expire based on a
                        calendar time frame, such as weeks, months, or years.
                      example: Rolling
                    sectionBenefitsExpiration:
                      type: string
                      description: >-
                        Displays the time after which the benefits expire. The
                        benefit expiration can be either a rolling or calendar.
                        If the expiration type is rolling, the period displayed
                        will be in number of days. If the expiration type is
                        calendar, the period displayed will be in weeks, months,
                        quarters, or years.
                      example: 10 Days
                    enablePreview:
                      type: string
                      description: >-
                        Displays YES if the preview functionality is enabled and
                        NO if it is disabled.This is a draft review for internal
                        use. It allows admin to catch and correct any errors
                        before sharing the information with external parties.
                      example: 'No'
                    sectionGoToValue:
                      type: string
                      description: >-
                        Displays the next value to be executed upon completing
                        the section. It may be next section or end survey.
                      example: End Survey
                    sectionGoToId:
                      type: integer
                      description: >-
                        Displays the section ID for the next section members
                        will be directed to upon completion of the current
                        section. If members are taken to the end of the survey
                        upon completion of the section, there will be no data
                        included in this field.
                      example: 18
                    sectionGoToName:
                      type: string
                      description: Displays the name of the subsequent section.
                      example: Loyalty Services
                    sectionActiveQuestion:
                      type: string
                      description: Displays the active question of the section.
                      example: How would you rate the quality of the product?
                    sectionCreateDate:
                      type: string
                      description: >-
                        Displays the section creation date and time in
                        yyyy-MM-dd’T’HH:mm:ssZ format.
                      example: 2023-01-13T05:59:13+0000
                    sectionUpdateDate:
                      type: string
                      description: >-
                        Displays the date and time, the section was last updated
                        in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2023-01-13T11:46:35+0000
                    pendingQuestion:
                      type: object
                      description: >-
                        Displays the following information for the pending
                        questions that need to be answered by the member.
                      properties:
                        questionId:
                          type: integer
                          description: Displays the unique question ID.
                          example: 155
                        questionName:
                          type: string
                          description: Displays the question being asked.
                          example: What is your age?
                        questionType:
                          type: integer
                          description: >-
                            Displays the type of response this question accepts.
                            1- checkbox 2-radiobutton 3-scale 4- textbox 5-text
                            area 6-dropdown 7-upload an image.
                          example: 2
                        questionTypeName:
                          type: string
                          description: >-
                            Displays the name of the response type this question
                            accepts.
                          example: Radiobutton
                        questionImage:
                          type: string
                          description: >-
                            Displays the image url for the image associated with
                            the question.
                          example: https://surveyquestionimage.com
                        questionImageCaption:
                          type: string
                          description: Displays the question’s image caption.
                          example: Survey question
                        isRequired:
                          type: string
                          description: >-
                            Displays YES if the question is mandatory and NO if
                            it is optional.
                          example: 'YES'
                        enableShuffle:
                          type: string
                          description: >-
                            Displays YES if shuffle is enabled and NO if it is
                            disabled. If shuffle is enabled, the response
                            options for the question will shuffle in order when
                            presented to members. If it is not enabled the
                            response options will remain in the order set at the
                            time the question was configured.
                          example: 'NO'
                        questionCreateDate:
                          type: string
                          description: >-
                            Displays the date and time when this question was
                            created in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T05:59:13+0000
                        questionUpdateDate:
                          type: string
                          description: >-
                            Displays the last date and time, the question was
                            updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                          example: 2023-01-13T11:46:35+0000
                        answer:
                          type: object
                          description: >-
                            Displays the following information for each answer
                            option configured for the question.
                          properties:
                            answerId:
                              type: integer
                              description: >-
                                Displays the unique answer ID which is
                                auto-generated at the time of creating an
                                answer.
                              example: 155
                            answerOption:
                              type: string
                              description: Displays the answer option for the question.
                              example: USA
                            answerImage:
                              type: string
                              description: >-
                                Displays the URL for the image associated with
                                the answer option (if applicable).
                              example: >-
                                https://admin.socialannexuat.com/assets/v1/media/loGos/AC-loGo.png
                            answerImageCaption:
                              type: string
                              description: >-
                                Displays the caption for the image associated
                                with the answer option (if applicable).
                              example: Question’s answer
                            answerSequence:
                              type: integer
                              description: >-
                                Displays the number of the answer option within
                                the sequence of possible answers listed for the
                                question.Multiple answer options can be
                                configured for one question. The sequence of
                                possible answers is determined by the
                                administrator when configuring the question.
                                Please note that the sequence will change if
                                Shuffle is enabled.
                              example: 1
                            answerIsTrue:
                              type: string
                              description: >-
                                Displays YES if this is the correct answer to
                                the question. Otherwise, NO will display.
                              example: 'No'
                            answerOtherOption:
                              type: string
                              description: >-
                                Displays YES if this is the ‘Other’ answer
                                option and NO if this is not. When questions are
                                configured for a survey, administrators have the
                                ability to include an ‘Other’ response option
                                where members can enter their own unique
                                response to the question.
                              example: 'No'
                            answerGoToValue:
                              type: string
                              description: >-
                                Displays ‘Question’ or ‘End Section’ to indicate
                                if the member is directed to another question or
                                the end of the section upon answering this
                                question.
                              example: Next Question
                            answerGoToQuestionId:
                              type: integer
                              description: >-
                                Displays the question ID for the next question
                                members will be directed to upon answering the
                                current question (if applicable).
                              example: 156
                            answerGoToQuestionName:
                              type: string
                              description: >-
                                Displays the next question members will be asked
                                upon answering the current question (if
                                applicable).
                              example: What is your favorite vacation place?
                            answerResponseCount:
                              type: integer
                              description: >-
                                Displays the number of times the answer has been
                                selected by members who have answered the
                                question on the survey.
                              example: 0
                            answerResponsePercentage:
                              type: string
                              description: >-
                                Displays the percentage of members who selected
                                this answer to the question. Suppose we have the
                                following statistics- Option A was chosen by 5
                                members. Option B was chosen by 10 members.
                                Option C was chosen by 20 members. Option D was
                                chosen by 15 members. Then the percentage of
                                members who selected Option A is (5/50)*100 =
                                10%.
                              example: 10%
                            answerCreateDate:
                              type: string
                              description: >-
                                Displays the date and time when this qanswer was
                                created in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2023-01-13T05:59:13+0000
                            answerUpdateDate:
                              type: string
                              description: >-
                                Displays the last date and time, the answer was
                                updated in yyyy-MM-dd'T'HH:mm:ssZ format.
                              example: 2023-01-13T11:46:35+0000
            completedQuestion:
              type: object
              description: >-
                Displays the following details for the question the member has
                answered within the survey.
              properties:
                questionId:
                  type: integer
                  description: Displays the unique question ID of the completed question.
                  example: 347
                questionName:
                  type: string
                  description: Displays the question being asked.
                  example: How well do our products meet your needs?
                answer:
                  type: object
                  description: >-
                    Displays the following information for each answer option
                    configured for the question.
                  properties:
                    answerId:
                      type: integer
                      description: >-
                        Displays the unique answer ID which is auto-generated at
                        the time of creating an answer.
                      example: 155
                    answerOption:
                      type: string
                      description: Displays the answer option for the question.
                      example: Very well
    postissuanceresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: $10 Off
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays order status.
          example: ship
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product details.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
                campaignDetails:
                  type: object
                  description: >-
                    Displays the following information once the campaign
                    milestone benefit activity flag is enabled in the super
                    admin.
                  properties:
                    campaignGroupId:
                      type: integer
                      description: Displays the group ID associated with the campaign.
                      example: 1654
                    campaignId:
                      type: integer
                      description: Displays the campaign ID.
                      example: 3692
                    campaignName:
                      type: string
                      description: Displays the name of the campaign.
                      example: Back to School Savings
                    campaignPoints:
                      type: integer
                      description: >-
                        Displays the campaign points awarded to the member once
                        they achieve the campaign milestones.
                      example: 200
                    rewardId:
                      type: integer
                      description: >-
                        Displays the unique ID for the reward configured in the
                        loyalty program.
                      example: 2345
                    rewardName:
                      type: string
                      description: Displays the name of the reward used by the member.
                      example: Jockey $15.00 off purchase
                    rewardCode:
                      type: string
                      description: Displays the reward code used by the member.
                      example: AP232
    postissuancecreationfornonpurchasetransactionresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: $10 Off
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays order status.
          example: ship
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: acdb2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product details.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
    patchUpdatedIssuancereturnresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: >-
            Displays the name of a coupon code, if a code was applied on the
            order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points the awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays order status as Return.
          example: Return
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: acdb2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the date the product will be shipped in yyyy-MM-dd
                    format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
                campaignDetails:
                  type: object
                  description: >-
                    Displays the following information once the campaign
                    milestone benefit activity flag is enabled in the super
                    admin.
                  properties:
                    campaignGroupId:
                      type: integer
                      description: Displays the group ID associated with the campaign.
                      example: 1654
                    campaignId:
                      type: integer
                      description: Displays the campaign ID.
                      example: 3692
                    campaignName:
                      type: string
                      description: Displays the name of the campaign.
                      example: Back to School Savings
                    campaignPoints:
                      type: integer
                      description: >-
                        Displays the campaign points awarded to the member once
                        they achieve the campaign milestones.
                      example: 200
                    rewardId:
                      type: integer
                      description: >-
                        Displays the unique ID for the reward configured in the
                        loyalty program.
                      example: 2345
                    rewardName:
                      type: string
                      description: Displays the name of the reward used by the member.
                      example: Jockey $15.00 off purchase
                    rewardCode:
                      type: string
                      description: Displays the reward code used by the member.
                      example: AP232
    putupdateissuancedetailsresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: '29235480'
        userId:
          type: string
          description: Displays the unique internal Site ID.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays order status as ship.
          example: ship
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            reason:
              type: string
              description: >-
                Displays the reason for the activity. This may be a standardized
                selection from common reasons or a free-text explanation for the
                activity.
              example: NA
            createDate:
              type: string
              description: >-
                Displays the date when the transaction occurred in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-05-19T00:00:00+0000
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
                campaignDetails:
                  type: object
                  description: >-
                    Displays the following information once the campaign
                    milestone benefit activity flag is enabled in the super
                    admin.
                  properties:
                    campaignGroupId:
                      type: integer
                      description: Displays the group ID associated with the campaign.
                      example: 1654
                    campaignId:
                      type: integer
                      description: Displays the campaign ID.
                      example: 3692
                    campaignName:
                      type: string
                      description: Displays the name of the campaign.
                      example: Back to School Savings
                    campaignPoints:
                      type: integer
                      description: >-
                        Displays the campaign points awarded to the member once
                        they achieve the campaign milestones.
                      example: 200
                    rewardId:
                      type: integer
                      description: >-
                        Displays the unique ID for the reward configured in the
                        loyalty program.
                      example: 2345
                    rewardName:
                      type: string
                      description: Displays the name of the reward used by the member.
                      example: Jockey $15.00 off purchase
                    rewardCode:
                      type: string
                      description: Displays the reward code used by the member.
                      example: AP232
    patchupdatetransactionaspartialshipresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays the order status as Partial Ship
          example: Partial Ship
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
    patchupdatetransactionaspartialcancelresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays the order status as Partial Cancel.
          example: Partial Cancel
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
    postuseissuancedetailsfilterresp:
      type: object
      properties:
        pages:
          type: integer
          description: Displays the total number of pages associated with the activities.
          example: 40
        currentPage:
          type: integer
          description: Displays the current page number.
          example: 11
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: '29235480'
        userId:
          type: string
          description: Displays the unique internal Site ID.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays order status as ship.
          example: ship
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            reason:
              type: string
              description: >-
                Displays the reason for the activity. This may be a standardized
                selection from common reasons or a free-text explanation for the
                activity.
              example: NA
            createDate:
              type: string
              description: >-
                Displays the date when the transaction occurred in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-05-19T00:00:00+0000
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductStatus:
                  type: object
                  description: Displays the product status for the created product.
                  properties:
                    hold:
                      type: integer
                      description: Displays the number of points on hold against the order.
                      example: 20
                    ship:
                      type: integer
                      description: Displays the number of products that have been shipped.
                      example: 10
                    return:
                      type: integer
                      description: Displays the number of products that have been returned.
                      example: 0
                    cancel:
                      type: integer
                      description: >-
                        Displays the number of products that have been
                        cancelled.
                      example: 0
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
    patchupdatetransactionasfullcancelresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays the order status as Full Cancel.
          example: Full Cancel
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
    patchupdatetransactionasfullshipresp:
      type: object
      properties:
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: 12345
        actionId:
          type: integer
          description: >-
            Displays the unique action ID for the action established in the
            loyalty program.
          example: 174
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: Web
        coupon:
          type: string
          description: Displays the name of a coupon, if a coupon was applied on the order.
          example: acdb2344
        orderTotalSpend:
          type: integer
          description: Displays the total amount spent on the order.
          example: 100
        orderTotalPoints:
          type: integer
          description: >-
            Displays the total number of points awarded to the member for a
            specific order.
          example: 500
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 500
        pointsExpirationDate:
          type: string
          description: >-
            Displays the date on which the points are set to expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2025-11-15T02:06:35+0000
        orderDiscountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 50
        orderStatus:
          type: string
          description: Displays the order status as Full Ship.
          example: Full Ship
        pointType:
          type: string
          description: Displays the Point Type.
          example: Regular
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd format.
          example: '2024-06-19'
        orderShipDate:
          type: string
          description: Displays the date the product will be shipped in yyyy-MM-dd format.
          example: '2024-06-19'
        storeDetails:
          type: object
          description: >-
            Store details will return the store name, and store attributes as
            well. The store attributes may vary store by store based on the
            attributes defined.
          properties:
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
            productDetail:
              type: object
              description: Displays the following parameters.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: P1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: iPad
                productQuantity:
                  type: integer
                  description: Displays the quantity of the product purchased in the order.
                  example: 2
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productDiscountAmount:
                  type: integer
                  description: Displays the total discount amount applied to the order.
                  example: 100
                productCouponCode:
                  type: string
                  description: >-
                    Displays the name of a product coupon code, if a code was
                    applied on the order.
                  example: abcd2344
                productTotalAmount:
                  type: integer
                  description: Displays the total amount spent on the order.
                  example: 500
                productTotalPoints:
                  type: integer
                  description: Displays the number of points the member earns.
                  example: 200
                productDescription:
                  type: string
                  description: Displays the product information.
                  example: iPad came with p10 chip and one week battery support.
                productShipDate:
                  type: string
                  description: >-
                    Displays the ship date the product will be shipped in
                    yyyy-MM-dd format.
                  example: '2023-12-11'
                issuanceProductAttribute:
                  type: object
                  description: Displays the product attributes for the created product.
                  properties:
                    issuanceOrderAttribute:
                      type: object
                      description: >-
                        Displays the order attribute which passes values while
                        creating the order.
                      properties:
                        attribute:
                          description: Enter attribute name and value information.
                          example: Quantity
                          type: string
    postgroupHMresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        groupName:
          type: string
          description: >-
            Displays the group name provided by the group owner while creating
            the group.
          example: Loyalty Circle
        groupAvailablePoints:
          type: string
          description: Displays the total available points for the group.
          example: 500
        totalMembers:
          type: integer
          description: Displays the total number of members in the group.
          example: 12
        createDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the group was created.
          example: 2024-07-05T14:58:04+0000
        groupMembers:
          type: object
          description: Displays the following details of the group member.
          properties:
            memberId:
              type: string
              description: Displays the unique ID of the group member.
              example: b.sa113@gmail.com
            firstName:
              type: string
              description: Displays the first name of the group member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the group member.
              example: Deo
            emailAddress:
              type: string
              description: Displays the email address of the group member.
              example: b.sa113@gmail.com
            userRole:
              type: string
              description: >-
                Displays the group member's role as defined by the group owner.
                There are two roles- Owner and Member.
              example: Owner
            status:
              type: string
              description: >-
                Displays whether the member has been added to the group. Shows
                "Success" if the member has been added, otherwise "Failed."
              example: Success
            invitedBy:
              type: string
              description: >-
                Displays the email address of the group owner who invited the
                loyalty member to join.
              example: b.sa113@gmail.com
            invitationStatus:
              type: string
              description: Displays the invitation status as either Invite Sent or Failed.
              example: Failed
            message:
              type: string
              description: >-
                Displays whether the member exists or not and if the invitation
                was successfully sent when adding members to the group. For
                example, if the invitation to join the group is sent
                successfully, the system displays Invitation to join the group
                sent successfully.
              example: Invitation to join the group sent successfully.
    getgroupgroupidHMresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        groupName:
          type: string
          description: >-
            Displays the group name provided by the group owner while creating
            the group.
          example: Loyalty Circle
        groupAvailablePoints:
          type: integer
          description: Displays the total available points for the group.
          example: 500
        groupExpiredPoints:
          type: integer
          description: Displays the total number of points expired for the group.
          example: 10
        groupRedeemedPoints:
          type: integer
          description: Displays the total number of points redeemed by the group.
          example: 100
        totalMembers:
          type: integer
          description: Displays the total number of members in the group.
          example: 12
        groupStatus:
          type: string
          description: Displays the group status as ACTIVE, INACTIVE or DELETED.
          example: ACTIVE
        createDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the group was created.
          example: 2024-07-05T14:58:04+0000
        updateDate:
          type: string
          description: >-
            Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on which
            the group was updated.
          example: 2024-05-01T14:58:04+0000
        groupMembers:
          type: object
          description: Displays the following details of the group member.
          properties:
            memberId:
              type: string
              description: Displays the unique ID of the group member.
              example: b.sa113@gmail.com
            firstName:
              type: string
              description: Displays the first name of the group member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the group member.
              example: Deo
            emailAddress:
              type: string
              description: Displays the email address of the group member.
              example: b.sa113@gmail.com
            userRole:
              type: string
              description: >-
                Displays the group member's role as defined by the group owner.
                There are two roles- Owner and Member.
              example: Owner
    patchgroupgroupidHMresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        groupName:
          type: string
          description: Displays the name of the group for which you updated the details.
          example: Loyalty Circle
        groupStatus:
          type: string
          description: Displays whether the group is currently ACTIVE or INACTIVE.
          example: ACTIVE
        updatedBy:
          type: string
          description: Displays the ID of the group owner who updated the group details.
          example: b.sa70@gmail.com
        groupConfigurations:
          type: object
          description: >-
            Displays the following values of the configurations you have passed
            in the request body.
          properties:
            allowAutoTransferPointsToGroup:
              type: string
              description: >-
                Displays whether the value you entered in the request body is
                YES or NO.
              example: 'NO'
            allowGroupPointsRedemption:
              type: string
              description: >-
                Displays the value you entered in the request body for this flag
                as OWNER or ALL. The group owner has the authority to set a rule
                for redeeming group points. There are only two options- 1. If
                the owner selects OWNER, only the group owner is eligible to
                redeem group points. 2. If the owner selects ALL, all the group
                members are eligible to redeem group points.
              example: OWNER
    getgroupinviteemailidHMresp:
      type: object
      properties:
        id:
          type: string
          description: >-
            Displays the ID of the loyalty member for whom you would like to
            view the invitation details.
          example: b.sa70@gmail.com
        invitedMemberDetails:
          type: object
          description: Displays details for invitations sent by the member.
          properties:
            groupId:
              type: string
              description: Displays the unique group ID generated during group creation.
              example: '91'
            groupName:
              type: string
              description: >-
                Displays the group name provided by the group owner while
                creating the group.
              example: Loyalty Circle
            inviteSendToId:
              type: string
              description: >-
                Displays the ID of the loyalty member to whom the invitation was
                sent.
              example: b.sa41@gmail.com
            inviteSendToEmail:
              type: string
              description: >-
                Displays the email address of the loyalty member to whom
                invitation was sent.
              example: b.sa40@gmail.com
            inviteSendToFirstName:
              type: string
              description: >-
                Displays the first name of the loyalty member to whom invitation
                was sent.
              example: John
            inviteSendToLastName:
              type: string
              description: >-
                Displays the last name of the loyalty member to whom invitation
                was sent.
              example: Dee
            userRole:
              type: string
              description: >-
                Displays the role of the loyalty member. The role of each group
                member is determined by the group owner. There are two roles -
                Owner and Member.
              example: Owner
            inviteStatus:
              type: string
              description: >-
                Displays the invite status as Invite Sent, Invite Received,
                Accepted, or Declined.
              example: Invite Sent
            invitationReceivedDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the member sent the request to join.
              example: 2024-07-05T10:21:15+0000
        groupInvitationDetails:
          type: object
          description: Displays details for invitations received by the member.
          properties:
            groupId:
              type: string
              description: Displays the unique group ID generated during group creation.
              example: '91'
            groupName:
              type: string
              description: >-
                Displays the group name provided by the group owner while
                creating the group.
              example: Loyalty Circle
            inviteSendById:
              type: string
              description: >-
                Displays the ID of the group owner who requested the loyalty
                member to join.
              example: b.sa130@gmail.com
            inviteSendByEmail:
              type: string
              description: Displays the email address of the group owner.
              example: b.sa130@gmail.com
            inviteSendByFirstName:
              type: string
              description: Displays the first name of the group owner.
              example: Devid
            inviteSendByLastName:
              type: string
              description: Displays the last name of the group owner.
              example: Lee
            userRole:
              type: string
              description: >-
                Displays the role of the group owner. The role of each group
                member is determined by the group owner. There are two roles-
                Owner and Member.
              example: Owner
            inviteStatus:
              type: string
              description: >-
                Displays the invite status as Invite Sent, Invite Received,
                Accepted, or Declined.
              example: Invite Sent
            invitationReceivedDate:
              type: string
              description: >-
                Displays the date and time in the format yyyy-MM-dd'T'HH:mm:ssZ
                when the loyalty member received the invitation to join the
                group.
              example: 2024-07-05T10:21:15+0000
        pages:
          type: integer
          description: >-
            Displays the total number of pages linked to the member's invitation
            and their respective details.
          example: 10
        currentPage:
          type: integer
          description: Displays the current page number.
          example: 1
        totalMemberCount:
          type: integer
          description: >-
            Displays the total number of members to whom invitations were sent
            by the group member.
          example: 15
    patchgroupinviteemailidHMresp:
      type: object
      properties:
        id:
          type: string
          description: >-
            Displays the ID of the group owner who invited loyalty members to
            join the group.
          example: b.sa35@gmail.com
        invitedMemberDetails:
          type: object
          description: Displays the following details.
          properties:
            groupId:
              type: string
              description: >-
                Displays the group ID to which the loyalty member either joined
                or declined the invitation.
              example: '91'
            inviteSentBy:
              type: string
              description: >-
                Displays the ID of the group owner who sent the invitation to
                join the group.
              example: b.sa40@gmail.com
            inviteStatus:
              type: string
              description: Displays the invitation status as Accepted or Declined.
              example: Accepted
            message:
              type: string
              description: >-
                Displays the message indicating whether the member accepted or
                declined the group invitation. If the member accepts the
                invitation, displays Member is added to the group successfully.
                If the member declines the invitation, displays Invitation
                declined successfully.
              example: The member is added to the group successfully.
    postgroupinviteHMresp:
      type: object
      properties:
        id:
          type: string
          description: >-
            Displays the ID of the group owner who invited loyalty members to
            join the group.
          example: b.sa35@gmail.com
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        addedMembers:
          type: object
          description: >-
            Displays the following details of the loyalty member to whom an
            invitation was sent.
          properties:
            memberId:
              type: string
              description: Displays the ID of the loyalty member.
              example: b.sa41@gmail.com
            userRole:
              type: string
              description: >-
                Displays the group member's role as defined by the group owner.
                There are two roles- Owner and Member.
              example: Owner
            status:
              type: string
              description: >-
                Displays as Success if the group joining invitation is sent
                successfully to the loyalty member otherwise Failed.
              example: Success
            message:
              type: string
              description: >-
                Displays whether the invitation was successfully sent to the
                loyalty member or not. The group owner can customize the details
                when sending a request.
              example: Invitation to join the group sent successfully.
    patchgroupleaveemailidHMresp:
      type: object
      properties:
        id:
          type: string
          description: Displays the ID of the loyalty member who left the group.
          example: b.sa35@gmail.com
        groupId:
          type: string
          description: Displays the ID of the group from which the group member has left.
          example: '91'
        message:
          type: string
          description: >-
            Displays the status of the member in the group in relation to them
            leaving.
          example: Left the group successfully
    putgroupremoveemailidHMresp:
      type: object
      properties:
        id:
          type: string
          description: Displays the ID of the group member whose role has been updated.
          example: b.sa132@gmail.com
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        removedMembers:
          type: object
          description: Displays the details of the group members who were removed.
          properties:
            memberId:
              type: string
              description: >-
                Displays the ID of the group members who were removed from the
                group.
              example: b.sa42@gmail.com, b.sa110@gmail.com
            message:
              type: string
              description: >-
                Displays the success or failure message of the member's removal
                from the group.
              example: Member removed successfully
    patchgrouproleemailidHMresp:
      type: object
      properties:
        memberId:
          type: string
          description: Displays the ID of the group member whose role has been updated.
          example: b.sa132@gmail.com
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        groupOwner:
          type: string
          description: Displays the ID of the group owner.
          example: b.sa42@gmail.com
        updatedUserRole:
          type: string
          description: >-
            Displays the member's new role. There are two roles- Owner and
            Member.
          example: Owner
    getgroupgroupidactivityHMresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: '29235480'
        groupId:
          type: string
          description: Displays the unique group ID generated during group creation.
          example: '91'
        groupStatus:
          type: string
          description: Displays the group status as ACTIVE, INACTIVE or DELETED.
          example: ACTIVE
        groupAvailablePoints:
          type: integer
          description: Displays the total available points for the group.
          example: 885
        groupExpiredPoints:
          type: integer
          description: Displays the total number of points expired for the group.
          example: 10
        groupRedeemedPoints:
          type: integer
          description: Displays the total number of points redeemed by the group.
          example: 100
        totalActivityCount:
          type: integer
          description: Displays the total number of activities carried out by the group.
          example: 20
        groupActivity:
          type: object
          description: Displays the following details about the group.
          properties:
            actionId:
              type: string
              description: >-
                Displays the action ID that the group member used to perform the
                activity.
              example: 109
            activityId:
              type: string
              description: >-
                Displays the unique identifier for a specific activity within
                the group. This activityId is used to track and reference
                individual activities associated with the given groupId,
                enabling the retrieval of detailed activity information.
              example: 550e8400-e29b-41d4-a716-446655440000
            memberId:
              type: string
              description: Displays the ID of the group member who performed the activity.
              example: b.sa42@gmail.com
            emailAddress:
              type: string
              description: Displays the email address of the group member.
              example: b.sa42@gmail.com
            firstName:
              type: string
              description: Displays the first name of the group member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the group member.
              example: Dee
            referenceId:
              type: string
              description: Displays the unique reference ID generated during the activity.
              example: 23456
            activity:
              type: string
              description: >-
                Displays the name of the activity performed by the member. It
                can be credit or debit.
              example: CREDIT
            groupCredit:
              type: integer
              description: >-
                Displays the points credited to the group due to member’s
                activity.
              example: 100
            groupDebit:
              type: integer
              description: >-
                Displays the points debited from the group due to member’s
                activity.
              example: 10
            pointStatus:
              type: string
              description: Displays the points status as either released or on hold.
              example: Released
            pointType:
              type: string
              description: Displays the point type as standard or promotional.
              example: Standard
            reason:
              type: string
              description: Displays the reason for awarding or deducting group points.
              example: Added a member to the group
            displayText:
              type: string
              description: Displays action name used while doing the activity.
              example: 109
            orderId:
              type: string
              description: Displays the unique ID of the order.
              example: AC_Order-1727776539942
            source:
              type: string
              description: >-
                Displays the source of where the order was placed by the group
                member, such as web or store.
              example: Online
            createDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the activity was performed by the group members.
              example: 2024-07-01T16:26:12+0000
            expireDate:
              type: string
              description: >-
                Displays the date on which the group points will expire in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-11-01T16:26:12+0000
            coupon:
              type: string
              description: Displays the coupon code, if a code was applied on the order.
              example: AZSDXRDS
            orderTotalSpend:
              type: integer
              description: Displays the total amount spent on the order.
              example: 240
            orderTotalPoints:
              type: integer
              description: Displays the total points earned when placing the order.
              example: 10
            orderDiscountAmount:
              type: integer
              description: Displays the total discount amount for the placed order.
              example: 20
            orderStatus:
              type: string
              description: Displays the order status as Ship, Return or Cancel.
              example: Ship
            orderDate:
              type: string
              description: Displays the order date in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-01T00:00:00-0700
            orderShipDate:
              type: string
              description: Displays the order ship date in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-05T00:00:00-0700
            senderData:
              type: object
              description: >-
                Displays detailed information about the sender. (If points were
                shared between group members).
              properties:
                senderId:
                  type: string
                  description: >-
                    Displays the unique identifier of the sender belonging to
                    the group.
                  example: xyz@annexcloud.com
                senderName:
                  type: string
                  description: Displays the name of the sender belonging to the group.
                  example: Vin Smith
            receiverData:
              type: object
              description: >-
                Displays detailed information about the recipient.  (If points
                were shared between group members)
              properties:
                receiverId:
                  type: string
                  description: >-
                    Displays the unique identifier of the recipient belonging to
                    the group.
                  example: xyz@annexcloud.com
                receiverName:
                  type: string
                  description: Displays the name of the recipient belonging to the group.
                  example: Vin Smith
            storeDetails:
              type: object
              description: >-
                Displays the following details of the store from where the order
                was placed.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique numerical code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the particular store.
                  example: Mobile galaxy
                storeDetails:
                  type: object
                  description: Displays the attribute details associated with the store.
            productDetails:
              type: object
              description: Displays the following details about the product.
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: MP21
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: OnePlus
                productQuantity:
                  type: integer
                  description: Displays the number of units of the product purchased.
                  example: 2
                productPrice:
                  type: string
                  description: Displays the unit price for the product.
                  example: 105
                productDiscountAmount:
                  type: string
                  description: Displays the total discount amount for the placed order.
                  example: 0
                productCouponCode:
                  type: string
                  description: >-
                    Displays the coupon code if a code was applied to the
                    product purchase.
                  example: KKSADTYZ
                productTotalAmount:
                  type: string
                  description: Displays the total amount spent on the product purchase.
                  example: 210
                productTotalPoints:
                  type: string
                  description: >-
                    Displays the total points accumulated through product
                    purchases.
                  example: 10
                productDescription:
                  type: string
                  description: Displays a brief description of the product.
                  example: OnePlus 12R Cool Dune, 256 GB
                productShipDate:
                  type: string
                  description: >-
                    Displays the product shipped date in yyyy-MM-dd'T'HH:mm:ssZ
                    format.
                  example: 2024-04-05T00:00:00-0700
                issuanceProductStatus:
                  type: object
                  description: Displays the following status of the product.
                  properties:
                    hold:
                      type: string
                      description: Displays the number of products put on hold.
                      example: 0
                    ship:
                      type: string
                      description: Displays the number of products shipped.
                      example: 2
                    return:
                      type: string
                      description: Displays the number of products returned.
                      example: 1
                    cancel:
                      type: string
                      description: Displays the number of products cancelled.
                      example: 4
            pages:
              type: integer
              description: >-
                Displays the total number of pages associated with the
                activities.
              example: 10
            currentPage:
              type: integer
              description: Displays the current page number.
              example: 1
    getpointsexpirygroupgroupidHMresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: 146031180
        groupId:
          type: string
          description: Displays the unique identifier for the group.
          example: '91'
        expiryDetail:
          type: object
          description: Displays the point expiration details for the group.
          properties:
            date:
              type: string
              description: >-
                Displays the time block for which point expiration data has been
                aggregated based on the aggregate_by value in the
                yyyy-mm-dd’T”HH:mm:ssZ format.
              example: 2024-04-18T06:02:06+0000
        pointsActivity:
          type: object
          description: Displays the details of points activity within the time block.
          properties:
            points:
              type: integer
              description: >-
                Displays the number of points that expired within the time block
                for the group.
              example: 35
            expiryDate:
              type: string
              description: >-
                Displays the date on which the points will expire in the
                yyyy-mm-dd’T”HH:mm:ssZ format.
              example: 2024-04-18T06:02:06+0000
            totalPointsToExpire:
              type: integer
              description: >-
                Displays the total number of points next to expire within the
                selected date range.
              example: 25
            totalPointsExpired:
              type: integer
              description: >-
                Displays the total number of expired points for the group in the
                selected date range. The total number of points that have
                expired are calculated based on two Action IDs (106 and 192).
              example: 35
        pages:
          type: integer
          description: >-
            Displays the total number of pages for the group’s point expiration
            details in the response.
          example: 1
        currentPage:
          type: integer
          description: >-
            Displays the current page number for the fetched group details in
            the response.
          example: 1
        totalExpiryDetailCount:
          type: integer
          description: Displays the total count of point expiration records for the group.
          example: 5
    postusedrewards:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud site ID for the loyalty program.
          example: 146031180
        id:
          type: string
          description: >-
            Displays the unique member ID from whose account points were
            debited.
          example: John.j45@gmail.com
        rewardId:
          type: integer
          description: Displays the reward ID which was applied during the debit action.
          example: 650790
        orderId:
          type: string
          description: Displays the loyalty member's unique order ID.
          example: 12132ab
        actionId:
          type: integer
          description: >-
            Displays the unique action ID against which points were debited from
            the member’s account.
          example: 109
        activity:
          type: string
          description: Displays the activity’s name as credit or debit.
          example: Debit
        debit:
          type: integer
          description: Displays the number of points debited from the member’s account.
          example: 100
        rewardCode:
          type: string
          description: Displays the reward code used by the member.
          example: AP232
        pointsDeducted:
          type: integer
          description: Displays the number of points deducted from the member's account.
          example: 100
        source:
          type: string
          description: Displays the source from where the reward code was shared.
          example: website
        actionAttribute:
          $ref: '#/components/schemas/actionAttributepostusedrewards'
    actionAttributepostusedrewards:
      type: object
      description: >-
        Action attributes allow you to capture additional metadata about an
        action. If configured, the following data will be displayed. Note -This
        information will only be displayed if the Validate Extended Attribute
        Values flag is enabled in the action rules.
      properties:
        device:
          type: string
          description: >-
            Displays the name of the device on which debit action was be
            performed. This can be customized as per the client's request.
          example: Mobile
    getRewardsBySite:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud site ID for the loyalty program.
          example: 146031180
        rewardDetail:
          $ref: '#/components/schemas/getRewardsBySite_rewardDetail'
    getRewardsBySite_rewardDetail:
      type: object
      properties:
        rewardId:
          type: integer
          description: Displays the unique ID of the reward used by the member.
          example: 650767
        rewardName:
          type: string
          description: Displays the name of the reward used by the member.
          example: Jockey $15.00 off purchase
        rewardType:
          type: string
          description: >-
            Displays the nature of the reward, making it easier for members and
            administrators to understand its purpose or value when interacting
            with the system. Note - This field is solely intended for display
            purposes within the API and does not influence its functionality,
            regardless of the value provided. Annex Cloud does not perform
            validation on the entered values, meaning that the system will
            accept and displays the input exactly as it is submitted, without
            modification or checks for accuracy.
          example: Gift Card
        rewardTerms:
          type: string
          description: Displays the terms and conditions for the reward.
          example: >-
            Points can be redeemed for rewards according to the current
            redemption schedule. Rewards may include discounts, merchandise, or
            other specified offers. Rewards are subject to availability and may
            be changed or discontinued at any time without notice. By
            participating in the Loyalty Program, you acknowledge that you have
            read, understood, and agree to abide by these terms and conditions.
        rewardDescription:
          type: string
          description: Displays the additional information related to the reward.
          example: Get 25% off your first product purchase.
        yearSelected:
          type: integer
          description: >-
            Displays the year in which loyalty members are eligible to redeem
            the reward (if defined upon award configuration).
          example: 2022
        period:
          type: string
          description: >-
            Displays the period that the reward is available to eligible
            members. For example, monthly, quarterly, half-yearly or annually.
          example: Monthly
        periodDetails:
          type: string
          description: >-
            Displays the month, quarter, or year in which the reward can be
            claimed based on the period defined upon configuration.
          example: January
        rewardLimit:
          type: integer
          description: >-
            Displays the limit for how many times a member can claim the reward.
            For example, If the maximum user claim count is set to five, the
            reward could be claimed only five times. If the maximum user claim
            count is set to zero, there is no restriction on claiming rewards
            based on availability.
          example: 3
        limitPeriod:
          type: string
          description: >-
            Displays the length of time the reward claim limit is in place. For
            example, if the claim limit was set to 4 and the limit period is
            “lifetime”, the member can only claim this reward 4 times in their
            lifetime with the loyalty program.
          example: Lifetime
        creditRequired:
          type: integer
          description: Displays the points required to redeem the reward.
          example: 200
        rewardStatus:
          type: integer
          description: Displays 1 if the reward status is active, otherwise it displays 0.
          example: 1
        rewardCategoryId:
          type: integer
          description: Displays the reward category ID. It is auto generated by the system.
          example: 843462
        rewardUrl:
          type: string
          description: >-
            Displays the url for the reward page where the member can claim this
            reward.
          example: https://winteroffer.com
        rewardImageUrl:
          type: string
          description: >-
            Displays the reward image URL.[Note -string If enable rewards
            multiple images upload flag is active then this will appear as an
            object.][Note - The image value is in base64 encoded format. For
            example,
            aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==]
          example: https://image.winteroffer.com
        defaultThumbnailImageURL:
          type: string
          description: >-
            Displays the thumbnail image for the reward. Note - The image value
            is in base64 encoded format. For example,
            aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==
          example: https://image.winteroffer.com
        videoImageURL:
          type: string
          description: Displays the URL for the video image associated with the reward.
          example: https://videoimagewinteroffer.com
        deductAmount:
          type: integer
          description: >-
            Displays the monetary value of the reward to be applied to the order
            as a discount.
          example: 50
        rewardCurrency:
          type: string
          description: Displays the reward currency.
          example: USD
        productId:
          type: string
          description: Displays the product ID for the product associated with the reward.
          example: p567
        rewardCategoryName:
          type: string
          description: >-
            Displays the reward category name as defined when configuring the
            reward in the Annex Cloud platform.
          example: Beauty products
        rewardSequence:
          type: integer
          description: >-
            Displays the sequence number for the current reward established upon
            reward configuration. This is applicable when there is more than one
            reward and indicates the order the rewards are displayed to members.
          example: 2
        creditsToCurrencyRatio:
          type: string
          description: >-
            Displays the credits to currency ratio defined by the admin.
            Multiplying this ratio by the member's available points results in
            total currency values of the available points.
          example: 0.25
        autoRewardStatus:
          type: string
          description: >-
            Displays whether the automate reward flag is enabled within the
            reward’s additional settings. If it is enabled, the response will
            display as YES. If it is not enabled, the response will be NO. If
            the flag is turned on, the following parameters will also appear.
          example: 'YES'
        autoRewardBasedOn:
          type: string
          description: >-
            Displays what criteria the automated reward is based on- Purchase
            Amount or Lifetime Points.
          example: Lifetime Points
        autoRewardClaimThresholdType:
          type: string
          description: >-
            Displays the threshold type to claim the reward automatically. It
            can be either rolling or fixed.
          example: Rolling
        autoRewardClaimThresholdValue:
          type: integer
          description: >-
            Displays the number of points or spend amount required by the member
            to claim the reward automatically.
          example: 1000
        autoRewardClaimLimit:
          type: integer
          description: >-
            Displays the number of times the reward can be claimed
            automatically.
          example: 5
        autoRewardClaimReason:
          type: string
          description: Displays the reason the member can claim the reward automatically.
          example: Auto Voucher claimed
        timeBasedIssuanceFlag:
          type: string
          description: >-
            Displays the status of the flag as ON or OFF. YES, indicates that
            the flag is ON and NO indicates that it is off. This feature allows
            the admin to award the reward automatically at a scheduled time.
          example: 'YES'
        timeBasedIssuanceDate:
          type: string
          description: Displays the time at which the reward is awarded to the member.
          example: '2023-06-21'
        rewardEligibilityType:
          type: string
          description: Displays the type of reward eligibility as fixed or recurring.
          example: Fixed
        rewardEligibilityBasedOn:
          type: string
          description: >-
            Displays the eligibility criteria based on which the member can
            qualify for the reward. If reward eligibility type is “Fixed”, the
            member’s eligibility will be based on lifetime points, purchase
            amount, segment, or tier. If reward eligibility type is “Recurring”,
            the member’s eligibility will be based on earned points in a
            calendar year.
          example: Lifetime Points
        rewardEligibilityThreshold:
          type: integer
          description: >-
            Displays the number of points earned or amount to be spent by the
            member to qualify for the reward. (If eligibility is based on points
            earned or amount spent)
          example: 400
        eligibleSegmentId:
          type: integer
          description: >-
            Displays the segment ID for the segment of users eligible for the
            reward.
          example: 4567
        tierData:
          type: object
          properties:
            tierId:
              type: integer
              description: Displays the unique tier ID.
              example: 1592
            tierName:
              type: string
              description: >-
                Displays the name of the tier which the member must be a part of
                to redeem the reward if reward eligibility is based on tier.
              example: Silver
            tierEligible:
              type: string
              description: >-
                Displays YES if the member satisfies the tier criteria otherwise
                NO.
              example: 'YES'
            rewardLimit:
              type: integer
              description: >-
                Displays the limit for how many times a member can claim the
                reward. For example, If the maximum user claim count is set to
                five, the reward could be claimed only five times. If the
                maximum user claim count is set to zero, there is no restriction
                on claiming rewards based on availability.
              example: 10
            limitPeriod:
              type: string
              description: >-
                Displays the length of time the reward claim limit is in
                place.For example, if the claim limit was set to 4 and the limit
                period is “lifetime”, the member can only claim this reward 4
                times in their lifetime with the loyalty program.
              example: Lifetime
        createDate:
          type: string
          description: >-
            Displays the date and time the reward was created in
            yyyy-MM-dd’T’HH:mm:ssZ format.
          example: 2021-08-08T07:00:12+0000
        updateDate:
          type: string
          description: >-
            Displays the date when the reward was last updated in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2021-08-08T07:00:12+0000
        rewardExpirationType:
          type: string
          description: Displays the reward expiration type as rolling or calendar.
          example: Rolling
        rewardExpirationPeriod:
          type: string
          description: >-
            Displays the time after which the reward expires in days, months, or
            years. If ‘Rolling’ is selected, the result appears in days, whereas
            ‘Calendar’ shows the result in a date range.
          example: 2 days
        overallRewardLimit:
          type: integer
          description: >-
            Displays the maximum number of times the reward can be claimed in
            total. For example, if the limit is 50, once the reward has been
            claimed 50 times by any member or group of members, the reward can
            no longer be claimed.
          example: 50
        overallClaimCount:
          type: integer
          description: Displays the number of times the reward has been claimed by members.
          example: 20
        rewardBalanceQuantity:
          type: integer
          description: >-
            Displays the remaining number of times the reward can be claimed by
            the member.
          example: 30
    rewardlistrewardidrewardidresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud site ID for the loyalty program.
          example: '29235480'
        rewardDetail:
          type: object
          description: >-
            Displays the following details of the parameters associated with a
            reward.
          properties:
            rewardId:
              type: string
              description: Displays the unique ID of the reward used by the member.
              example: '650767'
            rewardName:
              type: string
              description: Displays the name of the reward used by the member.
              example: Jockey $15.00 off purchase
            rewardType:
              type: string
              description: >-
                Displays the nature of the reward, making it easier for members
                and administrators to understand its purpose or value when
                interacting with the system. Note - This field is solely
                intended for display purposes within the API and does not
                influence its functionality, regardless of the value provided.
                Annex Cloud does not perform validation on the entered values,
                meaning that the system will accept and displays the input
                exactly as it is submitted, without modification or checks for
                accuracy.
              example: Gift Card
            rewardTerms:
              type: string
              description: Displays the terms and conditions for the reward.
              example: >-
                Points can be redeemed for rewards according to the current
                redemption schedule. Rewards may include discounts, merchandise,
                or other specified offers. Rewards are subject to availability
                and may be changed or discontinued at any time without notice.
                By participating in the Loyalty Program, you acknowledge that
                you have read, understood, and agree to abide by these terms and
                conditions.
            rewardDescription:
              type: string
              description: Displays the additional information related to the reward.
              example: Update your date of birth and get 2x points
            overallRewardLimit:
              type: integer
              description: Displays the number of times a reward can be used.
              example: 5
            overallClaimCount:
              type: integer
              description: >-
                Displays the number of times the rewards have been used by the
                member per week/months or year.
              example: 2
            yearSelected:
              type: integer
              description: >-
                Displays the year in which loyalty members are eligible to
                redeem the reward.
              example: 2022
            period:
              type: string
              description: >-
                Displays the period that the reward is available to eligible
                members. For example, monthly, quarterly, half-yearly, or
                annually.
              example: Monthly
            periodDetails:
              type: string
              description: >-
                Displays the month, quarter, or year in which the reward can be
                claimed. This depends on the period selection. If you change the
                period selection, the period details change automatically. For
                example, if you choose the period as "monthly," a list of all
                the months is displayed, and you need to select one from the
                list. On the other hand, if you select the period as
                "quarterly," you will have the option to choose from the first,
                second, third, or fourth quarter in the period details.
              example: January
            rewardLimit:
              type: integer
              description: >-
                Displays the reward limit that can be claimed by a member. If
                the reward limit is set to five, the reward could be claimed
                only five times. If the reward limit is set to zero, there is no
                restriction on claiming rewards based on availability.
              example: 3
            limitPeriod:
              type: integer
              description: >-
                Displays the time after which the reward expires in days,
                months, or years.
              example: 5 days
            creditRequired:
              type: integer
              description: Displays the points required to redeem the reward.
              example: 200
            rewardStatus:
              type: string
              description: Displays the reward status as active or inactive.
              example: Active
            rewardCategoryId:
              type: string
              description: Displays the reward Category ID.
              example: bgd56tg
            rewardUrl:
              type: string
              description: >-
                Displays the reward url to claim reward benefits. You will be
                directed to the reward page after clicking the url.
              example: https://winteroffer.com
            rewardImageUrl:
              type: string
              description: >-
                Displays the reward image url. Note - The image value is in
                base64 encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==.
                Note - If enable rewards multiple images upload flag is active
                then object.
              example: https://image.winteroffer.com
            defaultThumbnailImageURL:
              type: string
              description: >-
                Displays the thumbnail image of the reward. Note - The image
                value is in base64 encoded format. For example,
                aHR0cHM6Ly93d3cuc29jaWFsYW5uZXguY29tL3B1YmxpYy9tYW5hZ2VvcHRpb25zZGVzaWduMTYvaW1hZ2VzL3Byb2R1Y3RfbGFuZGluZy9sb3lhbHR5LWhvdmVyLnBuZw==.
              example: https://image.winterofferthumbnail.com
            deductAmount:
              type: integer
              description: >-
                Displays the monetary value of the reward to be applied to the
                order as a discount. This value can be configured by the
                administrator at the time of configuring the reward.
              example: 50
            rewardCurrency:
              type: string
              description: >-
                Displays the reward currency. This can be configured by the
                administrator while creating the reward.
              example: USD
            productId:
              type: string
              description: Displays the product ID associated with the product.
              example: p567
            rewardCategoryName:
              type: string
              description: >-
                Displays the reward category name as provided while creating the
                reward category type on the Annex Cloud Products > Rewards >
                Rewards Category page. This is used to group the reward as they
                are created.
              example: Winter Offer
            rewardSequence:
              type: string
              description: >-
                Displays the sequence number for the current reward established
                upon reward configuration. This is applicable when there is more
                than one reward and indicates the order the rewards are
                displayed to members.
              example: 2
            rewardEligibilityType:
              type: string
              description: Displays the type of reward eligibility as fixed or recurring.
              example: Fixed
            rewardEligibilityBasedOn:
              type: string
              description: >-
                Displays the eligibility criteria based on which the member
                achieved the reward. If reward eligibility type is selected as
                fixed from the drop-down, the member's eligibility for the
                rewards will be based on lifetime points, purchase amount,
                segment, or tier. If reward eligibility type is selected as
                recurring from the drop-down, the member's eligibility for the
                rewards will be based on earned points in a calendar year.
              example: Lifetime Points
            rewardEligibilityThreshold:
              type: integer
              description: >-
                Displays the number of points earned or the amount to be spent
                by the member to qualify for the reward. (If eligibility is
                based on points earned or amount spent)
              example: 400
            eligibileSegmentId:
              type: integer
              description: >-
                Displays the ID of the segment members must belong to to claim
                the reward. This segment ID is auto-generated by the system.
              example: 4567
            creditsToCurrencyRatio:
              type: string
              description: >-
                Displays the credits to currency ratio defined by the admin.
                Multiplying this ratio by the member's available points results
                in total currency values of the available points.
              example: 0.25
            tierData:
              type: object
              description: Display tier data as shown below.
              properties:
                tierId:
                  type: integer
                  description: Displays the system generated unique tier ID.
                  example: 1592
                tierName:
                  type: string
                  description: >-
                    Displays the name of the tier that the member must be a part
                    of to redeem the reward if reward eligibility is based on
                    tier.
                  example: Silver
                tierEligible:
                  type: string
                  description: >-
                    Displays YES if the member satisfies the tier criteria
                    otherwise NO.
                  example: 'YES'
                rewardLimit:
                  type: integer
                  description: >-
                    Displays the limit for how many times a member can claim the
                    reward. For example, If the maximum user claim count is set
                    to five, the reward could be claimed only five times. If the
                    maximum user claim count is set to zero, there is no
                    restriction on claiming rewards based on availability.
                  example: 10
                limitPeriod:
                  type: string
                  description: >-
                    Displays the length of time the reward claim limit is in
                    place. For example, if the claim limit was set to 4 and the
                    limit period is "lifetime", the member can only claim this
                    reward 4 times in their lifetime with the loyalty program.
                  example: Lifetime
            createdate:
              type: string
              description: >-
                Displays the date when the reward is created in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            updateDate:
              type: string
              description: >-
                Displays the date when the reward is updated in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            rewardExpirationType:
              type: string
              description: >-
                Displays the reward expiration type as rolling or calendar. If
                'Rolling' is selected, the result appears in days, whereas
                'Calendar' shows the result in weeks, months, or years.
              example: Rolling
            rewardExpirationStartDate:
              type: string
              description: >-
                In the reward, you have a date range within which it must be
                used to get the benefits. This displays the start date of the
                date range.
              example: 2022-08-01T00:00:00-0700
            rewardExpirationEndDate:
              type: string
              description: >-
                Displays the reward expiration date in yyyy-MM-dd'T'HH:mm:ssZ
                format. Once the reward expiration date is reached, the reward
                is no longer valID.
              example: 2022-12-01T00:00:00-0700
            rewardExpirationPeriod:
              type: string
              description: >-
                Displays the time after which the reward expires in days,
                months, or years.
              example: 2 days
            autoRewardStatus:
              type: string
              description: >-
                Displays whether the auto reward status flag is enabled or
                disabled. If the flag is enabled, it returns YES. If the flag is
                disabled, it returns No.
              example: YES/No
            autoRewardBasedOn:
              type: string
              description: >-
                Displays the criteria based on which rewards are awarded to the
                member. It supports these two criteria. 1. Purchase amount 2.
                Lifetime points
              example: Purchase amount / Lifetime points
            autoRewardClaimThresholdType:
              type: string
              description: >-
                Displays the points threshold type to claim the reward
                automatically. It can be either rolling or fixed. After
                selecting the threshold type as rolling or fixed, you need to
                pass the threshold points.
              example: Rolling
            autoRewardClaimThresholdValue:
              type: integer
              description: >-
                Displays the points required by the member to claim the reward
                automatically.
              example: 1000
            autoRewardClaimLimit:
              type: integer
              description: >-
                Displays the number of times the reward can be claimed
                automatically.
              example: 5
            autoRewardClaimReason:
              type: string
              description: Displays the reason to claim the reward automatically.
              example: Auto Voucher Claimed
        pages:
          type: integer
          description: Displays total number of pages associated with the rewards.
          example: 7
        currentPage:
          type: integer
          description: Displays the current page number of the reward.
          example: 2
    postactionsresp:
      type: object
      properties:
        siteId:
          type: string
          description: >-
            Displays the unique site ID where all the actions have been
            configured.
          example: 100410600
        allActionDetails:
          type: object
          description: >-
            Displays the details of the actions configured.(This gets repeated
            in case of multiple actions.)
          properties:
            actionId:
              type: integer
              description: Displays the unique ID of the action.
              example: 123
            actionName:
              type: string
              description: >-
                Displays the name of the action. (Different names are assigned
                to the actions based on activity linked to it)
              example: lorem
            actionPoints:
              type: integer
              description: >-
                Displays the number of points awarded to a loyalty member for
                performing the action. (The number of points awarded can vary
                depending on the action and the rules of the loyalty program.)
              example: 50
            maxPoints:
              type: integer
              description: >-
                Displays the maximum number of points that are be awarded to a
                loyalty member for performing this action. (The number of points
                awarded can vary depending on the action and the rules of the
                loyalty program.)
              example: 400
            period:
              type: integer
              description: >-
                Displays the period during which a member can accrue points, up
                to the established maximum. Once the designated duration
                expires, the maximum point-earning window resets. This duration
                initiates from the moment of the first action.
              example: 70
            ratio:
              type: integer
              description: >-
                Displays the point ratio set by the administrator that
                determines how points are awarded to a loyalty member for
                performing the action.
              example: 30
            status:
              type: string
              description: Displays the action's status as either "active" or "inactive."
              example: ACTIVE
            expireInDays:
              type: integer
              description: >-
                Displays the number of days after which the action no longer
                awards points for performing the specified action on this
                particular site. We can set expiration rules for the points
                awarded to members based on the action ID. (It essentially
                represents the expiration or validity period for earning points
                based on that action.)
              example: 10
            actionPointsExpirationType:
              type: string
              description: >-
                Displays information about how the points awarded for performing
                various actions by the loyalty member are going to expire. There
                are two options to set how the expiration of action points takes
                place- Rolling- Points earned for the action will expire within
                a set number of days from when the action was completed, and the
                points were earned. Calendar- Points earned for completing the
                action will have an expiration date based on a calendar time
                frame, such as weeks, months, or years.
              example: Rolling
            actionPointsExpireIn:
              type: string
              description: >-
                Displays the expiration date set for the action points awarded
                to the loyalty member. The way it displays depends on whether
                "Rolling" or "Calendar" is selected.
              example: 10 days
            actionPointsExpireValue:
              type: integer
              description: >-
                Displays the set value determining when points will expire. This
                value is dynamic and varies based on the chosen expiration type.
              example: 1
            holdDays:
              type: integer
              description: >-
                Displays the number of days the points awarded to a loyalty
                member for performing a specific action are on hold after the
                action has been completed. (Points put on hold are not
                immediately available for use and have a waiting period before
                they become usable or redeemable by the member.)
              example: 20
            actionNameDisplay:
              type: string
              description: >-
                Displays the name of the action performed by the loyalty member
                as configured. (Different names are assigned to the actions
                based on the activity linked to it)
              example: Purchase
            actionLimitDisplay:
              type: string
              description: >-
                Displays the various limits applied to the action. (Limits can
                be in terms of points, rules, or criteria. These limits are set
                by the administrator based on the requirements)
              example: Once in a week
            actionDescription:
              type: string
              description: >-
                Displays an explanation of how the action functions. It
                typically outlines the specific details and conditions under
                which the action is performed, how points are awarded, and any
                relevant rules or guidelines associated with the action within
                the loyalty program. It typically outlines the specific details
                and conditions under which the action is performed, how points
                are awarded, and any relevant rules or guidelines associated
                with the action within the loyalty program.
              example: Points that a member earns for making a purchase.
            actionActiveUrl:
              type: string
              description: >-
                Displays the web address (URL) of the image that is visible to
                the loyalty member when the action is ACTIVE.
              example: https://www.annexcloud.com/
            actionInactiveUrl:
              type: string
              description: >-
                Displays the web address (URL) of the image that is visible to
                the loyalty member when the action is INACTIVE.
              example: https://www.annexcloud.com/
            actionButtonTitle:
              type: string
              description: >-
                Displays the title assigned to an action button. This title is
                set by the administrator.
              example: Purchase for Points
            actionrRedirecturl:
              type: string
              description: >-
                Displays the web address (URL) for the page that members will be
                redirected to once the action has been completed.
              example: https://www.annexcloud.com/
            actionPointsDisplay:
              type: string
              description: >-
                Displays a visual representation of the number of points
                acquired by a member for performing specific actions. This
                display is highly customizable. For example, if a member earns
                10 points for completing a task, the Action Points Display can
                be configured to present those points in a unique format such as
                "xyz123" instead of the standard numerical representation.
              example: cloud459
            createDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd'T'HH:mm:ssZ format on
                which the action was created.
              example: 2024-08-08T07:00:12+0000
            updateDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd'T'HH:mm:ssZ format on
                which the action was last updated.
              example: 2024-08-08T07:00:12+0000
            actionPerformStatus:
              type: integer
              description: >-
                Displays the current status of the action performed by the
                member. Incomplete (0)- This status indicates that the action
                has not yet been completed by the member. Complete (1)- This
                status indicates that the action has been successfully performed
                and completed by the member.
              example: 0
            requiredCount:
              type: integer
              description: >-
                Displays the number of times a member is required to perform the
                action to earn the associated reward. For example, if a loyalty
                program requires members to make five purchases to earn a
                reward, the "RequiredCount" is 5.
              example: 5
            completedCount:
              type: integer
              description: >-
                Displays the number of times the member has completed the
                action. For example, if a loyalty program requires members to
                make five purchases to earn a reward and a member has already
                made three purchases, the "CompletedCount" is 3.
              example: 3
            pendingCount:
              type: integer
              description: >-
                Displays the remaining number of times the member needs to
                complete the action to earn the reward. For example, if a
                loyalty program requires members to make five purchases to earn
                a reward and a member has made three purchases but hasn't
                completed the remaining two, the "PendingCount" is 2.
              example: 2
            actionLimitReachedFlag:
              type: integer
              description: >-
                Displays whether the loyalty member has reached a predefined
                limit on the number of actions they can perform within the
                loyalty program or campaign. Here, "1" represents that the
                action limit has been reached, while "0" indicates that the
                action limit has not been reached.
              example: 1
            actionLimitReachedStatus:
              type: integer
              description: >-
                Displays the status that indicates whether a loyalty member has
                reached a predefined limit on the number of actions they can
                perform within a loyalty program or campaign. (Here "1"
                indicates that the action limit has been reached (i.e., the
                member cannot perform additional actions), and "0" indicates
                that the action limit has not been reached (i.e., the member can
                still perform more actions).
              example: 0
            isActionInCampaign:
              type: integer
              description: >-
                Displays whether a particular action is part of a campaign or
                not. (Here "1" indicates that the action is part of the
                campaign, and "0" indicates that the action is not part of a
                campaign.)
              example: 1
            campaignDetails:
              type: object
              description: >-
                Displays the following campaign details if an action is included
                in a campaign.
              properties:
                campaignId:
                  type: integer
                  description: >-
                    Displays the unique campaign ID that the action belongs to.
                    (There may be multiple campaigns the action is included in)
                  example: 605
                campaignName:
                  type: string
                  description: >-
                    Displays the unique campaign name that the actions belong to
                    on this particular site.
                  example: Summer Offer
                campaignDateFrom:
                  type: string
                  description: >-
                    Displays the starting date of the campaign in
                    yyyy-MM-dd'T'HH:mm:ss  format.
                  example: '2021-04-01T00:00:00'
                campaignDateTo:
                  type: string
                  description: >-
                    Displays the ending date of the campaign in
                    yyyy-MM-dd'T'HH:mm:ss format.
                  example: '2021-04-01T00:00:00'
                noOfMilestones:
                  type: integer
                  description: >-
                    Displays the total number of milestones that have been
                    created within a specific campaign.
                  example: 5
                linkedMilestone:
                  type: integer
                  description: >-
                    Displays the specific milestone within a campaign that is
                    linked to the action. In a campaign with multiple
                    milestones, each milestone may be linked to specific actions
                    that members need to complete in order to achieve that
                    milestone.
                  example: 3
            milestoneBenefit:
              type: object
              description: Displays the milestone benefit linked to the action.
              properties:
                name:
                  type: string
                  description: >-
                    Displays the name given to the milestone within a campaign.
                    Each milestone is typically assigned a name or label to
                    describe what it represents.
                  example: MS01
                description:
                  type: string
                  description: >-
                    Displays the content that provides additional information
                    about the specific milestone within a campaign. The
                    "milestone description" is used to elaborate on the
                    milestone's purpose, requirements, or significance.
                  example: join benefit.
                type:
                  type: string
                  description: >-
                    Displays the category that the particular milestone falls
                    into within the marketing campaign. Milestones in a campaign
                    can vary in their nature and requirements. Some common types
                    of milestones are- 1.Actions 2.Action Series
                  example: ACTION
                detail:
                  type: string
                  description: >-
                    Displays the specific details regarding the benefits or
                    rewards associated with the milestone in a campaign.
                  example: Opt Out Deduction
                benefitName:
                  type: string
                  description: >-
                    Displays the name given to the benefit associated with the
                    campaign milestone. For example, a milestone benefit name
                    could be "50 Bonus Points," or "10% Discount Coupon."
                  example: Coupon
                benefitValue:
                  type: integer
                  description: >-
                    Displays the specific numerical or qualitative value
                    associated with the benefit provided when the member has
                    completed the campaign milestone. For example- If the
                    benefit is a voucher, the "milestone benefit value" would
                    represent the monetary or discount value of the voucher. If
                    the benefit is a coupon, the "milestone benefit value" would
                    indicate the value of the coupon as an object, which may
                    include discount percentage.
                  example: 200
                benefitActiveImageUrl:
                  type: string
                  description: >-
                    Displays the web address (URL) for the image associated with
                    an active benefit in a loyalty program or campaign. This
                    image is typically displayed to visually represent the
                    benefit awarded.
                  example: https://summer22.activeimage.com
                benefitInactiveImageUrl:
                  type: string
                  description: >-
                    Displays the web address (URL) for the image associated with
                    an inactive benefit in a loyalty program or campaign. This
                    image is typically displayed when the benefit is inactive or
                    not available for use or redemption.
                  example: https://summer22.inactiveimage.com
                benefitRedemptionDate:
                  type: string
                  description: >-
                    Displays the date when the campaign milestone benefit can be
                    redeemed. in yyyy-MM-dd'T'HH:mm:ss format.
                  example: 2024-08-08T07:00:12+0000
            campaignAudience:
              type: object
              description: >-
                Displays the details regarding the audience associated with the
                campaign.
              properties:
                segment:
                  type: string
                  description: >-
                    Displays the segment who are targeted or included in a
                    campaign. Audience segmentation involves dividing a larger
                    target audience into smaller, more defined groups based on
                    certain criteria.
                  example: welcome
                tier:
                  type: string
                  description: >-
                    Displays the name of the tier that is targeted by the
                    marketing campaign.
                  example: Silver
            campaignBenefit:
              type: object
              description: Displays benefit details associated with the campaign.
              properties:
                campaignBenefitType:
                  type: integer
                  description: >-
                    Displays the type of benefit that is offered as part of the
                    campaign. The benefit type can vary depending on the
                    campaign's objectives and the loyalty program's offerings.
                  example: 3
                campaignBenefitName:
                  type: string
                  description: Displays the name associated with the campaign benefit.
                  example: Coupon
                campaignBenefitValue:
                  type: integer
                  description: >-
                    Displays the specific numerical value associated with a
                    benefit offered as part of the campaign.
                  example: 123
                campaignBenefitImageUrl:
                  type: string
                  description: >-
                    Displays the web address (URL) for the image associated with
                    the campaign.
                  example: https://summer.image.com
                campaignBenefitExpirationDate:
                  type: string
                  description: >-
                    Displays the date by which the campaign benefit must be
                    redeemed in yyyy-MM-dd'T'HH:mm:ss format.
                  example: 2024-08-08T07:00:12+0000
            multibucketsData:
              type: object
              description: >-
                Displays an array of all multi bucket details with the following
                fields when the multi bucket is enabled.
              properties:
                tier[multibucket_name]:
                  type: object
                  description: >-
                    Displays the following details of the point bucket affected
                    by tier activity.
                  properties:
                    maxTier[multibucket_name]:
                      type: integer
                      description: >-
                        Displays the maximum point limit for points that can be
                        earned towards the additional point bucket.
                      example: 300
                    ratio:
                      type: integer
                      description: >-
                        Displays the point ratio set by the administrator, that
                        determines how points are awarded to members for
                        completing the action.
                      example: 30
                    requiredCount:
                      type: integer
                      description: >-
                        Displays the  number of times a member must complete the
                        action to earn points towards the additional point
                        bucket. For example, if a loyalty program requires
                        members to make five purchases to earn a reward, the
                        "RequiredCount" is 5.
                      example: 5
                    completedCount:
                      type: integer
                      description: >-
                        Displays the number of times the member has already
                        completed the action. For example, if a loyalty program
                        requires members to make five purchases to earn a reward
                        and a member has already made three purchases, the
                        "CompletedCount" is 3.
                      example: 3
                    pendingCount:
                      type: integer
                      description: >-
                        Displays the remaining number of times the member must
                        complete the action to earn the reward. For example, if
                        a loyalty program requires members to make five
                        purchases to earn a reward and a member has made three
                        purchases but hasn't completed the remaining two, the
                        "PendingCount" is 2.
                      example: 2
            actionGroupDetail:
              type: object
              description: Displays the details regarding the action group.
              properties:
                groupId:
                  type: string
                  description: >-
                    Displays the unique action group that the action belongs to
                    on this particular site.
                  example: '91'
                groupName:
                  type: string
                  description: >-
                    Displays the unique action group name that the action
                    belongs to on this particular site.
                  example: QANeel
                status:
                  type: string
                  description: >-
                    Displays the action group's status as either "active" or
                    "inactive."
                  example: ACTIVE
                maxLimit:
                  type: integer
                  description: >-
                    Displays the limit set for the maximum number of times the
                    actions in the group can be completed by members for
                    rewards.
                  example: 500
                groupLimitType:
                  type: string
                  description: >-
                    Displays the type of limit associated with the action group.
                    For example- Rolling/Calendar
                  example: Rolling
                groupRollingPeriod:
                  type: integer
                  description: >-
                    Displays the duration after which the limit applied to the
                    action group resets.
                  example: 15
                groupCalendarPeriod:
                  type: string
                  description: >-
                    Display the calendar period details if the group limit type
                    is set to calendar. This includes information such as the
                    start and end dates, the specific time frame (e.g., daily,
                    weekly, monthly), and any relevant constraints or
                    limitations within that period.
                  example: Week
        record:
          type: integer
          description: >-
            Displays the total number of actions that have been configured on
            the site.
          example: 13
        pages:
          type: integer
          description: >-
            Displays the total number of pages that are displaying all the
            actions configured on the site.
          example: 7
        currentPage:
          type: integer
          description: >-
            Displays the current page, that is displaying the details of the
            actions configured on the site.
          example: 1
    getActionStatusresp:
      type: object
      properties:
        allActionDetails:
          type: object
          description: >-
            Displays the following details of actions configured in the loyalty
            program.
          properties:
            actionId:
              type: integer
              description: >-
                Displays the unique action ID for the action established in the
                loyalty program.
              example: 109
            actionName:
              type: string
              description: >-
                Displays the name of the action established in the loyalty
                program. (Different names are assigned to the actions based on
                activity linked to it)
              example: Purchase
            actionPoints:
              type: integer
              description: >-
                Displays the number of points awarded for performing the action
                on this particular site. (The number of points awarded can vary
                depending on the action and the rules of the loyalty program.)
              example: 50
            maxPoints:
              type: integer
              description: >-
                Displays the maximum number of points that can be awarded to a
                member for completing this action on this site. (The number of
                points awarded can vary depending on the action and the rules of
                the loyalty program.)
              example: 400
            period:
              type: integer
              description: >-
                Displays the days during which a member can accrue points, up to
                the established maximum. Once the designated duration expires,
                the maximum point-earning window resets. This duration initiates
                from the moment of the first action.
              example: 30
            ratio:
              type: integer
              description: >-
                Displays the points ratio set by the administrator, which
                determines how points are awarded against this specific action
                on this particular site. NOTE - This only applies to the
                purchase action. The other actions award a fixed number of
                points.
              example: 1
            status:
              type: string
              description: Displays the action's status as either "active" or "inactive."
              example: ACTIVE
            expireInDays:
              type: integer
              description: >-
                Displays the number of days after which the action no longer
                awards points for performing the specified action on this
                particular site. We can set expiration rules for the points
                awarded to members based on the action ID. (It essentially
                represents the expiration or validity period for earning points
                based on that action.)
              example: 10
            actionPointsExpirationType:
              type: string
              description: >-
                Displays information detailing how the points awarded for the
                action will expire. The points can expire based on a rolling or
                calendar period. Rolling- Points earned for the action will
                expire within a set number of days from when the action was
                completed, and the points were earned. Calendar- Points earned
                for completing the action will have an expiration date based on
                a calendar time frame, such as weeks, months, or years.
              example: Rolling
            actionPointsExpireIn:
              type: string
              description: >-
                Displays the expiration date set for the action points awarded
                on this particular site. The way it displays depends on whether
                "Rolling" or "Calendar" is selected.
              example: 3 days
            actionPointsExpireValue:
              type: integer
              description: >-
                Displays the set value determining when points will expire. This
                value is dynamic and varies based on the chosen expiration type.
              example: 1
            holdDays:
              type: integer
              description: >-
                Displays the number of days the points awarded for performing a
                specific action are on hold on this particular site after the
                action has been completed. (Points put on hold are not
                immediately available for use and have a waiting period before
                they become usable or redeemable by the member.)
              example: 20
            actionNameDisplay:
              type: string
              description: >-
                Displays the name of the action performed as configured for the
                site. (Different names are assigned to the actions based on
                activity linked to it)
              example: Purchase
            actionLimitDisplay:
              type: string
              description: >-
                Displays the various limits applied to the action. (Limits can
                be in terms of points, rules or criteria. These limits are set
                by the administrator based on the requirements)
              example: Points to be awarded in batches.
            actionDescription:
              type: string
              description: >-
                Displays an explanation of how the action functions. It
                typically outlines the specific details and conditions under
                which the action is performed, how points are awarded, and any
                relevant rules or guidelines associated with the action within
                the loyalty program.
              example: Make a purchase and earn points.
            actionActiveUrl:
              type: string
              description: >-
                Displays the web address (URL) of the image that is visible on
                this particular site when the action is ACTIVE.
              example: https://www.annexcloud.com/
            actionInactiveUrl:
              type: string
              description: >-
                Displays the web address (URL) of the image that is visible on
                this particular site when the action is INACTIVE.
              example: https://www.annexcloud.com/
            actionButtonTitle:
              type: string
              description: >-
                Displays the title assigned to an action button. This title is
                set by the administrator.
              example: Purchase for Points
            actionrRedirecturl:
              type: string
              description: >-
                Displays the web address (URL) for the page that members will be
                redirected to once the action has been completed.
              example: https://www.annexcloud.com/
            actionPointsDisplay:
              type: string
              description: >-
                Displays a visual representation of the number of points
                acquired by a member for performing specific actions. This
                display is highly customizable. For example, if a member earns
                10 points for completing a task, the Action Points Display can
                be configured to present those points in a unique format such as
                "xyz123" instead of the standard numerical representation.
              example: cloud459
            isActionInCampaign:
              type: integer
              description: >-
                Displays whether the action is part of any campaigns. Here's how
                the values are interpreted- 1- It means "Yes," indicating that
                the action is part of one or more campaigns. 0- It means "No,"
                indicating that the action is not associated with any campaigns.
                It typically outlines the specific details and conditions under
                which the action is performed, how points are awarded, and any
                relevant rules or guidelines associated with the action within
                the loyalty program.
              example: 1
            campaignDetails:
              type: object
              description: >-
                Displays the following campaign details if an action is included
                in a campaign.
              properties:
                campaignId:
                  type: integer
                  description: >-
                    Displays the unique campaign ID that the actions belong to
                    on this particular site. (There may be multiple campaigns in
                    a site based on the requirement.)
                  example: 605
                campaignName:
                  type: string
                  description: >-
                    Displays the unique campaign name that the actions belong to
                    on this particular site.
                  example: Summer Offer
                campaignDateFrom:
                  type: string
                  description: >-
                    Displays the starting date of the campaign in
                    yyyy-MM-dd'T'HH:mm:ss format.
                  example: '2021-04-01T00:00:00'
                campaignDateTo:
                  type: string
                  description: >-
                    Displays the ending date of the campaign in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: '2021-04-01T00:00:00'
                noOfMilestones:
                  type: integer
                  description: >-
                    Displays the number of milestones that are included in the
                    campaign and are attained on the execution of certain
                    actions.
                  example: 4
                linkedMilestone:
                  type: integer
                  description: >-
                    Displays the specific number of campaign milestones that are
                    linked to the action on this particular site.
                  example: 3
            milestoneBenefit:
              type: object
              description: Displays the milestone benefits linked to the action.
              properties:
                name:
                  type: string
                  description: Displays the unique name of the milestone within a campaign.
                  example: Save on Groceries
                description:
                  type: string
                  description: >-
                    Displays a detailed explanation or description of the
                    specific milestone within a campaign. (It clarifies what a
                    loyalty member needs to achieve or complete in order to
                    reach that milestone and receive the associated rewards or
                    benefits.)
                  example: >-
                    Members receive x number of points on the shopping of
                    groceries.
                type:
                  type: string
                  description: >-
                    Displays the classification of the milestone within a
                    campaign, within a loyalty program or campaign. The
                    milestone type can be one of two categories- Actions- This
                    type involves a single action rule that the member must
                    complete to achieve the milestone. Action Series- In this
                    type, multiple actions have been configured as part of an
                    action series, and the member must complete all of them to
                    reach the milestone.
                  example: Action
                detail:
                  type: string
                  description: >-
                    Displays the specific details regarding the benefits or
                    rewards based on the type selected in the previous
                    parameter, i.e., it displays the action names that have been
                    set as milestones.
                  example: Redeem
                benefitName:
                  type: string
                  description: >-
                    Displays the name given to the benefit associated with the
                    campaign milestone. For example, a milestone benefit name
                    could be "50 Bonus Points," or "10% Discount Coupon".
                  example: Coupon
                benefitValue:
                  type: integer
                  description: >-
                    Displays the specific numerical or qualitative value
                    associated with the benefit provided when the member has
                    completed the campaign milestone. For example- If the
                    benefit is a voucher, the "milestone benefit value" would
                    represent the monetary or discount value of the voucher. If
                    the benefit is a coupon, the "milestone benefit value" would
                    indicate the value of the coupon as an object, which may
                    include discount percentage.
                  example: 200
                benefitActiveImageUrl:
                  type: string
                  description: >-
                    Displays the web address (URL) for the image associated with
                    the campaign milestone benefit when it is active.  This
                    image is typically displayed to visually represent the
                    benefit awarded.
                  example: https://summer22.activeimage.com
                benefitInactiveImageUrl:
                  type: string
                  description: >-
                    Displays the web address (URL) for the image associated with
                    the campaign milestone benefit when it is inactive. This
                    image is typically displayed when the benefit is inactive or
                    not available for use or redemption.
                  example: https://summer22.inactiveimage.com
                benefitRedemptionDate:
                  type: string
                  description: >-
                    Displays the date when the campaign milestone benefit can be
                    redeemed in yyyy-MM-dd'T'HH:mm:ss format.
                  example: 2024-08-08T07:00:12+0000
            campaignAudience:
              type: object
              description: Displays the following details about the campaign audience.
              properties:
                segment:
                  type: string
                  description: >-
                    Displays the segment of members included in the target
                    audience for the campaign.
                  example: California
                tier:
                  type: string
                  description: >-
                    Displays the specific tier within the loyalty program that
                    is included in the target audience for the campaign.
                  example: Silver
            campaignBenefit:
              type: object
              description: Displays the benefits associated with the campaign.
              properties:
                campaignBenefitType:
                  type: integer
                  description: >-
                    Displays the type of benefit that is offered as part of the
                    campaign. The benefit type can vary depending on the
                    campaign's objectives and the loyalty program's offerings.
                    We offer two types of benefits- points benefits and reward
                    benefits.
                  example: 3
                campaignBenefitName:
                  type: string
                  description: Displays the name associated with the campaign benefit.
                  example: Coupon
                campaignBenefitValue:
                  type: integer
                  description: >-
                    Displays the specific numerical or qualitative value
                    associated with a benefit offered as part of the campaign.
                  example: 123
                campaignBenefitImageUrl:
                  type: string
                  description: >-
                    Displays the web address (URL) for the image associated with
                    the campaign.
                  example: https://summer.image.com
                campaignBenefitExpirationDate:
                  type: string
                  description: >-
                    Displays the date by which the campaign benefit must be
                    redeemed in yyyy-MM-dd' HH:mm:ss format.
                  example: 2024-08-08T07:00:12+0000
                isActionInActionGroup:
                  type: string
                  description: >-
                    Displays whether the action is part of any action group.
                    Here's how the values are interpreted- 1- It means "Yes,"
                    indicating that the action is part of one or more action
                    groups. 0- It means "No," indicating that the action is not
                    associated with any action groups.
                  example: 1
            actionGroupDetail:
              type: object
              description: Displays the details regarding the action group.
              properties:
                groupId:
                  type: string
                  description: >-
                    Displays the ID of the unique action group that the actions
                    belong to on this particular site.
                  example: '91'
                groupName:
                  type: string
                  description: >-
                    Displays the unique action group name that the actions
                    belong to on this particular site.
                  example: Purchase and Review
                status:
                  type: string
                  description: >-
                    Displays the action group's status as either "active" or
                    "inactive."
                  example: ACTIVE
                maxLimit:
                  type: integer
                  description: >-
                    Displays the maximum number of points a member can earn from
                    the action group.
                  example: 500
                groupLimitType:
                  type: string
                  description: >-
                    Displays the type of limit associated with the action group.
                    For example- Rolling/Calendar
                  example: Rolling
                groupRollingPeriod:
                  type: integer
                  description: >-
                    Displays the duration after which the limit applied to the
                    action group resets.
                  example: 15
                groupCalendarPeriod:
                  type: string
                  description: >-
                    Display the calendar period details if the group limit type
                    is set to calendar. This includes information such as the
                    start and end dates, the specific time frame (e.g., daily,
                    weekly, monthly), and any relevant constraints or
                    limitations within that period.
                  example: Week
                createDate:
                  type: string
                  description: >-
                    Displays the date when the action was created in 
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2021-04-01T00:00:00-0700
                updateDate:
                  type: string
                  description: >-
                    Displays the date when the action was last updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2021-04-01T00:00:00-0700
        pages:
          type: integer
          description: >-
            Displays the total number of pages that are displaying all the
            actions configured on this particular site.
          example: 7
        currentPage:
          type: integer
          description: >-
            Displays the current page that is displaying the details of the
            actions configured on this particular site.
          example: 1
    getactionGroupIdResp:
      type: object
      properties:
        siteID:
          type: string
          description: Displays the unique site ID to which the action group belongs to.
          example: 146011380
        actionGroupDetail:
          type: object
          description: Displays various details regarding the Action Group.
          properties:
            groupId:
              type: string
              description: >-
                Displays the unique identifier associated with a group or set of
                related actions.
              example: '91'
            groupName:
              type: string
              description: >-
                Displays the name or label assigned to a group of related
                actions. The action group name serves as a descriptive
                identifier for a set of actions that share common
                characteristics or are grouped for a specific purpose.
              example: Social Connect Group
            activeBadgeUrl:
              type: string
              description: >-
                Displays the link or URL associated with an ACTIVE badge related
                to a specific action group. The "action group active badge URL"
                would be the web address pointing to the image or icon that
                visually represents an active status for that particular group
                of actions.
              example: https://prnt.sc/XYZ
            inactiveBadgeUrl:
              type: string
              description: >-
                Displays the link or URL associated with an INACTIVE badge
                related to a specific action group. The "action group active
                badge URL" would be the web address pointing to the image or
                icon that visually represents an inactive status for that
                particular group of actions.
              example: https://prnt.sc/XYZ
            maxLimit:
              type: integer
              description: >-
                Displays the maximum limit imposed on achieving points or
                achievements within a specific action group. The max limit
                defines the highest amount a member can attain.
              example: 200
            groupLimitType:
              type: string
              description: >-
                Displays the type of limit imposed on a specific group within an
                action group. Different types of limits are applied to regulate
                the achievements of points to members.
              example: Calendar or Rolling
            groupRollingPeriod:
              type: integer
              description: >-
                Displays the specific time frame or duration associated with the
                rolling period for a group within an action group. This rolling
                period determines the duration after which the maximum points
                window will reset.
              example: 15
            groupCalendarPeriod:
              type: string
              description: >-
                Displays the specific time frame or duration associated with the
                calendar period for a group within an action group. This
                calendar period determines the duration after which the maximum
                points window will reset.
              example: Day or week or Month
            groupActionData:
              type: object
              description: Displays the action data that are associated with the group.
              properties:
                actionId:
                  type: integer
                  description: >-
                    Displays the unique actionId of the action within an action
                    group.
                  example: 352
                actionName:
                  type: string
                  description: >-
                    Displays the name assigned to a specific action within a
                    group. Each action is associated with a distinct name or
                    label for identification and communication purposes.
                  example: Facebook Share
                actionPoints:
                  type: integer
                  description: >-
                    Displays the number of points assigned to the action ID as
                    configured in the action settings. Actions are assigned
                    points to incentivize member participation and recognize
                    their achievements.
                  example: 20
                maxPoints:
                  type: integer
                  description: >-
                    Displays the maximum number of points an individual member
                    can earn for a specific action, as defined by the action ID.
                  example: 140
                actionLimitType:
                  type: string
                  description: >-
                    Displays the type of limit imposed on actions. Limits may be
                    applied to regulate the activities or achievements.
                  example: Rolling
                rollingPeriod:
                  type: integer
                  description: >-
                    Displays the specific time frame or duration associated with
                    the rolling period for a group within an action group. This
                    rolling period determines the duration after which the
                    maximum points window will reset.
                  example: 15
                calendarPeriod:
                  type: string
                  description: >-
                    Displays the specific time frame or duration associated with
                    the calendar period for a group within an action group. This
                    calendar period determines the duration after which the
                    maximum points window will reset.
                  example: Day or week or Month
                ratio:
                  type: integer
                  description: >-
                    Displays the points ratio set by the administrator, that
                    determines how points are awarded against a specific action
                    to a loyalty member for performing the action.
                  example: 30
                actionNameDisplay:
                  type: string
                  description: Displays how the names of specific actions are presented.
                  example: FB Share
            multiBucketData(For Multi Point Bucket enabled sites, the system returns additional parameters.):
              type: object
              properties:
                bucketName:
                  type: object
                  properties:
                    bucketId:
                      type: integer
                      description: Displays the unique Bucket ID.
                      example: 4
                    bucketGroupMaxLimit:
                      type: integer
                      description: >-
                        Displays the maximum limit imposed on achieving points
                        or achievements within a specific action group. The max
                        limit defines the highest amount a member can attain.
                      example: 200
                    bucketGroupActionLimitType:
                      type: string
                      description: >-
                        Displays the type of limit imposed on a specific group
                        within an action group. Different types of limits are
                        applied to regulate the achievements of points to
                        members.
                      example: Calendar or Rolling
                    bucketGroupRollingPeriod:
                      type: integer
                      description: >-
                        Displays the specific time frame or duration associated
                        with the rolling period for a group within an action
                        group. This rolling period determines the duration after
                        which the maximum points window will reset.
                      example: 15
                    bucketGroupCalendarPeriod:
                      type: string
                      description: >-
                        Displays the specific time frame or duration associated
                        with the calendar period for a group within an action
                        group. This calendar period determines the duration
                        after which the maximum points window will reset.
                      example: Day or week or Month
                    createDate:
                      type: string
                      description: >-
                        Displays the date and time when a specific action group
                        was created in yyyy-MM-dd'T'HH:mm:ssZ format. The
                        creation date is a timestamp that indicates when this
                        group of actions was initially defined or configured.
                      example: 2024-08-08T07:00:12+0000
                    updateDate:
                      type: string
                      description: >-
                        Displays the date and time when a specific action group
                        was updated in yyyy-MM-dd'T'HH:mm:ssZ format. The
                        creation date is a timestamp that indicates when this
                        group of actions was updated.
                      example: 2024-08-08T07:00:12+0000
        pages:
          type: integer
          description: >-
            Displays the total number of pages that are displaying all the
            action groups.
          example: 7
        currentPage:
          type: integer
          description: >-
            Displays the current page, that is displaying the details of the
            action group.
          example: 1
    getactionGroupEmailIdResp:
      type: object
      properties:
        siteID:
          type: string
          description: >-
            Displays the unique site ID where the loyalty member has performed
            the actions.
          example: 146011380
        actionGroupDetail:
          type: object
          description: Displays various details regarding the Action Group.
          properties:
            groupId:
              type: string
              description: >-
                Displays the unique identifier associated with a group or set of
                related actions.
              example: '91'
            groupName:
              type: string
              description: >-
                Displays the name or label assigned to a group of related
                actions. The action group name serves as a descriptive
                identifier for a set of actions that share common
                characteristics or are grouped for a specific purpose.
              example: Social Connect Group
            activeBadgeUrl:
              type: string
              description: >-
                Displays the link or URL associated with an ACTIVE badge related
                to a specific action group. The "action group active badge URL"
                would be the web address pointing to the image or icon that
                visually represents an active status for that particular group
                of actions.
              example: https://prnt.sc/XYZ
            inactiveBadgeUrl:
              type: string
              description: >-
                Displays the link or URL associated with an INACTIVE badge
                related to a specific action group. The "action group active
                badge URL" would be the web address pointing to the image or
                icon that visually represents an inactive status for that
                particular group of actions.
              example: https://prnt.sc/XYZ
            maxLimit:
              type: integer
              description: >-
                Displays the maximum limit imposed on achieving points or
                achievements within a specific action group. The max limit
                defines the highest amount a member can attain.
              example: 200
            groupLimitType:
              type: string
              description: >-
                Displays the type of limit imposed on a specific group within an
                action group. Different types of limits are applied to regulate
                the achievements of points to members.
              example: Calendar or Rolling
            groupRollingPeriod:
              type: integer
              description: >-
                Displays the specific time frame or duration associated with the
                rolling period for a group within an action group. This rolling
                period determines the duration after which the maximum points
                window will reset.
              example: 15
            groupCalendarPeriod:
              type: string
              description: >-
                Displays the specific time frame or duration associated with the
                calendar period for a group within an action group. This
                calendar period determines the duration after which the maximum
                points window will reset.
              example: Day or week or Month
            earnedPoints:
              type: integer
              description: >-
                Returns the Points earned by the member against the associated
                Actions.
              example: 20
            availableToEarnPoints:
              type: integer
              description: >-
                Returns the remaining points to be earned out of the maximum
                Action Group points.
              example: 180
            usedActionId:
              type: integer
              description: Returns the Action IDs consumed this far.
              example: 352
            groupActionData:
              type: object
              description: Displays the following details regarding group action data.
              properties:
                actionId:
                  type: integer
                  description: >-
                    Displays the unique identifier assigned to a specific action
                    within a group. Each action is assigned a distinct
                    identification number for reference and tracking.
                  example: 352
                actionName:
                  type: string
                  description: >-
                    Displays the name assigned to a specific action within a
                    group. Each action is associated with a distinct name or
                    label for identification and communication purposes.
                  example: Facebook Share
                actionPoints:
                  type: integer
                  description: >-
                    Displays the points or rewards associated with a specific
                    action within a group. Actions are assigned point values to
                    incentivize member participation and recognize their
                    achievements.
                  example: 20
                maxPoints:
                  type: integer
                  description: >-
                    Displays the maximum number of points that can be
                    accumulated or earned by a member or a group of members
                    within a specific group or category.
                  example: 140
                actionLimitType:
                  type: string
                  description: >-
                    Displays the type of limit imposed on actions within a
                    specific group. Limits may be applied to regulate the
                    activities or achievements of a specific group of members.
                  example: Rolling
                rollingPeriod:
                  type: integer
                  description: >-
                    Displays the specific time frame or duration associated with
                    the rolling period for a group within an action group. This
                    rolling period determines the duration after which the
                    maximum points window will reset.
                  example: 15
                calendarPeriod:
                  type: string
                  description: >-
                    Displays the specific time frame or duration associated with
                    the calendar period for a group within an action group. This
                    calendar period determines the duration after which the
                    maximum points window will reset.
                  example: Day or week or Month
                ratio:
                  type: integer
                  description: >-
                    Displays the points ratio set by the administrator, that
                    determines how points are awarded against a specific action
                    to a loyalty member for performing the action.
                  example: 30
                actionNameDisplay:
                  type: string
                  description: Displays how the names of specific actions are presented.
                  example: FB Share
            multiBucketData(For Multi Point Bucket enabled sites, the system returns additional parameters):
              type: object
              properties:
                bucketName:
                  type: object
                  description: Displays the following details.
                  properties:
                    bucketId:
                      type: integer
                      description: Displays the unique Bucket ID.
                      example: 4
                    bucketGroupMaxLimit:
                      type: integer
                      description: >-
                        Displays the maximum limit imposed on achieving points
                        or achievements within a specific action group. The max
                        limit defines the highest amount a member can attain.
                      example: 200
                    bucketGroupActionLimitType:
                      type: string
                      description: >-
                        Displays the type of limit imposed on a specific group
                        within an action group. Different types of limits are
                        applied to regulate the achievements of points to
                        members.
                      example: Calendar or Rolling
                    bucketGroupRollingPeriod:
                      type: integer
                      description: >-
                        Displays the specific time frame or dun associated with
                        the rolling period for a group within an action group.
                        This rolling period determines the duration after which
                        the maximum points window will reset.
                      example: 15
                    bucketGroupCalendarPeriod:
                      type: string
                      description: >-
                        Displays the specific time frame or duration associated
                        with the calendar period for a group within an action
                        group. This calendar period determines the duration
                        after which the maximum points window will reset.
                      example: Day or week or Month
                    createDate:
                      type: string
                      description: >-
                        Displays the date and time when a specific action group
                        was created in yyyy-MM-dd'T'HH:mm:ssZ format. The
                        creation date is a timestamp that indicates when this
                        group of actions was initially defined or configured.
                      example: 2024-08-08T07:00:12+0000
                    updateDate:
                      type: string
                      description: >-
                        Displays the date and time when a specific action group
                        was updated in yyyy-MM-dd'T'HH:mm:ssZ format. The
                        creation date is a timestamp that indicates when this
                        group of actions was updated.
                      example: 2024-08-08T07:00:12+0000
                    earnedPoints:
                      type: integer
                      description: >-
                        Displays the total number of earned points by the
                        member.
                      example: 0
                    availableToEarnPoints:
                      type: integer
                      description: >-
                        Displays the balance points after the member has earned
                        some points for a particular action.
                      example: 0
    createordersresp:
      type: object
      description: >-
        This response will show the details for the successfully placed order
        including order total, reward name, points awarded and discount amount.
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 9991331
        id:
          type: string
          description: Displays the unique ID of the order.
          example: abc234
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        disregardHoldPeriod:
          type: string
          description: >-
            Displays whether the system has successfully disregarded the hold
            period for the points associated with the order. If set to YES, the
            hold period was bypassed, and the points were released to the member
            immediately. If set to NO,  the points are still subject to the
            standard hold period before being released.
          example: 'YES'
        email:
          type: string
          description: Displays the email address of the member.
          example: user@domain.com
        firstName:
          type: string
          description: Displays the first name of the member.
          example: John
        lastName:
          type: string
          description: Displays the last name of the member.
          example: Smith
        orderTotal:
          type: integer
          description: Displays the total amount spent on the order.
          example: 200
        eventId:
          type: integer
          description: >-
            Displays the event identified for the member. The eventId is used
            for tracking a referral order. Using the original sharer or
            referrer, the system then awards points based on a specific event
            back to the sharer/referrer. The eventId can also be checked using
            the RAF module.
          example: 123
        storeId:
          type: string
          description: Displays the unique ID of the store where the order was placed.
          example: IN12369
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: web
        rewardId:
          type: integer
          description: Displays the specific ID of the reward applied to the order.
          example: 234
        rewardName:
          type: string
          description: Displays the name of the reward.
          example: Reward234
        pointsAwarded:
          type: integer
          description: Displays the total points awarded for the order.
          example: 100
        pointsExpirationDate:
          type: string
          description: >-
            Displays the points expiration date in yyyy-MM-dd'T'HH:mm:ssZ
            format.
          example: 2020-04-01T00:00:00-0700
        pointsOnHold:
          type: integer
          description: >-
            Displays the number of points on hold against the order. Points may
            be put on hold to account for possible returns made by the member.
          example: 20
        coupon:
          type: string
          description: Displays the coupon code, if a code was applied on the order.
          example: xe76y
        previousTier:
          type: string
          description: Displays the name of the member's previous tier.
          example: Silver
        UpdatedUserTier:
          type: string
          description: >-
            Displays the name of the member's updated tier after the points are
            awarded/removed for the order.
          example: Gold
        currentTier:
          type: string
          description: >-
            Displays the name of the member's current tier. For example, Bronze,
            Silver, Gold. The name of the tier is defined by the client during
            configuration of the loyalty program.
          example: Gold
        nextTier:
          type: string
          description: >-
            Displays the name of the next tier the member can achieve in the
            loyalty program.
          example: Platinum
        pointsToNextTier:
          type: integer
          description: >-
            Displays the number of points required to achieve the next tier.
            This depends on the point threshold required to reach the next tier
            and the number of points the member currently has in their account.
          example: 240
        currentTierPurchaseRatio:
          type: integer
          description: >-
            Displays the purchase point ratio applied to the member's purchases
            in their current tier.
          example: 2
        spendAmountToNextTier:
          type: integer
          description: >-
            Displays the amount the member needs to spend to achieve the next
            tier. This is only applicable to tiers where the metric is
            spend-based. If the tier metric is points-based or based on extended
            attributes, it will not show any additional values.
          example: 200
        discountCalulationDisabled:
          type: string
          description: Displays the discount calculation disabled as YES/NO.
          example: 'YES'
        tierAchievedDate:
          type: string
          description: >-
            Displays the date the current tier was achieved in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2020-04-01T00:00:00-0700
        tierExpirationDate:
          type: string
          description: Displays the tier expiration date in yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2018-04-01T00:00:00-0700
        updatedAvailablePoints:
          type: integer
          description: >-
            Displays the updated total number of available points for the
            member.
          example: 1234
        updatedLifetimePoints:
          type: integer
          description: >-
            Displays the updated number of points the member has accumulated in
            their lifetime with the loyalty program.
          example: 2000
        discountAmount:
          type: integer
          description: Displays the total discount amount applied to the order.
          example: 25
        shippingAmount:
          type: integer
          description: Displays the cost of shipping for the order.
          example: 15
        orderDetail:
          type: object
          description: Displays the product details for the order as shown below.
          properties:
            id:
              type: string
              description: Displays the unique product ID.
              example: p1
            productName:
              type: string
              description: Displays the name of the product.
              example: shoes
            quantity:
              type: integer
              description: Displays the quantity of the product purchased in the order.
              example: 2
            unitPrice:
              type: integer
              description: Displays the unit price of the product.
              example: 75
            netPrice:
              type: integer
              description: Displays the net price of the product.
              example: 150
            productDiscount:
              type: integer
              description: Displays the total amount the product was discounted.
              example: 30
            estimatedShipDate:
              type: string
              description: >-
                Displays the estimated date the product will be shipped in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            autoDelivery:
              type: string
              description: >-
                Indicates if the order is set for auto delivery with YES or NO.
                If not provided, then by default it is YES. Points are not
                awarded against the product ID if the value is NO and the auto
                delivery flag has been enabled.
              example: 'YES'
            categoryId:
              type: integer
              description: Displays the category ID for the product.
              example: 23
            categoryName:
              type: string
              description: Displays the category name for the product.
              example: running shoes
            rewardId:
              type: integer
              description: >-
                Displays the specific reward ID for the reward applied to the
                order.
              example: 123
            rewardName:
              type: string
              description: Displays the name of the reward.
              example: Reward 123
            points:
              type: integer
              description: >-
                Displays the number of points the member earned for purchasing
                the product.
              example: 210
            url:
              type: string
              description: Displays the product URL.
              example: http://domain.com/image.gif
            imageUrl:
              type: string
              description: Displays the product image URL.
              example: http://domain.com/image.gif
            description:
              type: string
              description: Displays the description of the product.
              example: XYZ Flowers
            secondarykey:
              type: string
              description: >-
                Displays the unique secondary key. The secondary key is an
                essential element in handling orders that contain multiple
                products with the same product ID. If a member wants to return a
                product after the order is shipped, the system may encounter
                issues due to the identical product IDs. However, the secondary
                key comes in handy to differentiate between the products,
                enabling the system to identify each product accurately and
                process partial returns or cancellations of the order
                successfully.
              example: p101
        orderAttribute:
          type: object
          description: >-
            Displays the order attribute which passes values while creating the
            order (if order attributes have been configured).
          properties:
            MPC:
              type: string
              description: Displays the MPC code.
              example: ABC12345
            MSTN:
              type: string
              description: Displays the MSTN code.
              example: ABC67890
        multiBucketsData:
          type: object
          description: >-
            Displays an array of all multi-bucket details with the following
            fields. Only displays if the multi-bucket flag is enabled.
          properties:
            bucketName:
              type: object
              description: Displays the name of the additional point bucket.
              properties:
                holdCredit:
                  type: integer
                  description: >-
                    Displays the points on hold within the additional point
                    bucket.
                  example: 100
                releasedDate:
                  type: string
                  description: >-
                    Displays the release date for the points on hold in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2020-10-30T05:30:00+0000
                updatedAvailable[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of available points in the
                    additional point bucket.
                  example: 200
                updatedLifetime[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of points the member has earned
                    in the additional point bucket in their lifetime as a
                    loyalty member.
                  example: 200
    bulkorderresp:
      type: object
      description: This will fetch all the order details for created bulk orders.
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 9991331
        id:
          type: string
          description: Displays the unique ID of the order.
          example: abc234
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        email:
          type: string
          description: Displays the email address of the member.
          example: user@domain.com
        firstName:
          type: string
          description: Displays the first name of the member.
          example: John
        lastName:
          type: string
          description: Displays the last name of the member.
          example: Smith
        orderTotal:
          type: integer
          description: Displays the total amount of the order placed.
          example: 200
        eventId:
          type: string
          description: Displays the event identified for the member.
          example: cd123
        storeId:
          type: string
          description: Displays the unique ID of the store.
          example: IN12369
        source:
          type: string
          description: >-
            Displays the source where the order was placed by the loyalty
            member, such as web or store.
          example: web
        rewardId:
          type: integer
          description: Displays the specific reward ID for the reward applied to the order.
          example: 234
        rewardName:
          type: string
          description: Displays the name of the reward applied to the order.
          example: Reward234
        pointsAwarded:
          type: integer
          description: Displays the number of points awarded against the order.
          example: 0
        pointsExpirationDate:
          type: string
          description: >-
            Displays the points expiration date in yyyy-MM-dd'T'HH:mm:ssZ
            format.
          example: 2020-04-01T00:00:00-0700
        coupon:
          type: string
          description: Displays the coupon code, if a code was applied on the order.
          example: SARL0RXQ12017
        previousTier:
          type: string
          description: >-
            Displays the member's previous tier after the points are
            awarded/removed.
          example: SARL0RXQ12017
        UpdatedUserTier:
          type: string
          description: >-
            Displays the member's updated tier after the points are
            awarded/removed.
          example: Gold
        currentTier:
          type: string
          description: >-
            Displays the name of the member's current tier. For example, Bronze,
            Silver, Gold. The name of the tier is defined by the client during
            configuration of the loyalty program.
          example: Silver
        nextTier:
          type: string
          description: >-
            Displays the name of the next tier which is awarded to the member
            once the required milestones are achieved.
          example: XYXZ
        pointsToNextTier:
          type: integer
          description: >-
            Displays the number of points required to achieve the next tier.
            This depends on the point threshold required to reach the next tier
            and the number of points the member currently has in their account.
          example: 240
        currentTierPurchaseRatio:
          type: integer
          description: >-
            Displays the purchase ratio that is applied to the member for this
            tier while earning purchase points.
          example: 2
        spendAmountToNextTier:
          type: integer
          description: >-
            Displays the amount the member needs to spend to achieve the next
            tier. This is only applicable to tiers where the metric is
            spend-based. If the tier metric is points-based or based on extended
            attributes, it will not show any additional values.
          example: 200
        discountCalulationDisabled:
          type: string
          description: Displays the discount calculation disabled as YES/NO.
          example: 'YES'
        tierAchievedDate:
          type: string
          description: >-
            Displays the current tier achievement date in in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2020-04-01T00:00:00-0700
        updatedAvailablePoints:
          type: integer
          description: >-
            Displays the updated total number of available points for the
            member.
          example: 1250
        updatedLifetimePoints:
          type: integer
          description: Displays the updated number of lifetime points for the member.
          example: 3000
        discountAmount:
          type: integer
          description: Displays the total discount amount on a placed order.
          example: 25
        shippingAmount:
          type: integer
          description: Displays the amount applied for shipping the order.
          example: 0
        orderDetail:
          type: object
          description: Displays the product details for the order as shown below.
          properties:
            id:
              type: string
              description: Displays the unique ID of the product.
              example: p1
            productName:
              type: string
              description: Displays the name of the product.
              example: ABC
            quantity:
              type: integer
              description: Displays the quantity of the product purchased.
              example: 2
            unitPrice:
              type: integer
              description: Displays the unit price of the product.
              example: 230
            netPrice:
              type: integer
              description: Displays the net price of the product.
              example: 330
            productDiscount:
              type: integer
              description: Displays the total amount discounted from the product price.
              example: 30
            estimatedShipDate:
              type: string
              description: >-
                Displays the estimated ship date the product will be shipped in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            autoDelivery:
              type: string
              description: >-
                Displays an auto delivery as Yes/No. If not provided, then by
                default it is YES. Points are not awarded against the product ID
                if the value is passed as NO if the autoDelivery flag is
                enabled.
              example: 'YES'
            categoryId:
              type: integer
              description: Displays the category ID of the product.
              example: 23
            categoryName:
              type: string
              description: Displays the category name of the product.
              example: lorem ipsum
            rewardId:
              type: integer
              description: >-
                Displays the specific reward ID for the reward applied to the
                order.
              example: 123
            rewardName:
              type: string
              description: Displays the name of the reward.
              example: Reward 123
            points:
              type: integer
              description: >-
                Displays the number of points the member earns after purchasing
                the product.
              example: 210
            url:
              type: string
              description: Displays the order URL.
              example: http://domain.com/image.gif
            imageUrl:
              type: string
              description: Displays the product image URL.
              example: http://domain.com/image.gif
            description:
              type: string
              description: Displays the description.
              example: XYZ Flowers
            secondarykey:
              type: string
              description: >-
                Displays the unique secondary key. The secondary key is an
                essential element in handling orders that contain multiple
                products with the same product ID. If a member wants to return a
                product after the order is shipped, the system may encounter
                issues due to the identical product IDs. However, the secondary
                key comes in handy to differentiate between the products,
                enabling the system to identify each product accurately and
                process partial returns or cancellations of the order
                successfully.
              example: p101
        orderAttribute:
          type: object
          description: Displays the order attribute values passed while creating an order.
          properties:
            MPC*:
              type: string
              description: >-
                Displays the MPC code. An asterisk ( * ) after a field name
                indicates the parameter is a key value pair.
              example: abc12345
            MSTN*:
              type: string
              description: Displays the MSTN code.
              example: 67890gf
    secondaryUserOrdersresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 123456
        id:
          type: string
          description: Displays the unique ID for the order.
          example: user@domain.com
        userId:
          type: string
          description: Displays the unique user ID for the loyalty member.
          example: 12345
        orderDate:
          type: string
          description: Displays the date the order was placed.
          example: 2022-04-01T00:00:00-0700
        secondaryUsersData:
          type: object
          description: Displays the point expiration details for the member.
          properties:
            secondaryUserId:
              type: string
              description: Displays the secondary member ID.
              example: secondary_user_1
            points:
              type: integer
              description: >-
                Displays the total points a secondary member earned on a
                particular order.
              example: 100
            pointsExpirationDate:
              type: string
              description: Displays the date the points are set to expire.
              example: 2022-11-23T01:49:18+0000
            pointsEarnBasis:
              type: string
              description: >-
                Displays the multi-level earning rule set for the secondary
                user.
              example: PCM Flat Points
    postOrderDetailsResp:
      type: object
      description: >-
        This response will show the details for the successfully placed order
        including order total, reward name, points awarded and discount amount.
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 9991331
        id:
          type: string
          description: Displays the unique ID of the order.
          example: abc234
        userId:
          type: string
          description: Displays the unique ID of the loyalty member.
          example: user@domain.com
        email:
          type: string
          description: Displays the email address of the member.
          example: user@domain.com
        orderDate:
          type: string
          description: Displays the order date in yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2018-04-01T00:00:00-0700
        firstName:
          type: string
          description: Displays the first name of the member.
          example: John
        lastName:
          type: string
          description: Displays the last name of the member.
          example: Smith
        orderTotal:
          type: integer
          description: Displays the total amount of an order placed by a loyalty member.
          example: 200
        purchasePointType:
          type: string
          description: Displays the purchase point type.
          example: Both
        storeId:
          type: string
          description: Displays the unique ID of the store where the order was placed.
          example: IN12369
        source:
          type: string
          description: >-
            Displays the source, meaning where the order was placed by the
            loyalty member, such as web or store.
          example: web
        discountAmounts:
          type: integer
          description: Displays the total discount amount on a placed order.
          example: 23
        discountRefundData:
          type: string
          description: Displays the total refund amount for order.
          example: 23
        coupon:
          type: string
          description: Displays the coupon code, if a code was applied on the order.
          example: $20_OFF
        pointsAwarded:
          type: integer
          description: Displays the number of points awarded against the order
          example: 100
        pointsOnHold:
          type: integer
          description: >-
            Displays the number of points on hold against the order. Points may
            be put on hold to account for possible returns made by the member.
          example: 20
        pointsExpirationDate:
          type: string
          description: >-
            Displays the points expiration date in yyyy-MM-dd'T'HH:mm:ssZ
            format.
          example: 2020-04-01T00:00:00-0700
        updatedAvailablePoints:
          type: integer
          description: >-
            Displays the updated total number of available points for the
            member.
          example: 1234
        updatedLifetimePoints:
          type: integer
          description: >-
            Displays the updated number of points the member has accumulated in
            their lifetime with the loyalty program.
          example: 2000
        discountAmount:
          type: integer
          description: Displays the total discount amount applied to the order placed.
          example: 25
        shippingAmount:
          type: integer
          description: Displays the cost of shipping for the order.
          example: 15
        orderDetail:
          type: object
          description: Displays the product details for the order as shown below.
          properties:
            id:
              type: string
              description: Displays the unique product ID.
              example: p1
            productName:
              type: string
              description: Displays the name of the product.
              example: shoes
            quantity:
              type: integer
              description: Displays the quantity of the product purchased in the order.
              example: 2
            unitPrice:
              type: integer
              description: Displays the unit price of the product.
              example: 75
            productDiscount:
              type: integer
              description: Displays the total total discounted amount on the product.
              example: 30
            netPrice:
              type: integer
              description: Displays the net price of the product.
              example: 150
            estimatedShipDate:
              type: string
              description: >-
                Displays the estimated date the product will be shipped in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            categoryId:
              type: integer
              description: Displays the category ID for the product.
              example: 23
            categoryName:
              type: string
              description: Displays the category name for the product.
              example: running shoes
            url:
              type: string
              description: Displays the product URL.
              example: http://domain.com/image.gif
            imageUrl:
              type: string
              description: Displays the product image URL.
              example: http://domain.com/image.gif
            description:
              type: string
              description: Displays the description of the product.
              example: XYZ Flowers
            lastUpdatedDate:
              type: string
              description: >-
                Displays the last updated date of the order in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            points:
              type: integer
              description: >-
                Displays the number of points the member earned for purchasing
                the product.
              example: 210
            coupon:
              type: string
              description: Displays the coupon code, if a code was applied on the order.
              example: bzgd
            rewardId:
              type: integer
              description: >-
                Displays the specific reward ID for the reward applied to the
                order.
              example: 123
            rewardName:
              type: string
              description: Displays the name of the reward.
              example: Reward 123
            campaignId:
              type: integer
              description: >-
                Displays the campaign ID, if a campaign was applied on the
                order.
              example: 123
            campaignName:
              type: string
              description: >-
                Displays the name of the ccampaign, if a campaign was applied on
                the order.
              example: summersale
            campaignPoints:
              type: integer
              description: >-
                Displays the total number of campaign points earned, if a
                campaign was applied on the order.
              example: 123
            campaignHoldPoints:
              type: integer
              description: Displays the number of campaign points on hold.
              example: 150
            secondarykey:
              type: string
              description: >-
                Displays the unique secondary key. The secondary key is an
                essential element in handling orders that contain multiple
                products with the same product ID. If a member wants to return a
                product after the order is shipped, the system may encounter
                issues due to the identical product IDs. However, the secondary
                key comes in handy to differentiate between the products,
                enabling the system to identify each product accurately and
                process partial returns or cancellations of the order
                successfully.
              example: p101
        ratio:
          type: object
          description: Displays the product purchase ratio details.
          properties:
            purchaseRatio:
              type: integer
              description: Purchase action ratio (Action ID 109).
              example: 1
            eiRatio:
              type: integer
              example: 1
            tierRatio:
              type: integer
              description: Displays the tier ratio.
              example: 1
            campaignRatioApplied:
              type: string
              description: >-
                Displays whether the campaign ratio is applied or not to the
                product.
              example: true
            campaignRatio:
              type: integer
              description: >-
                Displays the campaign ratio, if a campaign was applied on the
                order.
              example: 1
            pointsRatio:
              type: integer
              description: >-
                Total points ratio (purchaseRatio/campaignRatio whichever is
                higher X eiRatio X tierRatio).
              example: 1
            flatBonusPoints:
              type: integer
              description: >-
                Bonus points applied for this product (if not zero, then it is
                displayed).
              example: 10
        productStatus:
          type: object
          description: Displays the following details.
          properties:
            ship:
              type: integer
              description: Displays the number of products that have been shipped.
              example: 1
            return:
              type: integer
              description: Displays the number of products that have been returned.
              example: 0
            cancel:
              type: integer
              description: Displays the number of products that have been cancelled.
              example: 0
            hold:
              type: integer
              description: Displays the number of products that are on hold.
              example: 1
        orderAttribute:
          type: object
          description: >-
            Displays the order attribute which passes values while creating the
            order (if order attributes have been configured).
          properties:
            MPC:
              type: string
              description: Displays the MPC value.
              example: ABC12345
            MSTN:
              type: string
              description: Displays the MSTN value.
              example: ABC67890
        multiBucketsData:
          type: object
          description: >-
            Displays an array of all multi-bucket details with the following
            fields. Only displays if the multi-bucket flag is enabled.
          properties:
            bucketName:
              type: object
              description: Displays the name of the specific bucket.
              properties:
                credit:
                  type: integer
                  description: Displays the points credited to the bucket for the order
                  example: 100
            tier[bucketName]:
              type: object
              description: Displays the name of the specific bucket.
              properties:
                credit:
                  type: integer
                  description: Displays the points credited to the bucket for the order
                  example: 100
    postCartResp:
      type: object
      description: >-
        This API's response includes the updated order details along with
        potential points including lifetime points, used points and available
        points.
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 123456
        userId:
          type: string
          description: Displays the unique ID of the member.
          example: test@gmail.com
        discountAmount:
          type: integer
          description: Displays the discount amount.
          example: 1234
        shippingAmount:
          type: integer
          description: Displays the amount applied for shipping on the order.
          example: 200
        lifetimePoints:
          type: integer
          description: >-
            Displays the number of points the member has earned in their
            lifetime with the loyalty program.
          example: 200
        usedPoints:
          type: integer
          description: >-
            Displays the total number of points the member has used in their
            lifetime with the loyalty program.
          example: 200
        availablePoints:
          type: integer
          description: >-
            Displays the number of points the member has available in their
            loyalty account.
          example: 200
        holdPoints:
          type: integer
          description: Displays the number of points currently on hold for the member.
          example: 200
        appliedPoints:
          type: integer
          description: >-
            Displays the number of points the member has applied (for
            redemption) on the cart page.
          example: 20
        cartPoints:
          type: integer
          description: >-
            Displays the number of points the member earns after purchasing the
            products in their cart.
          example: 20
        availablePointsAfterOrder:
          type: integer
          description: >-
            Displays the number of available points for the member after placing
            the order.
          example: 20
        holdPointsAfterOrder:
          type: integer
          description: >-
            Displays the number of points on hold for the member after placing
            the order.
          example: 20
        creditsToCurrencyRatio:
          type: integer
          description: >-
            Displays the credits to currency ratio set by the site
            administrator.
          example: 20
        creditsToCurrencyValue:
          type: integer
          description: >-
            Displays the converted value of credits to currency according to the
            ratio.
          example: 20
        creditsToCurrencyValueAfterOrder:
          type: integer
          description: >-
            Displays the credits to currency value of the total available points
            after the order is placed.
          example: 20
        creditsToCurrencyValueCartPoints:
          type: integer
          description: >-
            Displays the credits to the currency value of the current cart if
            the order is placed.
          example: 200
        discountCalulationDisabled:
          type: string
          description: Displays the discount calculation disabled as YES/NO.
          example: 'YES'
        productDetails:
          type: object
          description: >-
            Displays an array of the product details which contains the
            following parameters.
          properties:
            id:
              type: string
              description: Displays the unique ID of the product.
              example: p1
            productName:
              type: string
              description: Displays the name of the product.
              example: ABC
            categoryId:
              type: integer
              description: Displays the category ID of the product.
              example: 23
            categoryName:
              type: string
              description: Displays the category name of the product.
              example: lorem ipsum
            quantity:
              type: integer
              description: Displays the quantity of the product.
              example: 2
            unitPrice:
              type: integer
              description: Displays the unit price of the product.
              example: 230
            points:
              type: integer
              description: >-
                Displays the total number of points the member earns after
                purchasing the product.
              example: 230
            coupon:
              type: string
              description: Displays the coupon code that is applied to the order.
              example: SARL0RXQ12017
            storeId:
              type: string
              description: Displays the unique ID of the store.
              example: IN12369
        multiBucketsData:
          type: object
          description: >-
            Displays an array of all the multi-bucket details with the following
            fields.
          properties:
            bucketName:
              type: object
              description: Displays the name of a specific bucket.
              properties:
                hold[bucketName]:
                  type: integer
                  description: Displays the points on hold for the additional point bucket.
                  example: 100
                releasedDate:
                  type: string
                  description: >-
                    Displays the date the points on hold will be released in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2020-10-30T05:30:00+0000
                available[bucketName]:
                  type: integer
                  description: Displays the total available points of the bucket.
                  example: 300
                lifetime[bucketName]:
                  type: integer
                  description: Displays the total lifetime points of the bucket.
                  example: 0
                available[bucketName]AfterOrder:
                  type: integer
                  description: >-
                    Displays the available points of the bucket after an order
                    is placed.
                  example: null
                lifetime[bucketName]AfterOrder:
                  type: integer
                  description: >-
                    Displays the lifetime points of the bucket after an order is
                    placed.
                  example: 100
        tier[bucketName]:
          type: object
          description: Displays the name of a specific bucket.
          properties:
            holdTier[bucketName]:
              type: integer
              description: Displays the total points of the bucket on hold.
              example: 100
            releasedDate:
              type: string
              description: >-
                Displays the date the points are released in
                yyyy-MM-dd’T’HH:mm:ssZ format.
              example: 2020-10-30T05:30:00+0000
            availableTier[bucketName]:
              type: integer
              description: Displays the available amount of tier points of the bucket.
              example: 100
            lifetimeTier[bucketName]:
              type: integer
              description: Displays the lifetime tier point of the bucket.
              example: 0
            availableTier[bucketName]AfterOrder:
              type: integer
              description: Displays the available tier point after order of the bucket.
              example: 800
            lifetimeTier[bucketName]AfterOrder:
              type: integer
              description: Displays the lifetime tier point after order of the bucket.
              example: 100
        orderAttribute:
          type: object
          description: Displays the following values.
          properties:
            MPC:
              type: string
              description: Displays the MPC value.
              example: abc12345
            MSTN:
              type: string
              description: Displays the MSTN value.
              example: 67890rt
    postManualSpendResp:
      type: object
      properties:
        siteID:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 8767851
        id:
          type: string
          description: Displays the unique ID of the member.
          example: abc1234
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: Order16754
        actionId:
          type: string
          description: Displays action code identifier 164.
          example: 164
        credit:
          type: string
          description: Displays the amount credited to the spend amount.
          example: '50'
        debit:
          type: string
          description: Displays the amount debited from the spend amount.
          example: '50'
        activity:
          type: string
          description: Displays the name of the activity, CREDIT or DEBIT.
          example: CREDIT or DEBIT
        adminEmail:
          type: string
          description: >-
            Displays the email address of the administrator adjusting the spend
            amount.
          example: newmember@hotmail.com
        currentPurchaseRatio:
          type: string
          description: Displays the current purchase ratio.
          example: 2
        currentTierPurchaseRatio:
          type: string
          description: Displays the current tier ratio.
          example: 1
        pointsAwarded:
          type: string
          description: Displays the points awarded due to the credit spend adjustment.
          example: 100
        pointsDeducted:
          type: string
          description: Displays the points deducted due to the debit spend adjustment.
          example: 100
        reason:
          type: string
          description: Displays the reason for the spend adjustment.
          example: Spend has been modified.
        updatedAvailablePoints:
          type: string
          description: Displays the updated number of available points.
          example: 300
        updatedLifetimePoints:
          type: string
          description: >-
            Displays the updated number of points the member has earned in their
            lifetime with the loyalty program.
          example: 500
        totalSpent:
          type: string
          description: Displays the total spend amount for the member to date.
          example: 250
        previousTier:
          type: string
          description: Displays the previous tier for the member before the adjustment.
          example: Silver
        updatedUserTier:
          type: string
          description: Displays the member's updated tier after the adjustment.
          example: Gold
        nextTier:
          type: string
          description: >-
            Displays the name of the next tier which is awarded to the member
            once the required milestones are achieved.
          example: Platinum
        spendAmountToNextTier:
          type: integer
          description: >-
            Displays the amount the member needs to spend to achieve the next
            tier. This is only applicable to tiers where the metric is
            spend-based. If the tier metric is points-based or based on extended
            attributes, it will not show any additional values.
          example: 100
        createDate:
          type: string
          description: >-
            Displays the date in yyyy-MM-dd’T’HH:mm:ssZ format  on which the
            points are awarded to the user.
          example: 2018-04-01T00:00:00-0700
    patchordersresp:
      type: object
      description: >-
        This API's response includes the updated order details for any partial
        or full ships, returns, or cancellations. Each order displays the
        adjustments made to points, discounts, tiers, item quantities, unit
        prices, and more. The responses for each PATCH method (return, ship,
        cancel) are the same other than the multiBucketsData parameter response.
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 123456
        disregardHoldPeriod:
          type: string
          description: >-
            Displays whether the system has successfully disregarded the hold
            period for the points associated with the order. If set to YES, the
            hold period was bypassed, and the points were released to the member
            immediately. If set to NO,  the points are still subject to the
            standard hold period before being released.
          example: 'YES'
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: satestorder1
        pointsRemoved:
          type: integer
          description: Displays the number of points removed from the member's account.
          example: 10
        pointsAwarded:
          type: integer
          description: Displays the total number of points awarded to the member.
          example: 60
        updatedDiscountAmount:
          type: integer
          description: Displays the updated discount amount awarded to the member.
          example: 100
        currentReleasedPoints:
          type: integer
          description: >-
            Displays the current amount of released points available to the
            member.
          example: 30
        pointsExpirationDate:
          type: string
          description: >-
            Displays the points expiration date in yyyy-MM-dd'T'HH:mm:ssZ
            format.
          example: 2020-04-01T00:00:00-0700
        pointsOnHold:
          type: integer
          description: Displays the number of points on hold against the order.
          example: 100
        previousTier:
          type: string
          description: Displays the name of member's previous tier.
          example: Silver
        updatedUserTier:
          type: string
          description: >-
            Displays the name of the member's tier after the update has been
            made.
          example: Gold
        currentTier:
          type: string
          description: >-
            Displays the name of the loyalty member's current tier. For example,
            Bronze, Silver, Gold. The name of the tier is defined by the client
            during configuration of the loyalty program.
          example: Silver
        nextTier:
          type: string
          description: >-
            Displays the name of the next tier which will be awarded to the
            member once the required milestones are achieved.
          example: Platinum
        pointsToNextTier:
          type: integer
          description: >-
            Displays the number of points required to achieve the next tier.
            This depends on the point threshold required to reach the next tier
            and the number of points the member currently has in their account.
          example: 240
        currentTierPurchaseRatio:
          type: integer
          description: >-
            Displays the purchase point ratio that is applied to the member's
            purchases while in their current tier.
          example: 2
        spendAmountToNextTier:
          type: integer
          description: >-
            Displays the amount the member needs to spend to achieve the next
            tier. This is only applicable to tiers where the metric is
            spend-based. If the tier metric is points-based or based on extended
            attributes, it will not show any additional values.
          example: 200
        tierAchievedDate:
          type: string
          description: >-
            Displays the date the current tier was reached by the member in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2020-04-01T00:00:00-0700
        updatedAvailablePoints:
          type: integer
          description: Displays the updated number of available points for the member.
          example: 468
        updatedLifetimePoints:
          type: integer
          description: >-
            Displays the updated number of points the member has earned in their
            lifetime with the loyalty program.
          example: 768
        orderDetail:
          type: object
          description: Displays the product details for the order as shown below.
          properties:
            id:
              type: string
              description: Displays the unique ID of the product.
              example: p1
            quantity:
              type: integer
              description: Displays the quantity of the product.
              example: 2
            unitPrice:
              type: integer
              description: Displays the unit price the product.
              example: 230
            netPrice:
              type: integer
              description: Displays the net price of the product.
              example: 55
            autoDelivery:
              type: string
              description: >-
                Displays YES or NO depending on if the auto delivery system is
                enabled or disabled.
              example: 'YES'
            categoryId:
              type: integer
              description: Displays the category ID of the product.
              example: 23
            categoryName:
              type: string
              description: Displays the category name of the product.
              example: lorem ipsum
            points:
              type: integer
              description: >-
                Displays the number of points the member earned for purchasing
                the product.
              example: 370
        For Partial Ship:
          type: object
          properties:
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi-point bucket details with the
                following fields. Only displays if the multiple point buckets
                are enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays the specific point bucket name.
                  properties:
                    credit:
                      type: integer
                      description: >-
                        Displays the number of points credited to the member's
                        account.
                      example: 100
                    bucketNamecreditToExpireDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd’T’HH:mm:ssZ format on
                        which the tier point expires.
                      example: 2020-10-30T05:30:00+0000
        For Full Ship:
          type: object
          properties:
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi-bucket details with the following
                fields. Only displays if the multi-bucket is enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays the specific point bucket name.
                  properties:
                    credit:
                      type: integer
                      description: >-
                        Displays the number of points credited to the member's
                        account.
                      example: 100
                    bucketNamecreditToExpireDate:
                      type: string
                      description: >-
                        Displays the date in yyyy-MM-dd’T’HH:mm:ssZ format on
                        which the tier point expires.
                      example: 2020-10-30T05:30:00+0000
        For Partial Return:
          type: object
          properties:
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi-bucket details with the following
                fields. Only displays if the multi-bucket is enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays the specific bucket name.
                  properties:
                    debit:
                      type: integer
                      description: >-
                        Displays the number of points debited from the member's
                        account.
                      example: 100
        For Full Return:
          type: object
          properties:
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi-bucket details with the following
                fields. Only displays if the multi-bucket is enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays the specific bucket name.
                  properties:
                    debit:
                      type: integer
                      description: >-
                        Displays the number of points debited from the member's
                        account.
                      example: 100
        For Partial Cancel:
          type: object
          properties:
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi-bucket details with the following
                fields. Only displays if the multi-bucket is enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays the specific bucket name.
                  properties:
                    debit:
                      type: integer
                      description: >-
                        Displays the number of points debited from the member's
                        account.
                      example: 100
        For Full Cancel:
          type: object
          properties:
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi-bucket details with the following
                fields. Only displays if the multi-bucket is enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays the specific bucket name.
                  properties:
                    debit:
                      type: integer
                      description: Displays the debited points of the bucket.
                      example: 100
                    tier[bucketName]:
                      type: object
                      description: Displays the specific bucket name.
                      example: Silver Tier Points
    patchOrdersexistingorderResp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the Annex Cloud site ID for the loyalty program.
          example: 123456
        disregardHoldPeriod:
          type: string
          description: >-
            Displays whether the system has successfully disregarded the hold
            period for the points associated with the order. If set to YES, the
            hold period was bypassed, and the points were released to the member
            immediately. If set to NO,  the points are still subject to the
            standard hold period before being released.
          example: 'YES'
        orderId:
          type: string
          description: Displays the unique ID of the order.
          example: ORDER17840
        pointsOnHold:
          type: integer
          description: >-
            Displays the total points on hold for the member from the placed
            order.
          example: 0
        pointsAwarded:
          type: integer
          description: Displays the total points awarded against the order.
          example: 60
        currentAwardedPoints:
          type: integer
          description: >-
            Displays the points against the current product ID and quantity
            added to the order.
          example: 200
        pointsExpirationDate:
          type: string
          description: >-
            Displays the points expiration date in the following format-
            yyyy-MM-dd'T'HH:mm:ssZ.
          example: 2020-04-01T00:00:00-0700
        updatedAvailablePoints:
          type: integer
          description: >-
            Displays the updated total number of available points for the
            member.
          example: 650
        updatedLifetimePoints:
          type: integer
          description: Displays the updated number of lifetime points for the member.
          example: 2000
        previousTier:
          type: string
          description: >-
            Displays the previous member tier after the points are
            awarded/removed.
          example: Silver
        updatedUserTier:
          type: string
          description: >-
            Displays the updated member tier after the points are
            awarded/removed.
          example: Silver
        orderDetail:
          type: object
          description: Displays the product details for the order as shown below.
          properties:
            id:
              type: string
              description: Displays the unique ID of the product.
              example: p1
            quantity:
              type: integer
              description: Displays the quantity of the product purchased.
              example: 2
            unitPrice:
              type: integer
              description: Displays the unit price of the product.
              example: 230
            points:
              type: integer
              description: >-
                Displays the number of points the member earns after purchasing
                the product.
              example: 370
            currentTier:
              type: string
              description: >-
                Displays the name of the loyalty member's current tier. For
                example, Bronze, Silver, Gold. The name of the tier is defined
                by the client during configuration of the loyalty program.
              example: Silver
            nextTier:
              type: string
              description: >-
                Displays the name of the next tier which is awarded to the
                member once the required milestones are achieved.
              example: Gold
            pointsToNextTier:
              type: integer
              description: >-
                Displays the number of points required to achieve the next tier.
                This depends on the point threshold required to reach the next
                tier and the number of points the member currently has in their
                account.
              example: 100
            currentTierPurchaseRatio:
              type: integer
              description: >-
                Displays the purchase ratio that is applied to the member for
                this tier while earning purchase points.
              example: 1
            spendAmountToNextTier:
              type: integer
              description: >-
                Displays the amount the member needs to spend to achieve the
                next tier. This is only applicable to tiers where the metric is
                spend-based. If the tier metric is points-based or based on
                extended attributes, it will not show any additional values.
              example: 200
            tierAchievedDate:
              type: string
              description: >-
                Displays the current tier achievement date in the following
                format- yyyy-MM-dd'T'HH:mm:ssZ.
              example: 2020-04-01T00:00:00-0700
            secondarykey:
              type: string
              description: >-
                Displays the unique secondary key. The secondary key is an
                essential element in handling orders that contain multiple
                products with the same product ID. If a member wants to return a
                product after the order is shipped, the system may encounter
                issues due to the identical product IDs. However, the secondary
                key comes in handy to differentiate between the products,
                enabling the system to identify each product accurately and
                process partial returns or cancellations of the order
                successfully.
              example: p101
    postActionseriesresp:
      type: object
      properties:
        siteId:
          type: string
          description: >-
            Displays the unique site ID where the loyalty member has performed
            the actions series.
          example: 146031180
        memberName:
          type: string
          description: >-
            Displays the name of the loyalty member who has performed the action
            series.
          example: Smith
        id:
          type: string
          description: >-
            Displays the unique member ID of the loyalty member who has
            performed the actions series.
          example: smith101.sa@gmail.com
        completedActionSeries:
          type: object
          description: >-
            Displays a set of actions that have been successfully finished in a
            specific order.  An "action series" involves a predefined set of
            steps that members need to complete to achieve a milestone.
          properties:
            actionseriesId:
              type: integer
              description: >-
                Displays the unique identifier associated with a specific action
                series in a database.
              example: 123
            actionseriesName:
              type: string
              description: >-
                Displays the name given to a specific series of actions within a
                system. The Action series name describes the nature and purpose
                of the series.
              example: Welcome offer
            actionSeriesType:
              type: string
              description: >-
                Displays the category that a specific series of actions falls
                into within a campaign or loyalty program. The type of action
                series is categorized based on its characteristics, purpose, and
                nature of the tasks involved.
              example: Based on Count
            bonusPoints:
              type: integer
              description: >-
                Displays the additional points that members can earn on
                completing a specific series of actions. The allocation of bonus
                points is typically outlined in the program's rules.
              example: 10
            pointsExpiryDate:
              type: string
              description: >-
                Displays the specific date on which points earned through the
                completion of a series of actions within the campaign or loyalty
                program are set to expire in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            completedDate:
              type: string
              description: >-
                Displays the specific date on which a member successfully
                finishes all the required actions within a series in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            seriesCompletionDate:
              type: string
              description: >-
                Displays the specific date before which a member must
                successfully finish all the required actions within a series in
                yyyy-MM-dd'format.
              example: '2024-06-27'
            milestonesDurationType:
              type: string
              description: >-
                Displays the milestone duration type as rolling, calendar, or
                fixed.
              example: Calendar
            milestonesDuration:
              type: string
              description: >-
                Displays the milestone duration as day, week, month, year, or
                anniversary.
              example: Year
            actionSeriesStatus:
              type: string
              description: >-
                Displays the current status of the action series. It can be
                active or inactive.
              example: Active
            memberActionSeriesStatus:
              type: string
              description: >-
                Displays whether the member has completed or not completed the
                action series.
              example: Completed
            completedMaxPointBonus:
              type: string
              description: >-
                Displays the total bonus points awarded to the member after
                completing the action series milestones.
              example: 45
            pendingMaxPointBonus:
              type: string
              description: >-
                Displays the pending bonus points which will be awarded to the
                member after completing the action series milestones. For
                example, if the maximum point limit is set to 100 and the member
                has already received 45 points as a bonus upon completing the
                action series milestones, the pending bonus points will be 55.
              example: 55
            actionSeriesMaxAchievementCompleted:
              type: integer
              description: >-
                Displays the total number of times the member has earned the
                action series bonus.
              example: 4
            actionSeriesMaxAchievementPending:
              type: integer
              description: >-
                Displays the remaining number of times the member can earn the
                series bonus. For example, if the maximum achievement limit is
                set to 10 and the member has already earned the benefit 4 times,
                the remaining action series achievement count will be 6.
              example: 6
            maxAchievemetLimitDuration:
              type: string
              description: >-
                Displays the time frame within which the member can earn the
                series bonus the maximum number of times if they achieve the
                series milestones. It can be Day, Week, Month, or Year. Note -
                If the time duration is not defined, the default time duration
                is Lifetime.
              example: Year
            maxPointLimitDuration:
              type: string
              description: >-
                Displays the timeframe within which members can earn the maximum
                series bonus points by achieving series milestones. It can be
                Day, Week, Month, or Year. Note - If the time duration is not
                defined, the default time duration is Lifetime.
              example: Year
            requiredPoints:
              type: integer
              description: >-
                Displays the specific number of points that members need to
                accumulate to complete a series of actions. The cumulative total
                of these points determines their progress within the series.
              example: 200
            completedPoints:
              type: integer
              description: >-
                Displays the number of points the member earns upon successfully
                finishing or completing a specific series of actions. Members
                typically accumulate points by completing various tasks or
                activities in a prescribed order.
              example: 900
            pendingPoints:
              type: integer
              description: >-
                Displays the points the member is yet to earn or receive for
                incomplete or pending actions within a specific series.
              example: 30
            totalRewardBenefitCount:
              type: integer
              description: >-
                Displays the total count of reward benefits for each completed
                action series by the loyalty member.
              example: 1
            actionData:
              type: object
              description: >-
                Displays the details of action data associated with the action
                series.
              properties:
                actionId:
                  type: integer
                  description: >-
                    Displays the unique identifier assigned to each specific
                    action within a series.
                  example: 109
                actionName:
                  type: string
                  description: >-
                    Displays the specific name assigned to an individual action
                    within a series in a marketing campaign or loyalty program.
                    Action name is essential for members to navigate through the
                    series effectively, and it helps program administrators
                    communicate clearly about the tasks involved in the overall
                    campaign or program.
                  example: Purchase
                basedOn:
                  type: string
                  description: >-
                    Displays the type of action within a campaign or loyalty
                    program that is linked to the total amount of purchases made
                    by a member. Members often earn credits, points, or other
                    rewards based on the cumulative value of their purchases.
                  example: Based on Spend
            actionSeriesRewardBenefit:
              type: object
              description: >-
                Displays the specific reward benefit details configured in the
                action series. Note - If no reward name is selected, the reward
                benefit object will display blank values against the parameters
                of the reward in the action series.
              properties:
                rewardId:
                  type: string
                  description: >-
                    Displays the reward ID which is associated with the action
                    series reward benefit.
                  example: RewardID001
                rewardName:
                  type: string
                  description: >-
                    Displays the name of the reward associated with the reward
                    ID.
                  example: Welcome Selection
        pendingActionSeries:
          type: object
          description: Displays the details regarding the pending action series.
          properties:
            actionseriesId:
              type: integer
              description: >-
                Displays the unique identifier associated with a specific action
                series in a database. An "Action Series" represents a predefined
                set of actions that members need to complete to achieve a
                milestone.
              example: 109
            actionseriesName:
              type: string
              description: >-
                Displays the name given to a specific series of actions within a
                system. The action series name describes the nature and purpose
                of the series.
              example: Welcome offer
            actionSeriesType:
              type: string
              description: >-
                Displays the category that a specific series of actions falls
                into within a campaign or loyalty program. The type of action
                series is categorized based on its characteristics, purpose, and
                nature of the tasks involved.
              example: Based on Count
            bonusPoints:
              type: integer
              description: >-
                Displays the additional points that members can earn on
                completing a specific series of actions. The allocation of bonus
                points is typically outlined in the program's rules.
              example: 10
            seriesCompletionDate:
              type: string
              description: >-
                Displays the specific date before which a member must
                successfully finish all the required actions within a series in
                yyyy-MM-dd'format.
              example: '2024-06-27'
            actionData:
              type: object
              description: >-
                Displays the details regarding data associated with the action
                series.
              properties:
                actionId:
                  type: integer
                  description: >-
                    Displays the unique identifier assigned to each specific
                    action within a series.
                  example: 109
                actionName:
                  type: string
                  description: >-
                    Displays the specific name assigned to an individual action
                    within a series in a marketing campaign or loyalty program.
                    The action name is essential for members to navigate through
                    the series effectively, and it helps program administrators
                    communicate clearly about the tasks involved in the overall
                    campaign or program.
                  example: Purchase
                requiredCredits:
                  type: integer
                  description: >-
                    Displays the number of credits required for a member to
                    perform a specific action within a campaign or loyalty
                    program. In reward-based loyalty programs, members often
                    earn credits or points by completing various actions, and
                    each action may have a specified credit requirement.
                  example: 100
                completedCredits:
                  type: integer
                  description: >-
                    Displays the points or credits that have been successfully
                    credited to a member's account after they have completed a
                    specific action.In reward-based loyalty programs, members
                    often earn credits or points by completing various actions,
                    and completed credits represent the total earned for a
                    particular action.
                  example: 123
                pendingCredit:
                  type: integer
                  description: >-
                    Displays the number of credits or points that a member is
                    yet to earn for an incomplete or pending action within a
                    campaign or loyalty program. The pending credits represent
                    the potential earnings for actions that are still in
                    progress or not yet fulfilled.
                  example: 100
                basedOn:
                  type: string
                  description: >-
                    Displays the type of action within a campaign or loyalty
                    program that is linked to the total amount of purchases made
                    by a member. Members often earn credits, points, or other
                    rewards based on the cumulative value of their purchases.
                  example: Based on Spend
    getActionSeriesresp:
      type: object
      properties:
        siteId:
          type: string
          description: >-
            Displays the unique site ID where the loyalty member has performed
            the actions series.
          example: 146031180
        memberName:
          type: string
          description: >-
            Displays the name of the loyalty member who has performed the action
            series.
          example: Smith
        id:
          type: string
          description: >-
            Displays the unique member ID of the loyalty member who has
            performed the actions series.
          example: smith101.sa@gmail.com
        completedActionSeries:
          type: object
          description: >-
            Displays a set of actions that have been successfully finished in a
            specific order.  An "action series" involves a predefined set of
            steps that members need to complete to achieve a milestone.
          properties:
            actionseriesId:
              type: integer
              description: >-
                Displays the unique identifier associated with a specific action
                series in a database.
              example: 123
            actionseriesName:
              type: string
              description: >-
                Displays the name given to a specific series of actions within a
                system. The Action series name describes the nature and purpose
                of the series.
              example: Welcome offer
            actionSeriesType:
              type: string
              description: >-
                Displays the category that a specific series of actions falls
                into within a campaign or loyalty program. The type of action
                series is categorized based on its characteristics, purpose, and
                nature of the tasks involved.
              example: Based on Count
            bonusPoints:
              type: integer
              description: >-
                Displays the additional points the members can earn on
                completing a specific series of actions. The allocation of bonus
                points is typically outlined in the program's rules.
              example: 10
            pointsExpiryDate:
              type: string
              description: >-
                Displays the specific date on which points earned through the
                completion of a series of actions within the campaign or loyalty
                program are set to expire in yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            completedDate:
              type: string
              description: >-
                Displays the specific date on which a member successfully
                finishes all the required actions within a series in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2018-04-01T00:00:00-0700
            seriesCompletionDate:
              type: string
              description: >-
                Displays the specific date before which a member must
                successfully finish all the required actions within a series in
                yyyy-MM-dd'format.
              example: '2024-06-27'
            milestonesDurationType:
              type: string
              description: >-
                Displays the milestone duration type as rolling, calendar, or
                fixed.
              example: Calendar
            milestonesDuration:
              type: string
              description: >-
                Displays the milestone duration as day, week, month, year, or
                anniversary.
              example: Year
            actionSeriesStatus:
              type: string
              description: >-
                Displays the current status of the action series. It can be
                active or inactive.
              example: Active
            memberActionSeriesStatus:
              type: string
              description: >-
                Displays whether the member has completed or not completed the
                action series.
              example: Completed
            completedMaxPointBonus:
              type: string
              description: >-
                Displays the total bonus points awarded to the member after
                completing the action series milestones.
              example: 45
            pendingMaxPointBonus:
              type: string
              description: >-
                Displays the pending bonus points that will be awarded to the
                member upon completing the milestone actions. For example, if
                the maximum point limit is set to 100 and the member has already
                received 45 points as a bonus upon completing the action series
                milestones, the pending bonus points will be 55.
              example: 55
            actionSeriesMaxAchievementCompleted:
              type: integer
              description: >-
                Displays the total number of times the member has earned the
                action series bonus.
              example: 4
            actionSeriesMaxAchievementPending:
              type: integer
              description: >-
                Displays the remaining number of times the member can earn the
                series bonus. For example, if the maximum achievement limit is
                set to 10 and the member has already earned the benefit 4 times,
                the remaining action series achievement count will be 6.
              example: 6
            maxAchievemetLimitDuration:
              type: string
              description: >-
                Displays the time frame within which the member can earn the
                series bonus a maximum number of times if they achieve the
                series milestones. It can be day, week, month, or year. Note -
                If the time duration is not defined, the default time duration
                is Lifetime.
              example: Month
            maxPointLimitDuration:
              type: string
              description: >-
                Displays the time frame within which the member can earn maximum
                series bonus points if they achieve series milestones. It can be
                day, week, month, or year. Note - If the time duration is not
                defined, the default time duration is Lifetime.
              example: Month
            requiredPoints:
              type: integer
              description: >-
                Displays the specific number of points the members need to
                accumulate to complete a series of actions. The cumulative total
                of these points determines their progress within the series.
              example: 200
            completedPoints:
              type: integer
              description: >-
                Displays the number of points the member earns upon successfully
                finishing or completing a specific series of actions. Members
                typically accumulate points by completing various tasks or
                activities in a prescribed order.
              example: 900
            pendingPoints:
              type: integer
              description: >-
                Displays the points the member is yet to earn or receive within
                a specific series.
              example: 30
            totalRewardBenefitCount:
              type: integer
              description: >-
                Displays the total count of reward benefits for each completed
                action series by the loyalty member.
              example: 1
            actionData:
              type: object
              description: >-
                Displays the details of action data associated with the action
                series.
              properties:
                actionId:
                  type: integer
                  description: >-
                    Displays the unique identifier assigned to each specific
                    action within a series.
                  example: 109
                actionName:
                  type: string
                  description: >-
                    Displays the specific name assigned to an individual action
                    within a series in a marketing campaign or loyalty program.
                    Action name is essential for members to navigate through the
                    series effectively, and it helps program administrators
                    communicate clearly about the tasks involved in the overall
                    campaign or program.
                  example: Purchase
                basedOn:
                  type: string
                  description: >-
                    Displays the type of action within a campaign or loyalty
                    program that is linked to the total amount of purchases made
                    by a member. Members often earn credits, points, or other
                    rewards based on the cumulative value of their purchases.
                  example: Based on Spend
            actionSeriesRewardBenefit:
              type: object
              description: >-
                Displays the specific reward benefit details configured in the
                action series. Note - If no reward name is selected, the reward
                benefit object will display blank values against the parameters
                of the reward in the action series.
              properties:
                rewardId:
                  type: string
                  description: >-
                    Displays the reward ID which is associated with the action
                    series reward benefit.
                  example: Reward001
                rewardName:
                  type: string
                  description: >-
                    Displays the name of the reward associated with the reward
                    ID.
                  example: Welcome Selection
        pendingActionSeries:
          type: object
          description: Displays the details regarding pending action series.
          properties:
            actionseriesId:
              type: integer
              description: >-
                Displays the unique identifier associated with a specific action
                series in a database. An "Action Series" represents a predefined
                set of actions that members need to complete to achieve a
                milestone.
              example: 109
            actionseriesName:
              type: string
              description: >-
                Displays the name given to a specific series of actions within a
                system. The Action series name describes the nature and purpose
                of the series.
              example: Welcome offer
            actionSeriesType:
              type: string
              description: >-
                Displays the category that a specific series of actions falls
                into within a campaign or loyalty program. The type of action
                series is categorized based on its characteristics, purpose, and
                nature of the tasks involved.
              example: Based on Count
            bonusPoints:
              type: integer
              description: >-
                Displays the additional points the members can earn on
                completing a specific series of actions. The allocation of bonus
                points is typically outlined in the program's rules.
              example: 10
            seriesCompletionDate:
              type: string
              description: >-
                Displays the specific date before which a member must
                successfully finish all the required actions within a series in
                yyyy-MM-dd'format.
              example: '2024-06-27'
            actionData:
              type: object
              description: >-
                Displays the details of action data associated with the action
                series.
              properties:
                actionId:
                  type: integer
                  description: >-
                    Displays the unique identifier assigned to each specific
                    action within a series.
                  example: 109
                actionName:
                  type: string
                  description: >-
                    Displays the specific name assigned to an individual action
                    within a series in a marketing campaign or loyalty program.
                    Action name is essential for members to navigate through the
                    series effectively, and it helps program administrators
                    communicate clearly about the tasks involved in the overall
                    campaign or program.
                  example: Purchase
                requiredCredits:
                  type: integer
                  description: >-
                    Display the number of credits required for a member to
                    perform a specific action within a campaign or loyalty
                    program. In reward-based loyalty programs, members often
                    earn credits or points by completing various actions, and
                    each action may have a specified credit requirement.
                  example: 100
                completedCredits:
                  type: integer
                  description: >-
                    Display the number of credits required for a member to have
                    earned upon completing a specific action within a campaign
                    or loyalty program. In reward-based loyalty programs,
                    members often earn credits or points by completing various
                    actions, and completed credits represent the total earned
                    for a particular action.
                  example: 123
                pendingCredit:
                  type: integer
                  description: >-
                    Displays the number of credits or points the member is yet
                    to earn for an incomplete or pending action within a
                    campaign or loyalty program. The pending credits represent
                    the potential earnings for actions that are still in
                    progress or not yet fulfilled.
                  example: 100
                basedOn:
                  type: string
                  description: >-
                    Displays the type of action series within a loyalty program.
                    There are three types of action series-1. Based on Count 2.
                    Based on Points 3. Based on Points & Count
                  example: Based on Spend
    postbulkpoststoreresp:
      type: object
      properties:
        siteId:
          type: string
          description: >-
            Displays an identifier for the specific site. It is a unique
            numerical code assigned to each site provided by Annex Cloud.
          example: 99483240
        storeId:
          type: string
          description: >-
            Displays an identifier for the specific store. It is a unique
            numerical code assigned to each store.
          example: IN12369
        storeName:
          type: string
          description: Displays the name associated with the particular store.
          example: ShinePulse
        storeAttribute:
          type: object
          description: Displays the following attribute details associated with the store.
          properties:
            attribute:
              type: string
              description: >-
                Displays attribute name and value information, such as
                “country”.
              example: USA
    patchbulkpatchstoreresp:
      type: object
      properties:
        siteId:
          type: string
          description: >-
            Displays an identifier for the specific site. It is a unique
            numerical code assigned to each site provided by Annex Cloud.
          example: 99483240
        storeId:
          type: string
          description: >-
            Displays an identifier for the specific store. It is a unique
            numerical code assigned to each store.
          example: IN12369
        storeName:
          type: string
          description: Displays the name associated with the particular store.
          example: ShinePulse
        storeAttribute:
          type: object
          description: Displays the following attribute details associated with the store.
          properties:
            attribute:
              type: string
              description: >-
                Displays attribute name and value information, such as
                “country”.
              example: USA
    getPoints:
      type: object
      description: >-
        This will return a successful response with the details of the points
        that have been redeemed, awarded, or deducted from the member’s account.
      properties:
        To Redeem Rewards:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 99383640
            id:
              type: string
              description: Displays the unique ID for the member.
              example: user@domain.com
            rewardId:
              type: integer
              description: >-
                Displays the specific reward ID associated with the points that
                the member has redeemed.
              example: 121
            rewardName:
              type: string
              description: Displays the name of the reward.
              example: Premium Member Discount
            rewardCategory:
              type: string
              description: >-
                Displays the category assigned to the loyalty member's reward,
                used to differentiate rewards based on various member types or
                orders.
              example: Nee Reward01
            rewardCategoryId:
              type: integer
              description: Displays the unique identifier assigned to each reward category.
              example: 413
            rewardDescription:
              type: string
              description: Displays the description of the reward.
              example: Get 25% off your first product purchase.
            rewardTerms:
              type: string
              description: Displays the terms of the reward.
              example: >-
                Points can be redeemed for rewards according to the current
                redemption schedule. Rewards may include discounts, merchandise,
                or other specified offers. Rewards are subject to availability
                and may be changed or discontinued at any time without notice.
                By participating in the Loyalty Program, you acknowledge that
                you have read, understood, and agree to abide by these terms and
                conditions.
            activity:
              type: string
              description: Displays debit to indicate points were redeemed.
              example: debit
            orderId:
              type: string
              description: Displays the loyalty member's unique order ID.
              example: 12132ab
            debit:
              type: integer
              description: >-
                Displays the number of points debited from the member’s account
                for redeeming the reward.
              example: 121
            storeDetails:
              type: object
              description: >-
                Displays the following store details associated with the store.
                Note - If a store ID is provided with any action and it exists
                in the metadata, all associated attributes of that store will be
                displayed. If the store ID does not exist in the metadata, it
                will simply display the store ID itself.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the specific store.
                  example: SHELL
                storeExtendedAttribute:
                  type: string
                  description: Displays all the store extended attributes.
                  example: Store Location
            reason:
              type: string
              description: >-
                Displays the reason for deducting points from the member’s
                account.
              example: claim
            customId:
              type: string
              description: >-
                Displays a unique ID to associate with the Action ID to support
                unique transactions.
              example: gadget01
            source:
              type: string
              description: >-
                Displays the source from where the member performed the
                transaction. For example, Web or App.
              example: web
            pointsDeducted:
              type: integer
              description: >-
                Displays the number of points deducted from the member’s account
                for redeeming the reward. (Points deducted refers to the debited
                points from the available points in the member’s account. This
                can be configured in the “Points Deduction Behavior” where
                options like, “Do not Allow Negative Points, Allow Negative
                Points, and Set Balance to Zero” are available).
              example: 300
            groupDebit:
              type: integer
              description: >-
                Displays the total number of points deducted from the group's
                balance as part of the redemption process. (This field is
                visible only if the member belongs to a group; otherwise, it
                will not be included in the response.)
              example: 20
            groupPointsDeducted:
              type: integer
              description: >-
                Displays the specific number of points deducted from the
                member’s point balance. (This field is visible only if the
                member belongs to a group; otherwise, it will not be included in
                the response.)
              example: 20
            rewardCode:
              type: integer
              description: >-
                Displays the reward code used by the member while redeeming the
                reward.
              example: 4260
            rewardCodeExpDate:
              type: string
              description: >-
                Displays the date on which the reward code will expire in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: '2020-10-30T05:30:00'
            updatedUserTier:
              type: string
              description: >-
                Displays the member’s updated tier after points have been
                redeemed and removed.
              example: Gold
            previousTier:
              type: string
              description: >-
                Displays the member’s tier prior to point redemption and
                removal.
              example: Silver
            rewardAttribute:
              type: integer
              description: >-
                Displays name of the extended reward attribute.  Note - These
                attributes should be displayed in every reward ID of the
                configuration.
              example: Vat
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the number of points available in the member’s account
                after points have been redeemed and removed following the
                redemption of rewards.
              example: 4545
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the updated number of points the member has earned in
                their lifetime with the loyalty program.
              example: 7860
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: shirt size
            multiBucketsData[bucketName]:
              type: object
              description: >-
                Displays an array of the additional point buckets where points
                have been redeemed. (This is only applicable if the loyalty
                program is leveraging multiple point buckets).
              properties:
                debit:
                  type: integer
                  description: >-
                    Displays the number of points debited from the additional
                    point bucket after the reward was redeemed by the member.
                  example: 100
                updatedAvailable[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of points available in the
                    additional point bucket after points have been redeemed and
                    removed following the redemption of rewards.
                  example: 200
                updatedLifetime[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of points the member has earned
                    towards the additional point bucket throughout their
                    lifetime with the loyalty program.
                  example: 300
            tier[bucketName]:
              type: object
              description: Displays an array of all multi bucket tier names.
              properties:
                debit:
                  type: integer
                  description: >-
                    Displays the number of points debited from the member’s
                    account tier bucket after the reward was redeemed.
                  example: 100
                updatedAvailableTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of available points in the
                    member’s tier bucket after the reward has been redeemed.
                  example: 500
                updatedLifetimeTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of points the member has earned
                    in the additional tier bucket in their lifetime with the
                    program after the reward has been redeemed.
                  example: 800
        To Redeem Custom Points:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 99383640
            id:
              type: string
              description: Displays the unique ID of the member.
              example: user@domain.com
            actionId:
              type: integer
              description: >-
                Displays the unique action ID for the redemption of custom
                points performed by the member.
              example: 100
            orderId:
              type: string
              description: Displays the loyalty member's unique order ID.
              example: 12132ab
            rewardId:
              type: integer
              description: >-
                Displays the unique reward ID for the redemption of custom
                points configured in the loyalty program.
              example: 12132
            activity:
              type: string
              description: Displays debit to indicate custom points were redeemed.
              example: debit
            debit:
              type: integer
              description: >-
                Displays the number of points debited from the member’s account
                for redeeming custom points by performing the redemption action.
              example: 500
            storeDetails:
              type: object
              description: >-
                Displays the following store details associated with the store.
                Note - If a store ID is provided with any action and it exists
                in the metadata, all associated attributes of that store will be
                displayed. If the store ID does not exist in the metadata, it
                will simply display the store ID itself.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the specific store.
                  example: SHELL
                storeExtendedAttribute:
                  type: string
                  description: Displays all the store extended attributes.
                  example: Store Location
            pointsDeducted:
              type: integer
              description: >-
                Displays the number of points deducted from the member’s account
                for redeeming the custom points.(Points deducted refers to the
                debited points from the available points in the member’s
                account. This can be configured in the “Points Deduction
                Behavior” where options like, “Do not Allow Negative Points,
                Allow Negative Points, and Set Balance to Zero” are available).
              example: 100
            reason:
              type: string
              description: >-
                Displays the reason for removing points from the member’s
                account upon redeeming custom points.
              example: claim
            customId:
              type: string
              description: >-
                Displays a unique ID to associate with the Action ID to support
                unique transactions.
              example: gadget01
            source:
              type: string
              description: >-
                Displays the source from where the member performed the
                transaction. For example, Web or App.
              example: web
            campaignId:
              type: integer
              description: >-
                Displays the campaign ID for the campaign associated with the
                redeemed points.
              example: 12132
            campaignName:
              type: string
              description: >-
                Displays the name of the campaign associated with the points
                being redeemed.
              example: festival bonanza
            campaignPoints:
              type: integer
              description: >-
                Displays the number of campaign points redeemed from the
                member’s account.
              example: 200
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the updated number of available points in the member’s
                account after redeeming the custom points.
              example: 900
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the updated number of points the member has earned in
                their lifetime with the program after redeeming the custom
                points.
              example: 1327
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: shirt size
            previousTier:
              type: string
              description: Displays the member’s tier before redeeming custom points.
              example: Silver
            updatedUserTier:
              type: string
              description: >-
                Displays the member’s updated tier after the points are removed
                for the redemption of custom points.
              example: Gold
        To Award Points:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 99383640
            id:
              type: string
              description: Displays the unique ID of the member.
              example: user@domain.com
            actionId:
              type: integer
              description: >-
                Displays the unique action ID of the action for which the member
                is being awarded points.
              example: 100
            orderId:
              type: string
              description: Displays the loyalty member's unique order ID.
              example: 12132ab
            activity:
              type: string
              description: Displays credit when points are awarded to the member’s account.
              example: credit
            credit:
              type: integer
              description: >-
                Displays the number of points credited into the member’s account
                for performing the action.
              example: 50
            storeDetails:
              type: object
              description: >-
                Displays the following store details associated with the store.
                Note - If a store ID is provided with any action and it exists
                in the metadata, all associated attributes of that store will be
                displayed. If the store ID does not exist in the metadata, it
                will simply display the store ID itself.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the specific store.
                  example: SHELL
                storeExtendedAttribute:
                  type: string
                  description: Displays all the store extended attributes.
                  example: Store Location
            pointType:
              type: string
              description: >-
                Displays the value for the point type parameter, which specifies
                the transaction type for credit and debit activities. For any
                purchase activity the point type displays as a “standard
                transaction activity” and if the member receives any campaign
                benefits or tier benefits, the point type displays as a
                “promotional activity”.
              example: Standard or Promotional
            pointsAwarded:
              type: integer
              description: >-
                Displays the number of points  awarded to the member’s account
                for performing the action.
              example: 50
            reason:
              type: string
              description: Displays the reason for awarding points to the member’s account.
              example: bonus
            customId:
              type: string
              description: >-
                Displays a unique ID to associate with the Action ID to support
                unique transactions.
              example: id12345
            source:
              type: string
              description: >-
                Displays the source from where the member performed the
                transaction. For example, Web or App.
              example: web
            updatedUserTier:
              type: string
              description: >-
                Displays the member’s updated tier after the points are awarded
                to the member’s account.
              example: Gold
            previousTier:
              type: string
              description: >-
                Displays the member’s previous tier before the points were
                awarded to the member’s account.
              example: Silver
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the updated number of available points in the member’s
                account after points have been awarded.
              example: 4545
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the updated total number of points the member has
                earned in their lifetime with the loyalty program after points
                have been awarded.
              example: 7860
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: shirt size
            campaignDetails:
              type: object
              description: >-
                Displays the following information once the campaign milestone
                benefit activity flag is enabled in the super admin.
              properties:
                campaignGroupId:
                  type: integer
                  description: Displays the group ID associated with the campaign.
                  example: 1654
                campaignId:
                  type: integer
                  description: Displays the campaign ID.
                  example: 3692
                campaignName:
                  type: string
                  description: Displays the name of the campaign.
                  example: Back to School Savings
                campaignPoints:
                  type: integer
                  description: >-
                    Displays the campaign points awarded to the member once they
                    achieve the campaign milestones.
                  example: 200
                rewardId:
                  type: integer
                  description: >-
                    Displays the unique ID for the reward configured in the
                    loyalty program.
                  example: 2345
                rewardName:
                  type: string
                  description: Displays the name of the reward used by the member.
                  example: Jockey $15.00 off purchase
                rewardCode:
                  type: string
                  description: Displays the reward code used by the member.
                  example: AP232
        To Award Custom Points:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 99383640
            id:
              type: string
              description: Displays the unique ID of the member.
              example: user@domain.com
            actionId:
              type: integer
              description: >-
                Displays the unique action ID for which the member is being
                awarded custom points.
              example: 100
            orderId:
              type: string
              description: Displays the loyalty member's unique order ID.
              example: 12132ab
            activity:
              type: string
              description: >-
                Displays credit when custom points are awarded to the member’s
                account.
              example: credit
            credit:
              type: integer
              description: >-
                Displays the number of custom points credited to the member’s
                account.
              example: 50
            pointsAwarded:
              type: integer
              description: Displays the number of points awarded to the member's account.
              example: 50
            reason:
              type: string
              description: Displays the reason for awarding points to the member’s account.
              example: bonus
            storeDetails:
              type: object
              description: >-
                Displays the following store details associated with the store.
                Note - If a store ID is provided with any action and it exists
                in the metadata, all associated attributes of that store will be
                displayed. If the store ID does not exist in the metadata, it
                will simply display the store ID itself.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the specific store.
                  example: SHELL
                storeExtendedAttribute:
                  type: string
                  description: Displays all the store extended attributes.
                  example: Store Location
            customId:
              type: string
              description: >-
                Displays a unique ID to associate with the Action ID to support
                unique transactions.
              example: id12345
            sectionId:
              type: string
              description: >-
                Displays the survey section ID associated with the custom points
                awarded. (A survey includes multiple questions for loyalty
                members to answer, and the questions are split into various
                sections to help them comprehend the context of the survey).
              example: 654
            sectionName:
              type: string
              description: >-
                Displays the name of the survey section associated with the
                custom points awarded. (If the member just completes one section
                of the survey, the name of the survey and the section are both
                displayed).
              example: main section
            surveyId:
              type: string
              description: >-
                Displays the unique Survey ID associated with the custom points
                awarded. (This identifier helps in tracking and organizing
                survey responses, ensuring that each response is linked to the
                correct survey and participant).
              example: 123
            surveyName:
              type: string
              description: >-
                Displays the name of the survey associated with the custom
                points awarded. (The surveys for loyalty members have names
                based on their criteria to differentiate and outline the
                contents of the survey in brief. If the member takes the survey,
                the name of the survey in which the member participated is
                displayed).
              example: general survey
            source:
              type: string
              description: >-
                Displays the source from where the member performed the
                transaction. For example, Web or App.
              example: web
            campaignId:
              type: integer
              description: >-
                Displays the campaign ID of the campaign associated with the
                points (if campaign is applied).
              example: 12132
            campaignName:
              type: string
              description: Displays the campaign name associated with the points.
              example: festival bonanza
            campaignPoints:
              type: integer
              description: >-
                Displays the number of campaign points if the campaign benefit
                is applied.
              example: 121
            updatedUserTier:
              type: string
              description: >-
                Displays the member’s updated tier after crediting points to
                their account.
              example: Gold
            previousTier:
              type: string
              description: >-
                Displays the member’s previous tier before the custom points
                were awarded to their account.
              example: Silver
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the number of updated available points after the points
                have been credited to the member’s account.
              example: 4545
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the total number of points the member has earned in
                their lifetime with the loyalty program.
              example: 7860
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: shirt size
            multiBucketsData[bucketName]:
              type: object
              description: >-
                Displays an array of all multi bucket details with the following
                fields.
              properties:
                bucketName:
                  type: object
                  description: Displays an array of all multi bucket names.
                  properties:
                    credit:
                      type: integer
                      description: >-
                        Displays the number of custom points credited to the
                        additional point bucket on the member’s account for
                        performing the action.
                      example: 100
                    ToExpireDate[bucketName]:
                      type: string
                      description: >-
                        Displays the date on which points will expire in
                        yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2020-10-30T05:30:00+0000
                    updatedAvailable[bucketName]:
                      type: integer
                      description: >-
                        Displays the updated number of points available in the
                        additional point bucket after points have been awarded.
                      example: 200
                    updatedLifetime[bucketName]:
                      type: integer
                      description: >-
                        Displays the updated number of points the member has
                        earned towards the additional point bucket in their
                        lifetime with the loyalty program.
                      example: 300
            tier[bucketName]:
              type: object
              description: Displays an array of all multi bucket names.
              properties:
                credit:
                  type: integer
                  description: >-
                    Displays the number of points credited to the member’s
                    account in the tier bucket after the points were awarded.
                  example: 100
                tier[bucketName]ToExpireDate:
                  type: string
                  description: >-
                    Displays the date on which the points will expire in the
                    tier bucket date in yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2020-10-30T05:30:00+0000
                updatedAvailableTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of available points in the
                    member’s account after the custom points were awarded.
                  example: 500
                updatedLifetimeTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of points the member has earned
                    towards the tier bucket in their lifetime with the loyalty
                    program after the custom points were awarded.
                  example: 800
        To Deduct Custom Points:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 99383640
            id:
              type: string
              description: Displays the unique ID of the member.
              example: user@domain.com
            actionId:
              type: integer
              description: >-
                Displays the unique action ID for which custom points are being
                deducted from the member’s account.
              example: 100
            activity:
              type: string
              description: Displays debit to indicate custom points were deducted.
              example: debit
            orderId:
              type: string
              description: Displays the loyalty member's unique order ID.
              example: 12132ab
            debit:
              type: integer
              description: >-
                Displays the number of custom points debited from the member’s
                account.
              example: 50
            storeDetails:
              type: object
              description: >-
                Displays the following store details associated with the store.
                Note - If a store ID is provided with any action and it exists
                in the metadata, all associated attributes of that store will be
                displayed. If the store ID does not exist in the metadata, it
                will simply display the store ID itself.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the specific store.
                  example: SHELL
                storeExtendedAttribute:
                  type: string
                  description: Displays all the store extended attributes.
                  example: Store Location
            pointsDeducted:
              type: integer
              description: >-
                Displays the number of points debited from the member’s account
                for deducting the custom points. (Points deducted refers to the
                debited points from the available points in the member’s
                account. This can be configured in the “Points Deduction
                Behavior” where options like, “Do not Allow Negative Points,
                Allow Negative Points, and Set Balance to Zero” are available).
              example: null
            pointsNotDeducted:
              type: integer
              description: >-
                Displays the points that have not been debited from the member’s
                account.
              example: 50
            reason:
              type: string
              description: >-
                Displays the reason for removing points from the member’s
                account.
              example: adjustment
            customId:
              type: string
              description: >-
                Displays a unique ID to associate with the Action ID to support
                unique transactions.
              example: id12345
            updatedUserTier:
              type: string
              description: >-
                Displays the member’s updated tier after deducting the points
                from their account.
              example: Gold
            previousTier:
              type: string
              description: >-
                Displays the member’s previous tier before deducting the points
                from their account.
              example: Silver
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the number of updated available points after the points
                have been debited from the member’s account.
              example: general survey
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the total number of points the member has earned in
                their lifetime with the loyalty program.
              example: 7860
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: shirt size
            multiBucketsData[bucketName]:
              type: object
              description: >-
                Displays an array of all multi bucket details with the following
                fields.
              properties:
                bucketName:
                  type: object
                  description: Displays an array of all the multi bucket names.
                  properties:
                    debit:
                      type: integer
                      description: >-
                        Displays the number of points debited from the
                        additional point bucket.
                      example: 100
                    updatedAvailable[bucketName]:
                      type: integer
                      description: >-
                        Displays the updated number of points available in the
                        additional point bucket after points have been deducted.
                      example: 200
                    updatedLifetime[bucketName]:
                      type: integer
                      description: >-
                        Displays the updated number of points the member has
                        earned towards the additional point bucket in their
                        lifetime with the loyalty program.
                      example: 300
            tier[bucketName]:
              type: object
              description: Displays an array of all multi bucket names.
              properties:
                debit:
                  type: integer
                  description: >-
                    Displays the number of points debited from the member’s
                    account in the tier bucket.
                  example: 100
                updatedAvailableTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of available points in the
                    member’s tier bucket after the points have been deducted.
                  example: 500
                updatedLifetimeTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the updated number of points the member has earned
                    towards the tier bucket in their lifetime with the loyalty
                    program.
                  example: 800
        Transfer Points between Group Members:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 9991331
            id:
              type: string
              description: Displays the unique ID of the member.
              example: user@domain.com
            activity:
              type: string
              description: Displays debit to indicate points were deducted.
              example: debit
            debit:
              type: integer
              description: >-
                Displays the number of points debited from the group member’s
                account for performing the action.
              example: 10
            pointsDeducted:
              type: integer
              description: >-
                Displays the number of points deducted from the group member’s
                account.
              example: 10
            reason:
              type: string
              description: >-
                Displays the reason for removing points from the group member’s
                account.
              example: claim
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the number of points available in the group member’s
                account after points have been removed.
              example: 250
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the updated number of points the group member has
                earned in their lifetime with the loyalty program.
              example: 250
            previousTier:
              type: string
              description: Displays the group member’s tier prior to points being removed.
              example: Silver
            updatedUserTier:
              type: string
              description: >-
                Displays the member’s updated tier after points have been
                removed.
              example: Gold
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: moto
            hierarchy Data:
              type: object
              description: Displays the details of Hierarchy data.
              properties:
                userId:
                  type: string
                  description: >-
                    Displays the unique ID of the group member whom the points
                    were transferred to.
                  example: user@domain.com
                activity:
                  type: string
                  description: >-
                    Displays credit to indicate that the points are credited to
                    the member’s account.
                  example: credit
                credit:
                  type: integer
                  description: >-
                    Displays the number of points credited to the group member’s
                    account.
                  example: 50
        Transfer Member Points to Group:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 9991331
            id:
              type: string
              description: Displays the unique ID of the member.
              example: user@domain.com
            actionId:
              type: integer
              description: >-
                Displays the unique action ID for the action performed by the
                member. For example, the action ID for transferring points
                within the group is 160.
              example: 160
            activity:
              type: string
              description: >-
                Displays credit in the activity field to indicate that the
                points are being transferred from a member to the group.
              example: credit
            credit:
              type: integer
              description: >-
                Displays the number of points credited or transferred from the
                member’s account when performing the action to credit points to
                the group.
              example: 435
            pointsAwarded:
              type: integer
              description: Displays the number of points  awarded to the group.
              example: 435
            reason:
              type: string
              description: >-
                Displays  the reason for transferring the points from the
                member’s account to the group.
              example: transfer points to group
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the updated number of available points in the member’s
                account after points have been transferred.
              example: 200
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the updated number of points the group member has
                earned in their lifetime with the loyalty program.
              example: 250
            previousTier:
              type: string
              description: >-
                Displays the group member’s previous tier before transferring
                points to group.
              example: Silver
            updatedUserTier:
              type: string
              description: >-
                Displays the group member’s updated tier after transferring the
                points from their account.
              example: Gold
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. Displays the following data if action attributes have
                been associated with the action.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name that has been associated with
                    the action. This attribute is nested within the action
                    attribute object, where the parameter specifies an attribute
                    name and the parameter value enters the shared metadata.
                  example: moto
            hierarchy Data:
              type: object
              description: Displays the details of Hierarchy data.
              properties:
                groupId:
                  type: string
                  description: >-
                    Displays the unique ID of the group within the loyalty
                    program.
                  example: '91'
                activity:
                  type: string
                  description: >-
                    Displays credit to indicate that the points are credited to
                    the group.
                  example: credit
                credit:
                  type: integer
                  description: Displays the number of points credited to the group.
                  example: 50
                groupAvailablePoints:
                  type: integer
                  description: >-
                    Displays the number of available points in the group after
                    the points have been credited.
                  example: 50
            error code:
              type: string
              description: >-
                Displays only when the API request fails, indicating the type of
                error.
              example: error
            error message:
              type: string
              description: Displays the reason why the API request has failed.
              example: fail
        Transfer points between two members:
          type: object
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 9991331
            id:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: user@domain.com
            actionId:
              type: integer
              description: >-
                Displays the unique Action ID for the action performed by the
                member. For example, the custom Action ID for transferring
                points to a member is 8055.
              example: 8055
            activity:
              type: string
              description: >-
                Displays DEBIT in the activity field to indicate that the points
                are being transferred to the receiver.
              example: debit
            debit:
              type: integer
              description: >-
                Displays the number of points debited or transferred to the
                receiver’s account on performing the action.
              example: 20
            pointsDeducted:
              type: integer
              description: >-
                Displays the number of points deducted from the sender’s account
                to be transferred to the receiver’s account.
              example: 20
            pointsNotDeducted:
              type: integer
              description: >-
                Displays the number of points that were not deducted from the
                sender’s account to be transferred to the receiver’s account but
                satisfy the conditions set in the UI that make them eligible to
                be transferred.
              example: 30
            groupDebit:
              type: integer
              description: >-
                Displays the total number of points deducted from the group's
                balance when transferring points between two members. (This
                field is visible only if the sender belongs to a group;
                otherwise, it will not be included in the response.)
              example: 20
            groupPointsDeducted:
              type: integer
              description: >-
                Displays the number of points deducted from the sender’s points
                balance. (This field appears only when the sender is part of a
                group; otherwise, it will not be displayed in the response.)
              example: 20
            updatedAvailablePoints:
              type: integer
              description: >-
                Displays the updated number of available points in the sender’s
                account after points have been transferred.
              example: 200
            reason:
              type: string
              description: >-
                Displays the reason for transferring the points to the
                receiver’s account from the sender’s account.
              example: transfer points request
            updatedLifetimePoints:
              type: integer
              description: >-
                Displays the updated number of points the sender has earned in
                their lifetime with the loyalty program.
              example: 250
            previousTier:
              type: string
              description: >-
                Displays the sender’s previous tier before transferring points
                to the receiver.
              example: Gold
            updatedUserTier:
              type: string
              description: >-
                Displays the sender’s updated tier after transferring the points
                from their account.
              example: Silver
            recipientData:
              type: object
              description: >-
                Displays the following details associated with the receiver of
                points.
              properties:
                recipientId:
                  type: string
                  description: >-
                    Displays the unique identifier of the member who is
                    receiving the points upon the execution of custom Action ID
                    8055.
                  example: r00.00@annexcloud.com
                activity:
                  type: string
                  description: >-
                    Displays the activity being performed due to which the
                    member is sending or receiving the points.
                  example: credit
                credit:
                  type: integer
                  description: >-
                    Displays the number of points being credited to the
                    receiver's account upon the execution of custom action ID
                    8055.
                  example: 20
                campaignId:
                  type: integer
                  description: >-
                    Displays the campaign ID associated with the actions
                    facilitating the transfer of points between two members.
                  example: 3110
                groupCredit:
                  type: integer
                  description: >-
                    Displays the total number of points credited to the
                    recipient's points balance or group balance, depending on
                    the configured settings that allow points to be added to a
                    group balance. This applies when transferring points between
                    two members. (This field is only visible if the recipient
                    belongs to a group; otherwise, it will not be included in
                    the response.)
                  example: 20
                groupId:
                  type: string
                  description: >-
                    Displays the specific Group ID that the recipient belongs
                    to. (This field appears only when the recipient is part of a
                    group; otherwise, it will not be displayed in the response.)
                  example: '91'
                campaignName:
                  type: string
                  description: >-
                    Displays the campaign name associated with the actions
                    facilitating the transfer of points between two members.
                  example: PBL-1220 campaign
                campaignPoints:
                  type: integer
                  description: >-
                    Displays the number of points transferred according to the
                    configured conditions.
                  example: 0
    getpointsExpiryid_page:
      type: object
      description: >-
        This will return the details of the member’s expired points on the
        selected page within the specified date range.
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: 146031180
        id:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        expiryDetail:
          type: object
          description: Displays the point expiration details for the member.
          properties:
            date:
              type: string
              description: >-
                Depending on the aggregate_by value, the time block for which
                expired points have been aggregated.
              example: 2024-04
        pointsActivity:
          type: object
          description: Displays points details for the time block.
          properties:
            points:
              type: integer
              description: >-
                Displays the number of data points that appear on the page for
                the expiration details for the selected member.
              example: 2010
            expiryDate:
              type: string
              description: >-
                Displays the date on which the points expired in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-28T06:02:06+0000
            totalPointsToExpire:
              type: integer
              description: >-
                Displays the total number of points next to expire from the
                selected date range.
              example: 2010
            totalPointsExpired:
              type: integer
              description: >-
                Displays the total number of expired points for the member from
                the selected date range. The total number of points that have
                expired are calculated based on two action IDs (106 and 192).
              example: 0
        pages:
          type: integer
          description: >-
            Displays the total number of pages for the member’s point expiration
            details.
          example: 1
        currentPage:
          type: integer
          description: Displays the page number for the fetched member details.
          example: 1
        totalExpiryDetailCount:
          type: integer
          description: >-
            Displays the total number of point expiration details for the
            member.
          example: 2
    createBulkproducts:
      type: object
      description: >-
        On successful adding of bulk product details, the responses listed below
        are updated.
      properties:
        siteId:
          type: string
          description: Displays the unique internal Site ID.
          example: 9992280
        pointAwardType:
          type: string
          description: Displays the Point Award Type (Product or Category).
          example: Product
        productDetail:
          type: object
          description: Displays the created product details.
          properties:
            productId:
              type: string
              description: Displays the Product ID
              example: 12345
            productName:
              type: string
              description: Displays the Product Name
              example: Go Go Gadget Pro
            productPrice:
              type: integer
              description: Displays the price of one unit of the product.
              example: 105
            productPointType:
              type: string
              description: >-
                Displays the Product Point Type. No - No points awarded, Yes -
                Points awarded, Bonus - Bonus points awarded.
              example: 'Yes'
            productPointRatio:
              type: integer
              description: >-
                Displays the point ratio for the product. A ratio is a
                multiplier applied to a point award based on specific criteria
                (Product, Tier, Category, Campaign) For example, if the
                productPointRatio is 3, the points awarded are multiplied by 3.
              example: 2
            bonusPoint:
              type: integer
              description: >-
                If the productPointType is Bonus, displays the bonus amount for
                the product.
              example: 10
            bonusflag:
              type: string
              description: >-
                Displays the status of a flag whether the Product Bonus applies.
                (Yes/No).
              example: 'Yes'
            productMinimumLimit:
              type: integer
              description: >-
                Displays the minimum number of units that must be purchased to
                award points.
              example: 10
        categoryDetail:
          type: object
          description: Displays the created category details of the product.
          properties:
            categoryId:
              type: string
              description: Displays the Category ID of the product.
              example: Cat1
            categoryName:
              type: string
              description: Displays the Category Name of product.
              example: Gadgets
            categoryPointType:
              type: string
              description: >-
                Displays the category Point Type. No - No points awarded, Yes -
                Points awarded, Bonus - Bonus points awarded.
              example: 'Yes'
            categoryPointRatio:
              type: integer
              description: >-
                Displays the point ratio for the category. A ratio is a
                multiplier applied to a point award based on specific criteria
                (Product, Tier, Category, Campaign) For example, if the
                categoryPointRatio is 3, the points awarded are multiplied by 3.
              example: 2
            categoryBonus:
              type: integer
              description: >-
                If the categoryPointType is Bonus, displays the bonus amount for
                the category.
              example: 10
            categoryBonusFlag:
              type: string
              description: >-
                Displays the status of the flag whether the Category Bonus
                applies. (Yes/No).
              example: 'Yes'
            categoryMaxPoints:
              type: integer
              description: >-
                Displays the maximum points that can be awarded if category
                limit capping is enabled.
              example: 30
            categoryLimitType:
              type: string
              description: >-
                If the category limit capping flag is enabled, displays the
                category limit type. Rolling or Calendar
              example: Rolling
            categoryLimitPeriod:
              type: string
              description: >-
                Displays the category limit period. If the categoryLimitType is
                Rolling the value is the number of days. If calendar then
                Day/Month/Year. Applies if category limit capping flag is
                enabled.
              example: Day
        productAttributes:
          type: object
          description: Displays the product attributes for the created product.
          properties:
            upc:
              type: string
              description: Displays the Universal Product Code (UPC) of product.
              example: U24041202
            mpn:
              type: string
              description: Displays the Manufacturer Part Number (MPN) of the product.
              example: PPSR12345
            gtin:
              type: string
              description: Displays the Global Trade Item Number (GTIN) of the product.
              example: HSI US Dental
            brandId:
              type: string
              description: Displays the Brand ID of the product.
              example: VOLLRA
        limits:
          type: object
          description: Displays the category product limits.
          properties:
            productOrderPointsLimit:
              type: integer
              description: >-
                Displays the maximum points that can be earned on an order that
                includes the product.
              example: 5
            productLifetimePointsLimit:
              type: integer
              description: >-
                Displays the maximum lifetime points that can be earned on
                purchases of the product.
              example: 3
            categoryOrderPointsLimit:
              type: integer
              description: >-
                Displays the maximum number of points that can be earned on
                purchases in the product category.
              example: 4
            categoryLifetimePointsLimit:
              type: integer
              description: >-
                Displays the maximum lifetime point limit on purchases in the
                product category.
              example: 4
    postbulkpatchproductsresp:
      type: object
      description: >-
        On successful adding of product details in bulk, the responses listed
        below are updated.
      properties:
        siteId:
          type: string
          description: Displays the unique Site ID.
          example: 9992280
        pointAwardType:
          type: string
          description: Displays the point award type (Product or Category).
          example: Product
        productDetail:
          type: object
          description: Displays the created product details.
          properties:
            productId:
              type: string
              description: Displays the Product ID
              example: 12345
            productName:
              type: string
              description: Displays the Product Name of Product.
              example: Go Go Gadget Pro
            productPrice:
              type: integer
              description: Displays the Unit Price of Product.
              example: 105
            productPointType:
              type: string
              description: >-
                Displays the Product Point Type. No - No points awarded, Yes -
                Points awarded, Bonus - Bonus points awarded.
              example: 'Yes'
            productPointRatio:
              type: integer
              description: >-
                Displays the point ratio for the product. A ratio is a
                multiplier applied to a point award based on specific criteria
                (Product, Tier, Category, Campaign) For example, if the
                productPointRatio is 3, the points awarded are multiplied by 3.
              example: 2
            bonusPoint:
              type: integer
              description: >-
                If the productPointType is Bonus, displays the bonus amount for
                the product.
              example: 10
            bonusflag:
              type: string
              description: >-
                Displays the status of a flag whether the Product Bonus applies.
                (Yes/No).
              example: 'Yes'
            productMinimumLimit:
              type: integer
              description: >-
                Displays the minimum number of units that must be purchased for
                points to be awarded.
              example: 2
        categoryDetail:
          type: object
          description: Displays the created category details for the product.
          properties:
            categoryId:
              type: string
              description: Displays the unique Category ID for the Product.
              example: Cat1
            categoryName:
              type: string
              description: Displays the Category Name for the product
              example: Gadgets
            categoryPointType:
              type: string
              description: >-
                Displays the category Point Type. No - No points awarded, Yes -
                Points awarded, Bonus - Bonus points awarded.
              example: 'Yes'
            categoryPointRatio:
              type: integer
              description: >-
                Displays the point ratio for the category. A ratio is a
                multiplier applied to a point award based on specific criteria
                (Product, Tier, Category, Campaign) For example, if the
                categoryPointRatio is 3, the points awarded are multiplied by 3.
              example: 2
            categoryBonus:
              type: integer
              description: >-
                If the categoryPointType is Bonus, displays the bonus amount for
                the category.
              example: 10
            categoryBonusFlag:
              type: string
              description: >-
                Displays the status of the flag whether the Category Bonus
                applies. (Yes/No).
              example: 'Yes'
            categoryMaxPoints:
              type: integer
              description: >-
                Displays the maximum points that can be awarded if category
                limit capping is enabled.
              example: 5
            categoryLimitType:
              type: string
              description: >-
                If the category limit capping flag is enabled, displays the
                category limit type. Rolling or Calendar.
              example: Rolling
            categoryLimitPeriod:
              type: string
              description: >-
                Displays the category limit period. If the categoryLimitType is
                Rolling the value is the number of days. If calendar then
                Day/Month/Year. Applies if category limit capping flag is
                enabled.
              example: Day
        productAttributes:
          type: object
          description: Displays the product Attributes for created product.
          properties:
            upc:
              type: string
              description: Displays the Universal Product Code (UPC) of product.
              example: U24041202
            mpn:
              type: string
              description: Displays the Manufacturer Part Number (MPN) of the product.
              example: PPSR12345
            gtin:
              type: string
              description: Displays the Global Trade Item Number (GTIN) of the product.
              example: YesHSI US Dental
            brandId:
              type: string
              description: Displays the Brand ID of the product.
              example: VOLLRA
        limits:
          type: object
          description: Displays the category product limits.
          properties:
            productOrderPointsLimit:
              type: integer
              description: >-
                Displays the maximum points that can be earned on an order that
                includes the product.
              example: 50
            productLifetimePointsLimit:
              type: integer
              description: >-
                Displays the maximum lifetime points that can be earned on
                purchases of the products.
              example: 300
            categoryOrderPointsLimit:
              type: integer
              description: >-
                Displays the maximum number of points that can be earned on
                purchases in the product category.
              example: 400
            categoryLifetimePointsLimit:
              type: integer
              description: >-
                Displays the maximum lifetime point limit on purchases in the
                product category.
              example: 400
    createProduct:
      type: object
      properties:
        Get Product Details:
          type: object
          properties:
            categoryId:
              type: object
              description: >-
                If Category ID is not null in the request body, the response
                groups all products under the Category ID. If Category ID is
                null in the request body, this field does not appear in the
                response. The response includes only details for the specified
                Product ID.
              properties:
                siteId:
                  type: string
                  description: Displays the Site ID.
                  example: 9992280
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: Pro1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: Go Go Gadget Pro
                productPrice:
                  type: integer
                  description: Displays the unit price for the product.
                  example: 100
                productPointType:
                  type: string
                  description: >-
                    Displays the Product Point Type. No - No points awarded, Yes
                    - Points awarded, Bonus - Bonus points awarded.
                  example: 'Yes'
                productMinimumLimit:
                  type: string
                  description: >-
                    Displays the minimum number of units that must be purchased
                    to award points.
                  example: 5
                productPointRatio:
                  type: string
                  description: >-
                    Displays the point ratio for the product. A ratio is a
                    multiplier applied to a point award based on specific
                    criteria (Product, Tier, Category, Campaign) For example, if
                    productPointRatio is 3, the points awarded are multiplied by
                    3.
                  example: 2
                bonusPoint:
                  type: integer
                  description: >-
                    If productPointType is Bonus, displays the bonus or flat
                    points to be awarded on the purchase of the product.
                  example: 10
                bonusflag:
                  type: string
                  description: >-
                    Displays the status of a flag whether the Product Bonus
                    applies. (Yes/No).
                  example: 'Yes'
                categoryId:
                  type: string
                  description: Displays the Category ID of the product.
                  example: 1250
                categoryName:
                  type: string
                  description: Displays the Category Name of the product.
                  example: Gadgets
                categoryPointType:
                  type: string
                  description: >-
                    Displays the Category Point Type- No- No points awarded
                    --Yes- Points awarded --Bonus- Bonus points awarded
                  example: 'Yes'
                categoryPointRatio:
                  type: string
                  description: >-
                    Displays the point ratio for the category. A ratio is a
                    multiplier applied to a point award based on specific
                    criteria (Product, Tier, Category, Campaign) For example, a
                    productPointRatio of "2" multiplies awarded points by 2.
                  example: 2
                categoryBonus:
                  type: integer
                  description: >-
                    If the categoryPointType is Bonus, displays the bonus point
                    amount for the category.
                  example: 10
                categoryBonusFlag:
                  type: string
                  description: Displays the flag of category of product (Yes/No).
                  example: 'Yes'
                categoryLimitPeriod:
                  type: string
                  description: >-
                    Displays the Category Limit Period. If categoryLimitType is
                    Rolling the value is the number of days. If Calendar then
                    Day/Month/Year. Applies if category limit capping flag is
                    enabled.
                  example: 180
                categoryLimitType:
                  type: string
                  description: >-
                    For the Max Points field, displays the category limit type.
                    Rolling or Calendar
                  example: Rolling
                categoryMaxPoints:
                  type: integer
                  description: >-
                    Displays the maximum points that can be awarded based on the
                    value in the Max Points field on the Category Master page in
                    Product Catalog Management.
                  example: 20
                upc:
                  type: string
                  description: Displays the Universal Product Code (UPC) of product.
                  example: 2404120a
                mpn:
                  type: string
                  description: Displays the Manufacturer Part Number (MPN) of the product.
                  example: PPSR12345
                gtin:
                  type: string
                  description: Displays the Global Trade Item Number (GTIN) of product.
                  example: HSI US Dental
                brandId:
                  type: string
                  description: Displays the Brand ID of the product.
                  example: VOLLRA
                productOrderPointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum points that can be earned on an order
                    that includes the product.
                  example: 200
                productLifetimePointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum lifetime points that can be earned on
                    purchases of the product.
                  example: 300
                categoryOrderPointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum number of points that can be earned on
                    purchases in the product category.
                  example: 300
                categoryLifetimePointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum lifetime point limit on purchases in
                    the product category.
                  example: 400
                pointAwardType:
                  type: string
                  description: Displays the award Type (Product or Category).
                  example: Product
        Create New Product:
          type: object
          properties:
            siteId:
              type: string
              description: Displays the unique site ID.
              example: 9992280
            pointAwardType:
              type: string
              description: Displays the award Type (Product/Category).
              example: Product
            productDetail:
              type: object
              properties:
                productId:
                  type: string
                  description: Displays the Product ID.
                  example: Pro1
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: Go Go Gadget Pro
                productPrice:
                  type: integer
                  description: Displays the price for a single item.
                  example: 100
                productPointType:
                  type: string
                  description: >-
                    Displays the Product Point Type. No - No points awarded, Yes
                    - Points awarded, Bonus - Bonus points awarded.
                  example: 'Yes'
                productPointRatio:
                  type: string
                  description: >-
                    Displays the point ratio for the product. A ratio is a
                    multiplier applied to a point award based on specific
                    criteria (Product, Tier, Category, Campaign) For example, a
                    productPointRatio of "3" multiplies awarded points by 3.
                  example: 2
                bonusPoint:
                  type: integer
                  description: >-
                    If the productPointType is Bonus, displays the bonus amount
                    for the product.
                  example: 10
                bonusflag:
                  type: string
                  description: >-
                    Displays the status of the flag for whether the Product
                    Bonus applies. (Yes/No).
                  example: 'Yes'
                productMinimumLimit:
                  type: integer
                  description: >-
                    Displays the minimum number of units that must be purchased
                    to award points.
                  example: 10
            categoryDetail:
              type: object
              properties:
                categoryId:
                  type: string
                  description: Displays the Category ID for the product.
                  example: Cat1
                categoryName:
                  type: string
                  description: Displays the Category Name for the product.
                  example: Gadgets
                categoryPointType:
                  type: string
                  description: >-
                    Displays the Category Point Type. --No- No points awarded
                    --Yes- Points awarded --Bonus- Bonus points awarded
                  example: 'Yes'
                categoryPointRatio:
                  type: string
                  description: >-
                    Displays the point ratio for the category. A ratio is a
                    multiplier applied to a point award based on specific
                    criteria (Product, Tier, Category, Campaign) For example, if
                    the categoryPointRatio value is 3, awarded points are
                    multiplied by 3.
                  example: 2
                categoryBonus:
                  type: integer
                  description: >-
                    If the categoryPointType is Bonus, displays the bonus amount
                    for the category.
                  example: 10
                categoryBonusFlag:
                  type: string
                  description: >-
                    Displays the status of a flag whether the Category Bonus
                    applies. (Yes/No).
                  example: 'Yes'
                categoryMaxPoints:
                  type: integer
                  description: >-
                    Displays the maximum points that can be awarded if category
                    limit capping is enabled.
                  example: 30
                categoryLimitType:
                  type: string
                  description: >-
                    If the category limit capping flag is enabled, displays the
                    category limit type. Rolling or Calendar
                  example: Rolling
                categoryLimitPeriod:
                  type: string
                  description: >-
                    Displays the category limit period. If the categoryLimitType
                    is Rolling the value is the number of days. If calendar then
                    Day/Month/Year. Applies if category limit capping flag is
                    enabled.
                  example: 180
            productAttributes:
              type: object
              properties:
                upc:
                  type: string
                  description: Displays the Universal Product Code (UPC) of product.
                  example: U24041202
                mpn:
                  type: string
                  description: Displays the Manufacturer Part Number (MPN) of the product.
                  example: PPSR12345
                gtin:
                  type: string
                  description: Displays the Global Trade Item Number (GTIN) of the product.
                  example: HSI US Dental
                brandId:
                  type: string
                  description: Displays the Brand ID of the product.
                  example: VOLLRA
            limits:
              type: object
              description: Displays the category product limits.
              properties:
                productOrderPointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum points that can be earned on an order
                    that includes the product.
                  example: 25
                productLifetimePointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum lifetime points that can be earned on
                    purchases of the products.
                  example: 300
                categoryOrderPointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum number of points that can be earned on
                    purchases in the product category.
                  example: 400
                categoryLifetimePointsLimit:
                  type: integer
                  description: >-
                    Displays the maximum lifetime point limit on purchases in
                    the product category.
                  example: 400
        Get Product Point Calculation for an Order:
          type: object
          properties:
            siteId:
              type: string
              description: Displays the unique site ID.
              example: 9992280
            id:
              type: string
              description: Displays the member's User ID.
              example: Product
            data:
              type: object
              description: Displays the order details.
              properties:
                id:
                  type: string
                  description: Displays the Product ID.
                  example: 12345
                categoryId:
                  type: string
                  description: Displays the Category ID of the product.
                  example: 1
                secondarykey:
                  type: string
                  description: Displays the Secondary Key.
                  example: abc234
                productName:
                  type: string
                  description: Displays the Product Name.
                  example: Go Go Gadget Pro
                categoryName:
                  type: string
                  description: Displays the Category Name of the product.
                  example: Gadgets
                quantity:
                  type: string
                  description: Displays the number of units of the product purchased.
                  example: 2
                unitPrice:
                  type: string
                  description: Displays the Unit Price of the product
                  example: 105
                autoDelivery:
                  type: string
                  description: Displays the status of the auto delivery flag.
                  example: 'Yes'
                netPrice:
                  type: integer
                  description: Displays the net price of the purchase.
                  example: 210
                points:
                  type: integer
                  description: >-
                    Displays the number of points the member will earn after
                    purchasing that product.
                  example: 420
                calculation:
                  type: string
                  description: >-
                    Displays the calculation used to determine the potential
                    points a member earns after purchasing the product,
                    considering various ratios (purchase, product, tier) and
                    quantity. This calculation will consider the flat points
                    defined in the product catalog. Note - If the Purchase Point
                    Type in purchase action is set to “Only Flat Points“ and
                    “Apply All Ratios in Flat Points“ flag is ON, all applicable
                    ratios will be applied to flat points and included in the
                    calculation. Calculation- purchase ratio (2) * tier ratio
                    (2) * flat points (100) * quantity (2). If the Purchase
                    Point Type in purchase action is set to “Only Flat Points“
                    and “Apply All Ratios in Flat Points“ flag is OFF, only flat
                    points will be considered in calculations with
                    multiplication by quantity. Calculation- flat points (100) *
                    quantity (2)
                  example: >-
                    purchase ratio (3) * tier ratio (2) * flat points (100) *
                    quantity (2)
                pointsRatio:
                  type: integer
                  description: >-
                    Displays the total points ratio derived from the
                    configuration and point calculation logic, calculated as the
                    higher of the purchaseRatio or campaignRatio, multiplied
                    with tierRatio. Formula for “when apply all ratios flag is
                    enabled” maxRatio = max(campaignRatio, purchaseRatio).
                    Points Earned = FlatBonusPoints * quantity * maxRatio *
                    tierRatio. When the 'Apply All Ratios' flag is disabled, and
                    no ratios are applied to the product calculations, the
                    system will display a value of zero
                  example: 6
            multiBucketsData:
              type: object
              description: >-
                Displays an array of all multi bucket details with the following
                fields. If multi bucket is enabled.
              properties:
                bucketName:
                  type: object
                  description: Displays an array of all additional point bucket names.
                  properties:
                    holdPoint:
                      type: integer
                      description: Displays the points on hold in the additional bucket.
                      example: 100
                    releasedDate:
                      type: string
                      description: >-
                        Displays the release date for the points on hold in
                        yyyy-MM-dd’T’HH:mm:ssZ format.
                      example: 2020-10-30T05:30:00+0000
                    available [bucketName]:
                      type: integer
                      description: Displays the available points in the bucket.
                      example: 300
                    lifetimePoint:
                      type: integer
                      description: >-
                        Displays the points earned by the member towards the
                        additional point bucket in their lifetime with the
                        loyalty program.
                      example: 300
                    available [bucketName]AfterOrder:
                      type: integer
                      description: >-
                        Displays the available points in the bucket after the
                        order.
                      example: 200
                    Lifetime[bucketName]AfterOrder:
                      type: integer
                      description: >-
                        Displays the points earned by the member towards the
                        additional point bucket in their lifetime with the
                        loyalty program after the order.
                      example: 200
    getProductInfo:
      type: object
      description: This will retrieve the information for the product.
      properties:
        siteId:
          type: string
          description: Displays the unique Site ID.
          example: 123456
        productId:
          type: integer
          description: Displays the Product ID.
          example: 12345
        productName:
          type: string
          description: Displays the Product Name.
          example: Go Go Gadget Pro
        productPrice:
          type: integer
          description: Displays the price per unit for the product.
          example: 105
        productPointType:
          type: string
          description: >-
            Displays the Product point type No - No points awarded, Yes - Points
            awarded Bonus - Bonus points awarded
          example: 'Yes'
        productMinimumLimit:
          type: integer
          description: >-
            Displays the minimum number of units that must be purchased to award
            points.
          example: 10
        productPointRatio:
          type: integer
          description: >-
            Displays the point ratio for the product. A ratio is a multiplier
            applied to a point award based on specific criteria (Product, Tier,
            Category, Campaign) For example, if the productPointRatio value is
            3, awarded points are multiplied by 3.
          example: 1
        bonusPoint:
          type: integer
          description: >-
            If the productPointType is Bonus, displays the bonus amount for the
            product.
          example: 100
        bonusFlag:
          type: string
          description: >-
            Displays the status of the flag whether the Product bonus applies.
            (Yes/No).
          example: 'Yes'
        categoryId:
          type: string
          description: Displays the category ID of the product.
          example: Cat1
        categoryName:
          type: string
          description: Displays the Category Name.
          example: Gadgets
        categoryPointType:
          type: string
          description: >-
            Displays the Category point type. No - No points awarded, Yes -
            Points awarded Bonus - Bonus points awarded
          example: 'Yes'
        categoryPointRatio:
          type: integer
          description: >-
            Displays the point ratio for the category. A ratio is a multiplier
            applied to a point award based on specific criteria (Product, Tier,
            Category, Campaign) For example, if the categoryPointRatio value is
            3, awarded points are multiplied by 3.
          example: 2
        categoryBonus:
          type: integer
          description: >-
            If the categoryPointType is Bonus, displays the bonus amount for the
            category.
          example: 20
        categoryBonusFlag:
          type: string
          description: >-
            Displays the status of a flag whether the Category Bonus applies.
            (Yes/No).
          example: 'Yes'
        categoryMaxPoints:
          type: integer
          description: >-
            Displays the maximum points that can be awarded if Category Limit
            Capping is enabled.
          example: 20
        categoryLimitType:
          type: string
          description: >-
            If the Category Limit Capping flag is enabled, displays the category
            limit type. Rolling or Calendar.
          example: Rolling
        categoryLimitPeriod:
          type: string
          description: >-
            Displays the Category Limit Period. If the categoryLimitType is
            Rolling the value is the number of days. If calendar then
            Day/Month/Year. Applies if category limit capping flag is enabled.
          example: Day
        upc:
          type: string
          description: Displays the Universal Product Code (UPC) of the product.
          example: 2404120a
        mpn:
          type: string
          description: Displays the Manufacturer Part Number (MPN) of the product.
          example: PPSR12345
        gtin:
          type: string
          description: Displays the Global Trade Item Number (GTIN) of the product.
          example: HSI US Dental
        brandId:
          type: string
          description: Displays the Brand ID of the product.
          example: VOLLRA
        productOrderPointsLimit:
          type: string
          description: >-
            Displays the maximum points that can be earned on an order that
            includes the product.
          example: 5
        productLifetimePointsLimit:
          type: string
          description: >-
            Displays the maximum lifetime points that can be earned on purchases
            of the product.
          example: 3
        categoryOrderPointsLimit:
          type: string
          description: >-
            Displays the maximum number of points that can be earned on
            purchases of products in the category.
          example: 4
        categoryLifetimePointsLimit:
          type: string
          description: >-
            Displays the maximum lifetime point limit on purchases in the
            product category.
          example: 4
        pointAwardType:
          type: string
          description: Displays the point award type (Product or Category).
          example: Product
    getactivityresp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: '29235480'
        activityDetail:
          type: object
          description: Displays the following parameters.
          properties:
            rewardCode:
              type: string
              description: >-
                Displays the unique reward code shared with the member. If there
                is a coupon code associated with the action, it will be
                displayed here.
              example: $30-OFF
            actionId:
              type: integer
              description: >-
                Displays the unique action ID for the action performed by the
                member. For example, the action ID for manual credit/debit is
                100, while the action ID for purchase is 109.
              example: 109
            activityId:
              type: string
              description: >-
                Displays the unique identifier for a specific activity
                associated with the given memberID. This activityId is used to
                track and reference individual user activities, enabling the
                retrieval of detailed activity information.
              example: 550e8400-e29b-41d4-a716-446655440000
            activity:
              type: string
              description: >-
                Displays the name of the action performed by the member. It can
                be credit or debit.
              example: Credit
            credit:
              type: integer
              description: >-
                Displays the number of points credited to the member’s account
                for taking the action.
              example: 100
            pointType:
              type: string
              description: >-
                Displays the value for the point type parameter, which specifies
                the transaction type for credit and debit activities. The point
                type returns four types of values- Standard, Promotional,
                Reversal Standard, and Reversal Promotion. If the user has
                explicitly passed a value for the point type using the Point
                API, that value is overwritten by the Activity API response. If
                the user sets the point type value to “Regular”, it should
                display as “Regular” in Point API response and overwrite the
                existing point value in the activity API response. If the point
                type parameter is included in the Point API payload but no value
                is provided, the system will throw an error indicating that the
                point type should not be blank. If the point type is not
                included, the current behavior is that the point response will
                not display the point type parameter and it’s value.
              example: Standard or Promotional
            pointStatus:
              type: string
              description: >-
                Displays the point status as hold, redeemed, or released. The
                point status may show as hold if you have elected to hold points
                from members for a defined number of days after the action is
                completed when configuring your program. Otherwise, the point
                status will show as released or redeemed.
              example: Released
            rewardAttribute:
              type: string
              description: >-
                Displays the name of the extended reward attribute. Note - These
                attributes should be displayed in every reward ID of the
                configuration. Note - The data type can be INT, DECEIMAL,
                VARCHAR, DATE, or DATETIME.
              example: Vat
            actionAttribute:
              type: object
              description: >-
                Action attributes allow you to capture additional metadata about
                an action. It displays the following data. Note - This
                information will only be displayed if the Validate Extended
                Attribute Values flag is enabled in the action rules.
              properties:
                attributeValue:
                  type: string
                  description: >-
                    Displays the attribute name which is added to the action.
                    This is nested in the action attribute object, where the
                    parameter specifies an attribute name, while the parameter
                    value displays the shared metadata.
                  example: Mobile
            displayText:
              type: string
              description: >-
                Displays a brief description of the action performed by the
                member. It can be customized by the administrator while creating
                an action.
              example: Debit
            campaignId:
              type: integer
              description: >-
                Displays the campaign ID of the campaign associated with the
                activity.
              example: 105
            campaignName:
              type: string
              description: >-
                Displays the campaign name associated with the activity. The
                campaign name is added while creating a campaign.
              example: Big sales
            campaignPoints:
              type: integer
              description: >-
                Displays the number of points awarded to the member once they
                achieve the campaign benefits.
              example: 120
            reason:
              type: string
              description: Displays the reason for performing the actions by the member.
              example: Bonus/Debit/Product is returned
            orderId:
              type: string
              description: Displays the order ID for the activity performed by the member.
              example: ORDERID-TEST123
            source:
              type: string
              description: >-
                Displays the source of the transaction. For example, website,
                application, or in-store. Actions can also be performed in-store
                at check-out. Note - This is not an auto-generated value. The
                value should be passed to the source parameter at the time of
                performing the action.
              example: website
            createDate:
              type: string
              description: >-
                Displays the date when the transaction occurred in
                YYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
            expireDate:
              type: string
              description: >-
                Displays the date on which the points awarded for the actions
                will expire in YYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
            storeDetails:
              type: object
              description: >-
                Displays the following store details associated with the store.
                Note - If a store ID is provided with any action and it exists
                in the metadata, all associated attributes of that store will be
                displayed. If the store ID does not exist in the metadata, it
                will simply display the store ID itself.
              properties:
                storeId:
                  type: string
                  description: >-
                    Displays an identifier for the specific store. It is a
                    unique code assigned to each store.
                  example: IN12369
                storeName:
                  type: string
                  description: Displays the name associated with the specific store.
                  example: SHELL
                storeExtendedAttribute:
                  type: string
                  description: Displays all the store extended attributes.
                  example: Store Location
            senderData:
              type: object
              description: Displays the following details regarding the Sender.
              properties:
                senderId:
                  type: string
                  description: >-
                    Displays the unique identifier of the member who is sending
                    the points upon the execution of action ID 176 or custom
                    action ID.
                  example: r00.00@annexcloud.com
                senderName:
                  type: string
                  description: >-
                    Displays the unique name of the member who is sending the
                    points upon the execution of action ID 176 or a custom
                    action ID.
                  example: Rabindra Nath
            receiverData:
              type: object
              description: Displays the following details regarding the Receiver.
              properties:
                receiverId:
                  type: string
                  description: >-
                    Displays the unique identifier of the member who is
                    receiving the points upon the execution of action ID 176 or
                    custom action ID.
                  example: r00.00@annexcloud.com
                receiverName:
                  type: string
                  description: >-
                    Displays the unique name of the member who is receiving the
                    points upon the execution of action ID 176 or a custom
                    action ID.
                  example: Rabindra Nath
            groupCredit:
              type: integer
              description: >-
                Displays the total number of points credited to the group that
                the recipient belongs to as part of an activity. Note - The
                response for this parameter is dynamic and depends on whether
                the activity being fetched is for the sender or the recipient.
              example: 5
            groupDebit:
              type: integer
              description: >-
                Displays the total number of points deducted from the group’s
                balance due to the sender’s activity. Note - The response for
                this parameter is dynamic and depends on whether the activity
                being fetched is for the sender or the recipient.
              example: 0
            rewardId:
              type: integer
              description: Displays the unique reward ID associated with the activity.
              example: 123
            customId:
              type: string
              description: >-
                Displays the customID limit set at the site level. This is a
                secondary form of a limit on top of the action limitations to
                verify those members who participate in the same actions
                repeatedly in order to acquire points. This functionality will
                only be visible when both the Enable Site Level CustomId Limit
                flag on the general settings page within the additional loyalty
                settings and the Include custom parameter flag on the additional
                settings page within the action rules are enabled. When the
                customId flag is enabled, the system checks for the custom limit
                instead of the action limit while awarding points to any member.
                As an example, you wish to award points to loyalty members for
                linking their devices to the loyalty program via email, SMS or
                an application. You set the action interval limit to be greater
                than 1. However, you would like to prevent members from getting
                points more than once for linking the same device several times.
                By using customIds and setting the custom limit to 1, you will
                ensure that no members will be awarded points more than once for
                linking the same device.
              example: 3
            purchasePointType:
              type: string
              description: >-
                Displays the purchase point type as Both, Only Bonus or Only
                Ratio when the Purchase Point Type flag for the order or
                activity API is enabled.
              example: Only Bonus
            campaignReleaseDate:
              type: string
              description: >-
                Displays the date on which the campaign points are released
                inYYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
            holdPointsReleaseDate:
              type: string
              description: >-
                Displays the date on which the points on hold will be released
                in YYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
            holdPointsCancelDate:
              type: string
              description: >-
                Displays the date on which the points on hold were cancelled in
                YYYY-MM-DD'T'HH:mm:ssZ format. The points on hold might be
                cancelled if the member returns a product.
              example: 2021-02-09T18:27:35+0000
            blockedStatus:
              type: string
              description: >-
                Displays the blocked status of the member. (If the Show Blocked
                User Details functionality is enabled.). If the member is
                blocked, then it shows YES otherwise it shows NO.
              example: 'YES'
            blockedBy:
              type: string
              description: >-
                Displays the email address of the person who blocked the member.
                (If the Show Blocked User Details functionality is enabled from
                the super admin.)
              example: user@domain.com
            blockedDate:
              type: string
              description: >-
                Displays the date on which the member was blocked in
                YYYY-MM-DD'T'HH:mm:ssZ format. (If the Show Blocked User Details
                functionality is enabled from the super admin.)
              example: 2021-02-09T18:27:35+0000
        orderDetails:
          type: object
          description: Displays the following details-
          properties:
            activity:
              type: string
              description: Displays the order activity name such as credit or debit.
              example: Credit/Debit
            credit/debit:
              type: integer
              description: >-
                Displays the number of points credited to the member’s account
                or debited from the member’s account.
              example: 10
            pointStatus:
              type: string
              description: >-
                Displays the point status as Hold, Redeemed, or Released. The
                point status may show as Hold if you have elected to hold points
                from members for a defined number of days after the action is
                completed when configuring your program. Otherwise, the point
                status will show as Released or Redeemed.
              example: Released
            displayText:
              type: string
              description: Displays brief information related to the order activity.
              example: Manual Credit/Debit
            sectionId:
              type: string
              description: >-
                Displays the unique section ID. (A survey includes multiple
                questions for loyalty members to answer, and the questions are
                split into various sections to help them comprehend the context
                of the survey.)
              example: 654
            sectionName:
              type: string
              description: >-
                Displays the section name as specified by the Administrator. (If
                the member just completes one section of the survey, the name of
                the survey and the section are both displayed.)
              example: main section
            surveyId:
              type: string
              description: >-
                Displays the unique Survey ID. This survey ID is auto generated
                by the system. (This identifier helps in tracking and organizing
                survey responses, ensuring that each response is linked to the
                correct survey and participant.
              example: 123
            surveyName:
              type: string
              description: >-
                Displays the survey name as specified by the Administrator. (The
                surveys for loyalty members have names based on their criteria
                to differentiate and outline the contents of the survey in
                brief. If the member takes the survey, the name of the survey in
                which the member participated is displayed.)
              example: General Survey
            createDate:
              type: string
              description: >-
                Displays the date when the transaction occurred in
                YYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
            updateDate:
              type: string
              description: >-
                Displays the last date and time, the transaction was updated in
                YYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
            holdPointsReleaseDate:
              type: string
              description: >-
                Displays the date on which the points on hold will be released
                in YYYY-MM-DD'T'HH:mm:ssZ format.
              example: 2021-02-09T18:27:35+0000
        multibucketsData:
          type: object
          description: >-
            Displays the following fields when the multi point bucket flag is
            enabled-
          properties:
            action[bucketName]:
              type: object
              description: >-
                Displays the following details of the point bucket being
                affected by a loyalty action-
              properties:
                credit/debit:
                  type: integer
                  description: >-
                    Displays the number of points credited to the point bucket
                    or debited from the point bucket for the action.
                  example: 10
                expireDate:
                  type: string
                  description: >-
                    Displays the date on which the points in the bucket will
                    expire in YYYY-MM-DD'T'HH:mm:ssZ format.
                  example: 2021-02-09T18:27:35+0000
            tier[bucketName]:
              type: object
              description: >-
                Displays the following details of the point bucket affected by
                tier activity-
              properties:
                credit/debit:
                  type: integer
                  description: >-
                    Displays the number of points credited to the point bucket
                    or debited from the point bucket based on the member’s tier
                    status.
                  example: 100
                expireDate:
                  type: string
                  description: >-
                    Displays the date on which the points in the bucket will
                    expire in YYYY-MM-DD'T'HH:mm:ssZ format.
                  example: 2021-02-09T18:27:35+0000
        groupActivity:
          type: object
          description: >-
            Displays the following activity details for the group when the
            hierarchy status flag is enabled.
          properties:
            HierarchyGroupUserCreditActivity:
              type: object
              description: Displays the following details-
              properties:
                action_id:
                  type: integer
                  description: >-
                    Displays the unique action ID for which the points are
                    credited to the group.
                  example: 160
                credit:
                  type: integer
                  description: Displays the number of points credited to the group account.
                  example: 10
                create_date:
                  type: string
                  description: >-
                    Displays the date on which the group was created in
                    YYYY-MM-DD'T'HH:mm:ssZ format.
                  example: 2021-02-09T18:27:35+0000
                uid:
                  type: string
                  description: Displays the unique ID of the group.
                  example: user@domain.com
                first_name:
                  type: string
                  description: Displays the first name of the member.
                  example: John
                group_name:
                  type: string
                  description: >-
                    Displays the name of the group that participated in the
                    activity.
                  example: sweet- member
            HierarchyGroupUserDebitActivity:
              type: object
              description: Displays the following details-
              properties:
                action_id:
                  type: integer
                  description: >-
                    Displays the unique action ID for which the points are
                    debited from the group.
                  example: 160
                debit:
                  type: integer
                  description: >-
                    Displays the number of points debited from the group
                    account.
                  example: 10
                create_date:
                  type: string
                  description: >-
                    Displays the date on which the group was created in
                    YYYY-MM-DD'T'HH:mm:ssZ format.
                  example: 2021-02-09T18:27:35+0000
                uid:
                  type: string
                  description: Displays the unique ID of the group.
                  example: user@domain.com
                first_name:
                  type: string
                  description: Displays the first name of the member.
                  example: John
                group_name:
                  type: string
                  description: >-
                    Displays the name of the group that participated in the
                    activity.
                  example: sweet- member
            HierarchyUserCreditActivity:
              type: object
              description: Displays the following details-
              properties:
                action_id:
                  type: integer
                  description: >-
                    Displays the unique action ID through which the points are
                    credited to the member’s account.
                  example: 160
                credit:
                  type: integer
                  description: >-
                    Displays the number of points credited to the member’s
                    account.
                  example: 10
                create_date:
                  type: string
                  description: >-
                    Displays the date on which the member was added to the group
                    in YYYY-MM-DD'T'HH:mm:ssZ format.
                  example: 2021-02-09T18:27:35+0000
                uid:
                  type: string
                  description: Displays the unique ID of the group member.
                  example: user@domain.com
                group_id:
                  type: integer
                  description: Displays the unique ID of the group.
                  example: 123
                credited_by:
                  type: string
                  description: >-
                    Displays the unique ID of the member who has credited points
                    to the group account.
                  example: member1@domain.com
                first_name:
                  type: string
                  description: Displays the first name of the member.
                  example: John
                group_name:
                  type: string
                  description: >-
                    Displays the name of the group that participated in the
                    activity.
                  example: Group1
            HierarchyUserDebitActivity:
              type: object
              description: Displays the following details-
              properties:
                action_id:
                  type: integer
                  description: >-
                    Displays the unique action ID through which the points are
                    debited from the member’s account.
                  example: 160
                debit:
                  type: integer
                  description: >-
                    Displays the number of points debited from the member’s
                    account.
                  example: 10
                create_date:
                  type: string
                  description: >-
                    Displays the date on which the member was added to the group
                    in YYYY-MM-DD'T'HH:mm:ssZ format.
                  example: 2021-02-09T18:27:35+0000
                uid:
                  type: string
                  description: Displays the unique ID of the group member.
                  example: user@domain.com
                group_id:
                  type: integer
                  description: Displays the unique ID of the group.
                  example: 123
                debited_by:
                  type: string
                  description: >-
                    Displays the unique ID of the member who has debited points
                    from the group account.
                  example: member2@domain.com
                first_name:
                  type: string
                  description: Displays the first name of the member.
                  example: John
                group_name:
                  type: string
                  description: >-
                    Displays the name of the group that participated in the
                    activity.
                  example: Group1
        pages:
          type: integer
          description: Displays the total number of pages associated with the activities.
          example: 40
        currentpage:
          type: integer
          description: Displays the current page number.
          example: 11
        totalActivityCount:
          type: integer
          description: Displays the total number of activities performed by the member.
          example: 2
        campaignDetails:
          type: object
          description: >-
            Displays the following information once the campaign milestone
            benefit activity flag is enabled in the super admin.
          properties:
            campaignGroupId:
              type: integer
              description: Displays the group ID associated with the campaign.
              example: 1654
            campaignId:
              type: integer
              description: Displays the campaign ID.
              example: 3692
            campaignName:
              type: string
              description: Displays the name of the campaign.
              example: Back to School Savings
            campaignPoints:
              type: integer
              description: >-
                Displays the campaign points awarded to the member once they
                achieve the campaign milestones.
              example: 200
            rewardId:
              type: integer
              description: >-
                Displays the unique ID for the reward configured in the loyalty
                program.
              example: 2345
            rewardName:
              type: string
              description: Displays the name of the reward used by the member.
              example: Jockey $15.00 off purchase
            rewardCode:
              type: string
              description: Displays the reward code used by the member.
              example: AP232
    updateProduct:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the unique Site ID.
          example: 9992280
        pointAwardType:
          type: string
          description: Displays the point award type (Product or Category).
          example: Product
        productDetail:
          type: object
          description: Displays the created product details.
          properties:
            productId:
              type: string
              description: Displays the Product ID.
              example: 12345
            productName:
              type: string
              description: Displays the Product Name.
              example: Go Go Gadget Pro
            productPrice:
              type: integer
              description: Displays the per unit price of the product.
              example: 105
            productPointType:
              type: string
              description: >-
                Displays the Product Point Type. No - No points awarded, Yes -
                Points awarded, Bonus - Bonus points awarded.
              example: 'Yes'
            productPointRatio:
              type: integer
              description: >-
                Displays the point ratio for the product. A ratio is a
                multiplier applied to a point award based on specific criteria
                (Product, Tier, Category, Campaign) For example, if the
                productPointRatio is 3, the points awarded are multiplied by 3.
              example: 2
            bonusPoint:
              type: integer
              description: >-
                If the productPointType is Bonus, displays the bonus amount for
                the product.
              example: 10
            bonusflag:
              type: string
              description: >-
                Displays the status of a flag whether the Product Bonus applies.
                (Yes/No).
              example: 'Yes'
            productMinimumLimit:
              type: integer
              description: >-
                Displays the minimum number of units that must be purchased to
                award points.
              example: 2
        categoryDetail:
          type: object
          description: Displays the created category details of the product.
          properties:
            categoryId:
              type: string
              description: Displays the Category ID for the product.
              example: Cat1
            categoryName:
              type: string
              description: Displays the Category Name for the product.
              example: Gadgets
            categoryPointType:
              type: string
              description: >-
                Displays the category Point Type. No - No points awarded, Yes -
                Points awarded, Bonus - Bonus points awarded.
              example: 'Yes'
            categoryPointRatio:
              type: integer
              description: >-
                Displays the point ratio for the category. A ratio is a
                multiplier applied to a point award based on specific criteria
                (Product, Tier, Category, Campaign) For example, if the
                categoryPointRatio is 3, the points awarded are multiplied by 3.
              example: 2
            categoryBonus:
              type: integer
              description: >-
                If the categoryPointType is Bonus, displays the bonus amount for
                the category.
              example: 10
            categoryBonusFlag:
              type: string
              description: >-
                Displays the status of the flag whether the Category Bonus
                applies. (Yes/No).
              example: 'Yes'
            categoryMaxPoints:
              type: integer
              description: >-
                Displays the maximum points that can be awarded if category
                limit capping is enabled.
              example: 30
            categoryLimitType:
              type: string
              description: >-
                If the category limit capping flag is enabled, displays the
                category limit type. Rolling or Calendar
              example: Rolling
            categoryLimitPeriod:
              type: string
              description: >-
                Displays the category limit period. If the categoryLimitType is
                Rolling the value is the number of days. If calendar then
                Day/Month/Year. Applies if category limit capping flag is
                enabled.
              example: Day
        productAttributes:
          type: object
          description: Displays the product attributes for the created product.
          properties:
            upc:
              type: string
              description: Displays the Universal Product Code (UPC) of product.
              example: U24041202
            mpn:
              type: string
              description: Displays the Manufacturer Part Number (MPN) of the product.
              example: PPSR12345
            gtin:
              type: string
              description: Displays the Global Trade Item Number (GTIN) of the product.
              example: HSI US Dental
            brandId:
              type: string
              description: Displays the Brand ID of the product.
              example: VOLLRA
        limits:
          type: object
          description: Displays the category product limits.
          properties:
            productOrderPointsLimit:
              type: integer
              description: >-
                Displays the maximum points that can be earned on an order that
                includes the product.
              example: 50
            productLifetimePointsLimit:
              type: integer
              description: >-
                Displays the maximum lifetime points that can be earned on
                purchases of the products.
              example: 300
            categoryOrderPointsLimit:
              type: integer
              description: >-
                Displays the maximum number of points that can be earned on
                purchases in the product category.
              example: 400
            categoryLifetimePointsLimit:
              type: integer
              description: >-
                Displays the maximum lifetime point limit on purchases in the
                product category.
              example: 400
    createUser:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud site ID for the loyalty program.
              example: '29235480'
            id:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: jacklee2023
            email:
              type: string
              description: Displays the email address of the loyalty member.
              example: jacklee2023@gmail.com
            firstName:
              type: string
              description: Displays the first name of the loyalty member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the loyalty member.
              example: Deo
            zipCode:
              type: string
              description: Displays the zip code of the loyalty member's residence.
              example: 51750
            optInStatus:
              type: string
              description: >-
                Displays the opt-in status as YES for opt-in or NO for opt-out.
                The default opt-in status is YES.
              example: 'YES'
            optInDate:
              type: string
              description: >-
                Displays the opt-in date of the loyalty member in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            status:
              type: string
              description: >-
                If the activity-based membership status flag is OFF- Displays
                the loyalty member’s status as active or inactive. By default,
                the status is active and can be changed to inactive as per the
                client’s request. If the activity-based membership status flag
                is ON- Displays the member status based on the defined
                activity-based criteria.
              example: ACTIVE
            phone:
              type: string
              description: Displays the phone number of the loyalty member.
              example: 123-123-4567
            birthDate:
              type: string
              description: >-
                Displays the date of birth of the loyalty member in yyyy-MM-dd
                format.
              example: '1989-12-11'
            anniversaryDate:
              type: string
              description: >-
                Displays the loyalty member's anniversary date, which can be
                their birthdate, the date they joined the loyalty program or
                marriage date in yyyy-MM-dd format.
              example: '2023-12-11'
            userProfileImageUrl:
              type: string
              description: Displays the image URL for the loyalty member’s profile picture.
              example: >-
                https://www.socialannex.com/public/manageoptionsdesign16/images/product_landing/loyalty-hover.png
            createDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member profile was created.
              example: 2024-08-08T07:00:12+0000
            updateDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member was updated.
              example: 2024-08-08T07:00:12+0000
            extendedAttribute:
              type: object
              description: >-
                Displays the member attributes defined in your program
                configuration. This can be customized according to requirements.
                It accepts multiple parameters; however, these parameters must
                be defined under Products > Additional Loyalty Settings >
                Extended Attributes. Note - The extended attributes listed below
                are examples only. All extended attributes must be configured
                for the program as stated above.
              properties:
                userType:
                  description: >-
                    Displays the employment status of the member as employed,
                    unemployed, or student.
                  example: Employed
                  type: string
                userStatus:
                  description: >-
                    Displays the unique referrer code provided by the
                    Refer-a-Friend program (if applicable), when creating a
                    loyalty member profile.
                  example: Enabled
                  type: string
            raf:
              type: object
              description: >-
                Displays the refer-a-friend object if the member was created
                with a referral code. This functionality is accessible to
                clients who have the Refer a Friend (RAF) module. Note1- This
                module is only displayed to new members who sign up using a
                referrer code and take advantage of the loyalty program. Note2-
                This functionality is also applicable to multi-template sites.
              properties:
                personalLink:
                  type: string
                  description: Displays the unique refer a friend bitly link.
                  example: https://bit.ly/3rShgt7"
                inviteCode:
                  type: string
                  description: >-
                    Displays the unique invite code shared by the loyalty member
                    to invite others to the loyalty program.
                  example: 3rShgt7
                referrerCode:
                  type: string
                  description: >-
                    Displays the unique referral code from the referrer, used
                    while creating a member (referee).
                  example: 3bhqc5k
                referrerName:
                  type: string
                  description: >-
                    Displays the name of the referrer whose referrer code was
                    used while creating a member (referee).
                  example: Adam
            heirarchyDetails:
              type: object
              description: >-
                Displays the following information for the hierarchy management
                group (if enabled in the program).
              properties:
                groupName:
                  type: string
                  description: Displays the name of the group to which the member is added.
                  example: Sweet Family 15
                groupCreationDate:
                  type: string
                  description: >-
                    Displays the group creation date in yyyy-MM-dd'T'HH:mm:ssZ
                    format.
                  example: 2020-10-12T00:00:00+0000
                previousTier:
                  type: string
                  description: >-
                    Displays the previous tier that was assigned to the loyalty
                    member. For example, Bronze, Silver, Gold. The name of the
                    tier is defined by the client during configuration of the
                    loyalty program.
                  example: Sliver
                currentTier:
                  type: string
                  description: >-
                    Displays the name of the loyalty member’s current tier. For
                    example, Bronze, Silver, Gold. The name of the tier is
                    defined by the client during configuration of the loyalty
                    program.
                  example: Gold
                groupUpdateDate:
                  type: string
                  description: >-
                    Displays the date the group was updated in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2020-10-12T00:00:00+0000
                source:
                  type: string
                  description: >-
                    Displays the source of the loyalty member's profile
                    creation, whether it was from a website, application, or
                    in-store. The actions can also be performed from a store
                    while doing the check-out.
                  example: website
    getUserDetails:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud site ID for the loyalty program.
              example: '29235480'
            id:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: jacklee2023
            email:
              type: string
              description: Displays the email address of the loyalty member.
              example: jacklee2023@gmail.com
            firstName:
              type: string
              description: Displays the first name of the loyalty member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the loyalty member.
              example: Deo
            zipCode:
              type: string
              description: Displays the zip code of the loyalty member's residence.
              example: 51750
            optInStatus:
              type: string
              description: >-
                Displays the opt-in status as YES for opt-in or NO for opt-out.
                The default opt-in status is YES.
              example: 'YES'
            optInDate:
              type: string
              description: >-
                Displays the opt-in date of the loyalty member in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            status:
              type: string
              description: >-
                If the activity-based membership status flag is OFF- Displays
                the loyalty member’s status as active or inactive. By default,
                the status is active and can be changed to inactive as per the
                client’s request. If the activity-based membership status flag
                is ON- Displays the current status of the member.
              example: ACTIVE
            activityBasedStatus:
              type: object
              description: >-
                When the activity-based membership flag is turned ON, it
                displays the following information regarding the member's
                upcoming status.
              properties:
                milestone:
                  type: integer
                  description: >-
                    Displays the upcoming milestone of the member based on their
                    activities. The administrator can configure a maximum of
                    five milestones.
                  example: 1
                nextStatus:
                  type: string
                  description: >-
                    Displays the member's upcoming status, which can be Dormant
                    or Lapsed. This status can be customized by the
                    administrator.
                  example: Dormant
                statusDate:
                  type: string
                  description: >-
                    Displays the date when the member's status will change in
                    YYYY-MM-DD format.
                  example: '2024-02-02'
            memberStatus:
              type: string
              description: >-
                Displays whether the member is an active member or not. This
                field can have one of two values. YES- The member is currently
                an active member. NO- The member is not an active member.
              example: 'YES'
            phone:
              type: string
              description: Displays the phone number of the loyalty member.
              example: 123-123-4567
            birthDate:
              type: string
              description: >-
                Displays the date of birth of the loyalty member in yyyy-MM-dd
                format.
              example: '1989-12-11'
            anniversaryDate:
              type: string
              description: >-
                Displays the loyalty member's anniversary date, which can be
                their birthdate, the date they joined the loyalty program or
                marriage date in yyyy-MM-dd format.
              example: '2023-12-11'
            userProfileImageUrl:
              type: string
              description: Displays the image URL for the loyalty member’s profile picture.
              example: >-
                https://www.socialannex.com/public/manageoptionsdesign16/images/product_landing/loyalty-hover.png
            source:
              type: string
              description: >-
                Displays the source of the loyalty member's profile creation,
                whether it was from a website, application, or in-store.
              example: website
            createDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member profile was created.
              example: 2024-08-08T07:00:12+0000
            updateDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member was updated.
              example: 2024-08-08T07:00:12+0000
            totalSpendCurrency:
              type: integer
              description: Displays the total currency spent by the loyalty member.
              example: 134
            extendedAttribute:
              type: object
              description: >-
                Displays the member attributes defined in your program
                configuration. This can be customized according to requirements.
                It accepts multiple parameters; however, these parameters must
                be defined under Products > Additional Loyalty Settings >
                Extended Attributes. Note - The extended attributes listed below
                are examples only. All extended attributes must be configured
                for the program as stated above.
              properties:
                userType:
                  description: >-
                    Displays the employment status of the member as employed,
                    unemployed, or student.
                  example: Employed
                  type: string
                userStatus:
                  description: >-
                    Displays the unique referrer code provided by the
                    Refer-a-Friend program (if applicable), when creating a
                    loyalty member profile.
                  example: Enabled
                  type: string
            raf:
              type: object
              description: >-
                Displays the refer-a-friend object if the member was created
                with a referral code. This functionality is accessible to
                clients who have the Refer a Friend (RAF) module. Note1- This
                module is only displayed to new members who sign up using a
                referrer code and take advantage of the loyalty program. Note2-
                This functionality is also applicable to multi-template sites.
              properties:
                personalLink:
                  type: string
                  description: Displays the unique refer a friend bitly link.
                  example: https://bit.ly/3rShgt7"
                inviteCode:
                  type: string
                  description: >-
                    Displays the unique invite code shared by the loyalty member
                    to invite others to the loyalty program.
                  example: 3rShgt7
                referrerCode:
                  type: string
                  description: >-
                    Displays the unique referral code from the referrer, used
                    while creating a member (referee).
                  example: 3bhqc5k
                referrerName:
                  type: string
                  description: >-
                    Displays the name of the referrer whose referrer code was
                    used while creating a member (referee).
                  example: Adam
            hierarchyData:
              type: object
              description: >-
                Displays the following information about the group with which
                the member is associated.
              properties:
                groupId:
                  type: string
                  description: >-
                    Displays the ID of the group that the loyalty member belongs
                    to.
                  example: '91'
                addedOn:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member was added to
                    the group in yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2020-10-12T00:00:00+0000
                groupAvailablePoints:
                  type: string
                  description: >-
                    Displays the total available points for the group. It is the
                    cumulative points of the group members.
                  example: '500'
                groupName:
                  type: string
                  description: Displays the name of the group.
                  example: Sweet Family 15
                userRole:
                  type: string
                  description: Displays the role of the user within the group.
                  example: Member
            topLevel/bottomLevel:
              type: object
              description: Displays the following details.
              properties:
                siteId:
                  type: string
                  description: Displays the Annex Cloud site ID for the loyalty program.
                  example: '29235480'
                siteName:
                  type: string
                  description: Displays the name of the site.
                  example: Socialannextestsite
                groupName:
                  type: string
                  description: >-
                    Displays the name of the group to which the loyalty member
                    is added.
                  example: Sweet Family 15
                memberId:
                  type: string
                  description: >-
                    Displays the member ID of the loyalty member associated with
                    the group.
                  example: user@domain.com
                blockedStatus:
                  type: string
                  description: >-
                    Display the blocked status of the loyalty member. (If Show
                    Blocked User Details functionality is enabled from the super
                    admin.). If the member is blocked, then it shows YES
                    otherwise it shows No.
                  example: 'YES'
                blockedBy:
                  type: string
                  description: >-
                    Displays the email address of the individual who blocked the
                    loyalty member. (If the Show Blocked User Details
                    functionality is enabled from the super admin.)
                  example: user@domain.com
                blockedDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member was blocked in
                    yyyy-MM-dd'T'HH:mm:ssZ format. (If the Show Blocked User
                    Details functionality is enabled from the super admin.)
                  example: 2020-10-12T00:00:00+0000
                lastPurchaseDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member made their
                    last purchase in yyyy-mm-dd format.
                  example: '2023-12-11'
                lastActivityDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member performed
                    their last activity in yyyy-mm-dd format.
                  example: '2023-12-11'
    createSegment:
      type: object
      properties:
        siteId:
          type: string
          description: Displays the unique site ID.
          example: 1478903180
        segmentId:
          type: string
          description: >-
            Displays the unique ID of the segment. (This is autogenerated by
            Annex Cloud).
          example: 1234
        segmentName:
          type: string
          description: Displays the name of the segment.
          example: Test Segment
        segmentType:
          type: string
          description: Displays the segment type as specified in the request body.
          example: Current Data
        segmentFromDate:
          type: string
          description: Displays the start date of the segment in YYYY-MM-DD format.
          example: '2020-01-17'
        segmentToDate:
          type: string
          description: Displays the end date of the segment in YYYY-MM-DD format.
          example: '2020-01-19'
        status:
          type: string
          description: Displays the status as either ‘ACTIVE’ or as ‘INACTIVE'.
          example: ACTIVE
        addedmember:
          type: string
          description: Displays the user IDs of the newly added members to the segment.
          example: smith.john1@yahoo.com,rogerwaters@hotmail.com
    getSegmentDetailsById:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: 1222222
        segmentId:
          type: string
          description: Displays the unique ID of the segment.
          example: 1234
        segmentName:
          type: string
          description: Displays the name of the segment.
          example: Silver Tier Members
        eligibleUsers:
          type: object
          description: Displays the list of eligible members for the segment.
          properties:
            member:
              type: string
              description: Displays the user ID of an eligible member.
              example: steve.johnson182@gmail.com
            email:
              type: string
              description: Displays the email address of an eligible member.
              example: example0@gmail.com
            pages:
              type: integer
              description: Displays the number of pages of the response.
              example: 7
            current_page:
              type: integer
              description: Displays the current page number.
              example: 1
            totalEligibleUsers:
              type: integer
              description: Displays the total number of eligible members.
              example: 258
    getSegmentIdResp:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: ab9876
        segmentDetail:
          type: object
          description: Displays the following details of the segment.
          properties:
            segmentName:
              type: string
              description: Displays the name of the segment.
              example: Test segment
            description:
              type: string
              description: >-
                Displays the description of the specific segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            tagline:
              type: string
              description: Displays the tagline of the specific segment in encrypted form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            termsAndConditions:
              type: string
              description: >-
                Displays the terms and conditions of the segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
        memberDetails:
          type: object
          description: Displays the details of the members listed in the segment.
          properties:
            userId:
              type: array
              description: Displays the user IDs of the members belonging to the segment.
              example: testuser11132020,johnsmith81@gmail.com
            zipCode:
              type: array
              description: >-
                Displays the zip code of the member’s location as configured in
                the segment.
              example: 80203, 99577
        actionDetails:
          type: object
          description: >-
            Displays the list of action names (Return, Redeem or Purchase) as
            configured in the segment.
          properties:
            actions:
              type: array
              description: Displays the action names in the segment.
              example: Purchase, Manual Credit/Debit
        pointsDetails:
          type: object
          description: >-
            Displays the range of the respective points type considered for the
            segment.
          properties:
            availablePointRangeFrom:
              type: integer
              description: Displays the lowest number of points available to the member.
              example: 10
            availablePointRangeTo:
              type: integer
              description: Displays the highest number of points available to the member.
              example: 500
            lifetimePointRangeFrom:
              type: integer
              description: Displays the start value of the lifetime points range.
              example: 150
            lifetimePointRangeTo:
              type: integer
              description: Displays the end value of the lifetime points range.
              example: 300
            redeemPointRangeFrom:
              type: integer
              description: >-
                Displays the start value of the redeemable points available to a
                member.
              example: 375
            redeemPointRangeTo:
              type: integer
              description: >-
                Displays the end value of the redeemable points available to a
                member.
              example: 150
        purchaseDetails:
          type: object
          description: Displays the configured purchase attributes for the segment.
          properties:
            productPurchased:
              type: array
              description: >-
                Displays the list of selected product IDs in the segment the
                member receives eligibility for when purchased.
              example: Prod01, Prod02
            productCategory:
              type: array
              description: >-
                Displays the list of selected category IDs in the segment the
                member receives eligibility for when purchased.
              example: Cat01, Cat02
            source:
              type: string
              description: >-
                Displays the member’s purchase eligibility from a specific
                source, such as ‘Store’ or ‘Web’.
              example: Store
    patchsegmentidresp:
      type: object
      properties:
        '0':
          type: object
          description: Displays the segment detail object as follows.
          properties:
            segment_id:
              type: integer
              description: Displays the unique ID associated with the specific segment.
              example: 1234
            site_id:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 78456701
            multitemplate_id:
              type: integer
              description: >-
                Displays the multi-template ID if the site is configured as a
                multi-template site.
              example: 143
            segment_name:
              type: string
              description: Displays the name of the segment.
              example: Gold Tier Member Segment
            available_points_from:
              type: integer
              description: >-
                If the segment is configured on the available points metrics,
                then it displays the lowest number of points defined in the
                segment.
              example: 75
            available_points_to:
              type: integer
              description: >-
                If the segment is configured on the available points metrics,
                then it displays the highest number of points defined in the
                segment.
              example: 550
            available_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                available points parameter. The following values display
                depending on the set available points condition- Less than = 1
                Greater than = 2 Points Range = 3 Equal To = 4 Does not equal =
                5 If there is no available points condition defined in the
                segment, the parameter value displays as ‘0’.
              example: 1
            lifetime_points_from:
              type: integer
              description: >-
                If the segment is configured on the lifetime points metrics,
                then it displays the lowest number of points defined in the
                segment.
              example: 0
            lifetime_points_to:
              type: integer
              description: >-
                If the segment is configured on the lifetime points metrics,
                then it displays the highest number of points defined in the
                segment.
              example: 6575
            lifetime_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                lifetime member points parameter. The following values display
                depending on the set available points condition- Less than = 1
                Greater than = 2 Points Range = 3 Equal To = 4 Does not equal =
                5 If there is no lifetime points condition defined in the
                segment, the parameter value displays as ‘0.’
              example: 4
            redeem_points_from:
              type: integer
              description: >-
                If the segment is configured on the redeemed points metrics,
                then it displays the lowest number of points defined in the
                segment.
              example: 10
            redeem_points_to:
              type: integer
              description: >-
                If the segment is configured on the redeemed points metrics,
                then it displays the highest number of points defined in the
                segment.
              example: 1200
            redeem_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                redeemed member points parameter. The following values display
                depending on the set redeemed member points condition- Less than
                = 1 Greater than = 2 Points Range = 3 Equal To = 4 Does not
                equal = 5 If there is no redeem points condition defined in the
                segment, the parameter value displays as ‘0.’
              example: 0
            earned_points_from:
              type: integer
              description: >-
                If the segment is configured on the earned points metrics, then
                it displays the lowest number of points defined in the segment.
              example: 25
            earned_points_to:
              type: integer
              description: >-
                If the segment is configured on the earned points metrics, then
                it displays the highest number of points defined in the segment.
              example: 275
            earned_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                earned member points parameter. The following values display
                depending on the set earned member points condition- Less than =
                1 Greater than = 2 Points Range = 3 Equal To = 4 Does not equal
                = 5 If there is no earned points condition defined in the
                segment, the parameter value displays as ‘0.’
              example: 3
            amount_spend_from:
              type: integer
              description: >-
                If the segment is configured on the amount spend metrics, then
                it displays the lowest number of points defined in the segment.
              example: 30
            amount_spend_to:
              type: integer
              description: >-
                If the segment is configured on the amount spend metrics, then
                it displays the highest number of points defined in the segment.
              example: 150
            amount_spend_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                amount spend parameter. The following values display depending
                on the set amount spend condition- Less than = 1 Greater than =
                2 Points Range = 3 Equal To = 4 Does not equal = 5 If there is
                no amount spend condition defined in the segment, the parameter
                value displays as ‘0.’
              example: 4
            status:
              type: string
              description: >-
                Displays the previous status of the segment as either ‘0' for
                inactive status and '1’ for active status.
              example: 1
            is_activate_leaderboard:
              type: integer
              description: >-
                Displays the type of points the active leaderboard is based on.
                The following values display depending on the set active
                leaderboard points condition- Available Points = 1 Lifetime
                Points = 2 Redeemed Points = 3 Earned Points = 4 If the
                parameter returns a ‘0,’ then the leaderboard is not activated
                on any segment-based condition.
              example: 3
            users_segment_id:
              type: integer
              description: Displays the segment ID nested within the current segment.
              example: 123
            description:
              type: string
              description: >-
                Displays the description of the specific segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            tagline:
              type: string
              description: Displays the tagline of the specific segment in encrypted form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            terms_and_condition:
              type: string
              description: >-
                Displays the terms and conditions of the segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            prev_segment_id:
              type: integer
              description: >-
                In the case the segment is cloned, displays the original segment
                ID the segment was cloned from.
              example: 32423
            clone_status:
              type: integer
              description: >-
                Displays the clone status of a particular segment. If the
                parameter returns ‘1,’ it indicates the segment is cloned. '0'
                indicates the parameter is not cloned.
              example: 0
            db_add_date:
              type: string
              description: >-
                Displays the date when the segment was created in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-28T06:02:06+0000
            db_update_date:
              type: string
              description: >-
                Displays the date when the segment was updated in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-28T06:02:06+0000
            segmentName:
              type: string
              description: Displays the name of the segment.
              example: Test Segment
            addedMember:
              type: string
              description: >-
                Displays the list of user IDs of all the added members within
                the segment.
              example: abc@test.com,lmn@test.com,xyz@test.com
            segmentStatus:
              type: string
              description: Displays the status of the segment as either active or inactive.
              example: Active
            removedMember:
              type: string
              description: Displays the list of all removed user IDs from the segment.
              example: abc@test.com,lmn@test.com,xyz@test.com
    getSegmentList:
      type: object
      properties:
        segmentDetail:
          type: object
          description: Displays the following segment details.
          properties:
            segmentId:
              type: integer
              description: Displays the unique ID of the segment.
              example: 1234
            segmentName:
              type: string
              description: Displays the name of the segment.
              example: Test Segment
            segmentStatus:
              type: string
              description: >-
                Displays the status of the segment as either active or inactive.
                Note - This parameter is visible only if you pass ‘all’ in the
                request URL.
              example: all
            description:
              type: string
              description: Displays the description of the segment in encrypted form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            tagline:
              type: string
              description: Displays the tagline of the segment in encrypted form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            termsAndConditions:
              type: string
              description: >-
                Displays the terms and conditions of the segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
        pages:
          type: integer
          description: Displays the number of pages of the response.
          example: 7
        current_page:
          type: integer
          description: Displays the current page number.
          example: 1
    postBulkSegmentResp:
      type: object
      properties:
        '0':
          type: object
          description: Displays the segment detail object as follows.
          properties:
            segment_id:
              type: integer
              description: Displays the unique ID associated with the specific segment.
              example: 1234
            site_id:
              type: string
              description: Displays Annex Cloud’s site ID for the loyalty program.
              example: 78456701
            multitemplate_id:
              type: integer
              description: >-
                Displays the multi-template ID if the site is configured as a
                multi-template site.
              example: 143
            segment_name:
              type: string
              description: Displays the name of the segment.
              example: Gold Tier Member Segment
            available_points_from:
              type: integer
              description: >-
                If the segment is configured on the available points metrics,
                then it displays the lowest number of points defined in the
                segment.
              example: 75
            available_points_to:
              type: integer
              description: >-
                If the segment is configured on the available points metrics,
                then it displays the highest number of points defined in the
                segment.
              example: 550
            available_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                available points parameter. The following values display
                depending on the set available points condition- Less than = 1
                Greater than = 2 Points Range = 3 Equal To = 4 Does not equal =
                5 If there is no available points condition defined in the
                segment, the parameter value displays as ‘0’.
              example: 1
            lifetime_points_from:
              type: integer
              description: >-
                If the segment is configured on the lifetime points metrics,
                then it displays the lowest number of points defined in the
                segment.
              example: 0
            lifetime_points_to:
              type: integer
              description: >-
                If the segment is configured on the lifetime points metrics,
                then it displays the highest number of points defined in the
                segment.
              example: 6575
            lifetime_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                lifetime member points parameter. The following values display
                depending on the set lifetime member points condition- Less than
                = 1 Greater than = 2 Points Range = 3 Equal To = 4 Does not
                equal = 5 If there is no lifetime points condition defined in
                the segment, the parameter value displays as ‘0.’
              example: 4
            redeem_points_from:
              type: integer
              description: >-
                If the segment is configured on the redeemed points metrics,
                then it displays the lowest number of points defined in the
                segment.
              example: 10
            redeem_points_to:
              type: integer
              description: >-
                If the segment is configured on the redeemed points metrics,
                then it displays the highest number of points defined in the
                segment.
              example: 1200
            redeem_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                redeemed member points parameter. The following values display
                depending on the set redeemed member points condition- Less than
                = 1 Greater than = 2 Points Range = 3 Equal To = 4 Does not
                equal = 5 If there is no redeem points condition defined in the
                segment, the parameter value displays as ‘0.’
              example: 0
            earned_points_from:
              type: integer
              description: >-
                If the segment is configured on the earned points metrics, then
                it displays the lowest number of points defined in the segment.
              example: 25
            earned_points_to:
              type: integer
              description: >-
                If the segment is configured on the earned points metrics, then
                it displays the highest number of points defined in the segment.
              example: 275
            earned_points_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                earned member points parameter. The following values display
                depending on the set earned member points condition- Less than =
                1 Greater than = 2 Points Range = 3 Equal To = 4 Does not equal
                = 5 If there is no earned points condition defined in the
                segment, the parameter value displays as ‘0.’
              example: 3
            amount_spend_from:
              type: integer
              description: >-
                If the segment is configured on the amount spend metrics, then
                it displays the lowest number of points defined in the segment.
              example: 30
            amount_spend_to:
              type: integer
              description: >-
                If the segment is configured on the amount spend metrics, then
                it displays the highest number of points defined in the segment.
              example: 150
            amount_spend_flag:
              type: integer
              description: >-
                Displays a value that indicates which condition is set for the
                amount spend parameter. The following values display depending
                on the set amount spend condition- Less than = 1 Greater than =
                2 Points Range = 3 Equal To = 4 Does not equal = 5 If there is
                no amount spend condition defined in the segment, the parameter
                value displays as ‘0.’
              example: 4
            status:
              type: string
              description: >-
                Displays the previous status of the segment as either ‘0' for
                inactive status and '1’ for active status.
              example: 1
            is_activate_leaderboard:
              type: integer
              description: >-
                Displays the type of points the active leaderboard is based on.
                The following values display depending on the set active
                leaderboard points condition- Available Points = 1 Lifetime
                Points = 2 Redeemed Points = 3 Earned Points = 4 If the
                parameter returns a ‘0,’ then the leaderboard is not activated
                on any segment-based condition.
              example: 3
            users_segment_id:
              type: integer
              description: Displays the segment ID nested within the current segment.
              example: 123
            description:
              type: string
              description: >-
                Displays the description of the specific segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            tagline:
              type: string
              description: Displays the tagline of the specific segment in encrypted form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            terms_and_condition:
              type: string
              description: >-
                Displays the terms and conditions of the segment in encrypted
                form.
              example: JTNDcCUzRVRlc3QlMjBEZXNjcmlwdGlvbiUzQyUyRnAlM0UlMEE
            prev_segment_id:
              type: integer
              description: >-
                In the case the segment is cloned, displays the original segment
                ID the segment was cloned from.
              example: 32423
            clone_status:
              type: integer
              description: >-
                Displays the clone status of a particular segment. If the
                parameter returns ‘1,’ it indicates the segment is cloned. '0'
                indicates the parameter is not cloned.
              example: 0
            db_add_date:
              type: string
              description: >-
                Displays the date when the segment was created in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-28T06:02:06+0000
            db_update_date:
              type: string
              description: >-
                Displays the date when the segment was updated in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-04-28T06:02:06+0000
            segmentName:
              type: string
              description: Displays the name of the segment.
              example: Test Segment
            addedMember:
              type: string
              description: >-
                Displays the list of user IDs of all the added members within
                the segment.
              example: abc@test.com,lmn@test.com,xyz@test.com
            segmentStatus:
              type: string
              description: Displays the status of the segment as either active or inactive.
              example: Active
            removedMember:
              type: string
              description: Displays the list of all removed user IDs from the segment.
              example: abc@test.com,lmn@test.com,xyz@test.com
    getPointsDetails:
      type: object
      properties:
        siteId:
          type: string
          description: Displays Annex Cloud’s site ID for the loyalty program.
          example: 146031180
        id:
          type: string
          description: Displays the unique ID of the member.
          example: user@domain.com
        availablePoints:
          type: integer
          description: Displays the number of available points in the member’s account.
          example: 6620
        usedPoints:
          type: integer
          description: >-
            Displays the total number of points deducted from the member’s
            account. This excludes points debited as part of Action ID 192,
            ensuring clarity and precise tracking of point usage.
          example: 2000
        negativePoints:
          type: integer
          description: >-
            Displays the total number of negative points in the member’s
            account.
          example: -50
        expiredPoints:
          type: integer
          description: >-
            Displays the total number of points that have expired from the
            member's account. This includes points associated with Action ID 106
            as well as points debited under Action ID 192 - Action Debit Points,
            both categorized as expired.
          example: 0
        lifetimePoints:
          type: integer
          description: >-
            Displays the number of points the member has earned in their
            lifetime with the loyalty program.
          example: 8620
        earnedPointsPeriod:
          type: string
          description: >-
            Displays the period during which points are earned by the member.
            For example, Anniversary Year, calendar year, quarter, semester.
            (Displays only when earned points display flag is enabled in the
            configuration).
          example: anniversary year
        earnedPoints:
          type: integer
          description: >-
            Displays the total number of points earned by the member within the
            selected time period.
          example: 640
        holdPoints:
          type: integer
          description: Displays the total number of points on hold in the member’s account.
          example: 0
        usedPointsOnReward:
          type: integer
          description: Displays the total number of points used by the member on rewards.
          example: 0
        pointsToExpire:
          type: integer
          description: >-
            Displays the total number of expired points, indicating that the
            member had not used these points within the specified date range.
          example: 10
        pointsToNextTier:
          type: integer
          description: >-
            Displays the number of points  needed for the member to achieve the
            next tier.
          example: 0
        spendToNextTier:
          type: integer
          description: >-
            Displays the amount that the member needs to spend to achieve the
            next tier.
          example: 0
        pointsToExpireDate:
          type: string
          description: >-
            Displays the date on which the points will expire in
            yyyy-MM-dd'T'HH:mm:ssZ format.
          example: 2024-04-28T06:02:06+0000
        totalSpent:
          type: integer
          description: Displays the total number of points spent by the member.
          example: 3195
        rewardDenomination:
          type: integer
          description: Displays the denomination value associated with the reward.
          example: 500
        creditsToCurrencyRatio:
          type: integer
          description: >-
            Displays the credit-to-currency ratio defined by the admin.
            Multiplying this ratio by the member's available points results in
            the total currency value of the available points.
          example: 110
        creditsToCurrencyValue:
          type: integer
          description: >-
            Displays the total currency value after multiplying the available
            points with the credit-to-currency ratio, rounded to the defined
            decimal place.
          example: 6620
        ytdCreditPoints:
          type: integer
          description: >-
            Displays the total number of points credited to the member’s account
            from the beginning of the year up to the current date.
          example: 8620
        ytdDebitPoints:
          type: integer
          description: >-
            Displays the total number of points debited from the member’s
            account from the beginning of the year up to the current date.
          example: 2000
        multiBucketsData:
          type: object
          description: >-
            Displays an array of all multi- bucket details with the following
            fields.
          properties:
            bucketName:
              type: object
              description: Displays an array of all multi- bucket names.
              properties:
                available[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of points available in the member’s
                    account within the additional point bucket.
                  example: 100
                lifetime[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of points the member has earned towards
                    the additional point bucket in their lifetime with the
                    loyalty program.
                  example: 200
                used[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of points used by the member from the
                    additional point bucket.
                  example: 300
                negative[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of negative points in the member’s
                    account in the additional point bucket.
                  example: 0
                hold[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of points on hold from the additional
                    point bucket.
                  example: null
                expired[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of points from the additional point
                    bucket that have expired.
                  example: 100
                ToExpire[bucketName]:
                  type: integer
                  description: >-
                    Displays the total number of points that are next to expire
                    in the additional point bucket.
                  example: 500
                ToExpireDate[bucketName]:
                  type: string
                  description: >-
                    Displays the date on which the points will expire in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2020-10-30T05:30:00+0000
                ToNextTier[bucketName]:
                  type: integer
                  description: >-
                    Displays the number of points required to reach the next
                    tier associated with the additional point bucket.
                  example: 0
                tier[bucketName]:
                  type: object
                  description: Displays an array of all multi-bucket names.
                  properties:
                    availableTier[bucketName]:
                      type: integer
                      description: >-
                        Displays the number of available tier points in the
                        member’s account.
                      example: 100
                    lifetimeTier[bucketName]:
                      type: integer
                      description: >-
                        Displays the number of tier points the member has earned
                        in their lifetime with the loyalty program.
                      example: 500
                    usedTier[bucketName]:
                      type: integer
                      description: Displays the number of used tier points.
                      example: 100
                    negativeTier[bucketName]:
                      type: integer
                      description: >-
                        Displays the number of negative tier points in the
                        member’s account.
                      example: 0
                    holdTier[bucketName]:
                      type: integer
                      description: Displays the number of tier points on hold.
                      example: 800
                    expiredTier[bucketName]:
                      type: integer
                      description: >-
                        Displays the total number of tier points that have
                        expired.
                      example: 100
                    tier[bucketName]ToExpire:
                      type: integer
                      description: >-
                        Displays the number of tier points that are next to
                        expire from the member’s account.
                      example: 500
                    tier[bucketName]ToExpireDate:
                      type: string
                      description: >-
                        Displays the date on which the tier points will expire
                        in yyyy-MM-dd'T'HH:mm:ssZ format.
                      example: 2020-10-30T05:30:00+0000
                    toNextTier[bucketName]:
                      type: integer
                      description: >-
                        Displays the number of points that are required to reach
                        to next tier associated with the tier bucket.
                      example: 0
        availableRedemptionPoints:
          type: integer
          description: >-
            Displays the total number of available points for redemption in the
            member’s account.
          example: 0
        usedRedemptionPoints:
          type: integer
          description: >-
            Displays the total number of points used for redemption in the
            member’s account.
          example: 0
        groupDetails:
          type: object
          description: >-
            Displays the following information about the group with which the
            member is associated.
          properties:
            groupId:
              type: string
              description: Displays the unique group ID generated during group creation.
              example: '91'
            groupName:
              type: string
              description: Displays the name of the group to which the member belongs.
              example: Loyalty Circle
            groupAvailablePoints:
              type: string
              description: >-
                Displays the total available points for the group. It is the
                cumulative points of the group members.
              example: '500'
            groupLifetimePoints:
              type: string
              description: >-
                Displays the total number of group points accumulated throughout
                its time in the loyalty program.
              example: '100'
            groupUsedPoints:
              type: string
              description: Displays the number of points used from the group account.
              example: '200'
            groupExpiredPoints:
              type: string
              description: Displays the number of expired points from the group account.
              example: '0'
    Updateuser:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud site ID for the loyalty program.
              example: '29235480'
            id:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: jacklee2023
            email:
              type: string
              description: Displays the email address of the loyalty member.
              example: jacklee2023@gmail.com
            firstName:
              type: string
              description: Displays the first name of the loyalty member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the loyalty member.
              example: Deo
            zipCode:
              type: string
              description: Displays the zip code of the loyalty member's residence.
              example: 517501
            optInStatus:
              type: string
              description: >-
                Displays the opt-in status as YES for opt-in or NO for opt-out.
                The default opt-in status is YES.
              example: 'YES'
            optInDate:
              type: string
              description: >-
                Displays the opt-in date of the loyalty member in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            status:
              type: string
              description: >-
                If the activity-based membership status flag is OFF- Displays
                the loyalty member’s status as active or inactive. By default,
                the status is active and can be changed to inactive as per the
                client’s request. If the activity-based membership status flag
                is ON- Displays the member status based on the defined
                activity-based criteria.
              example: ACTIVE
            phone:
              type: string
              description: Displays the phone number of the loyalty member.
              example: 123-123-4567
            birthDate:
              type: string
              description: >-
                Displays the date of birth of the loyalty member in yyyy-MM-dd
                format.
              example: '1989-12-11'
            anniversaryDate:
              type: string
              description: >-
                Displays the loyalty member's anniversary date, which can be
                their birthdate, the date they joined the loyalty program or
                marriage date in yyyy-MM-dd format.
              example: '2023-12-11'
            userProfileImageUrl:
              type: string
              description: Displays the image URL for the loyalty member’s profile picture.
              example: >-
                https://www.socialannex.com/public/manageoptionsdesign16/images/product_landing/loyalty-hover.png
            createDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member profile was created.
              example: 2024-08-08T07:00:12+0000
            updateDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member was updated.
              example: 2024-08-08T07:00:12+0000
            source:
              type: string
              description: >-
                Displays the source of the loyalty member's profile creation,
                whether it was from a website, application, or in-store.
              example: website
            extendedAttribute:
              type: object
              description: >-
                Displays the member attributes defined in your program
                configuration. This can be customized according to requirements.
                It accepts multiple parameters; however, these parameters must
                be defined under Products > Additional Loyalty Settings >
                Extended Attributes. Note - The extended attributes listed below
                are examples only. All extended attributes must be configured
                for the program as stated above.
              properties:
                userType:
                  description: >-
                    Displays the employment status of the member as employed,
                    unemployed, or student.
                  example: Employed
                  type: string
                userStatus:
                  description: >-
                    Displays the unique referrer code provided by the
                    Refer-a-Friend program (if applicable), when creating a
                    loyalty member profile.
                  example: Enabled
                  type: string
            raf:
              type: object
              description: >-
                Displays the incentiveId and referrerCode. This functionality is
                accessible to clients who have the Refer a Friend (RAF) module.
                Note - This module is only displayed to new members who sign up
                using a referrer code and take advantage of the loyalty program.
              properties:
                personalLink:
                  type: string
                  description: Displays the unique refer a friend bitly link.
                  example: https://bit.ly/3rShgt7"
                inviteCode:
                  type: string
                  description: >-
                    Displays the unique invite code shared by the loyalty member
                    to invite others to the loyalty program.
                  example: 3rShgt7
                referrerCode:
                  type: string
                  description: >-
                    Displays the unique referral code from the referrer, used
                    while creating a member (referee).
                  example: 3bhqc5k
                referrerName:
                  type: string
                  description: >-
                    Displays the name of the referrer whose referrer code was
                    used while creating a member (referee).
                  example: Adam
            heirarchyDetails:
              type: object
              description: >-
                Displays the following information for the hierarchy management
                group (if enabled in the program).
              properties:
                groupName:
                  type: string
                  description: >-
                    Displays the name of the group to which the loyalty member
                    was added.
                  example: Sweet Family 15
                groupCreationDate:
                  type: string
                  description: Displays the group creation date.
                  example: 2020-10-12T00:00:00+0000
                previousTier:
                  type: string
                  description: >-
                    Displays the previous tier that was assigned to the loyalty
                    member. For example, Bronze, Silver, Gold. The name of the
                    tier is defined by the client during configuration of the
                    loyalty program.
                  example: Silver
                currentTier:
                  type: string
                  description: >-
                    Displays the name of the loyalty member’s current tier. For
                    example, Bronze, Silver, Gold. The name of the tier is
                    defined by the client during configuration of the loyalty
                    program.
                  example: Gold
                groupUpdateDate:
                  type: string
                  description: >-
                    Displays the date the group was updated in
                    yyyy-MM-dd’T’HH:mm:ssZ format.
                  example: 2020-10-12T00:00:00+0000
                source:
                  type: string
                  description: >-
                    Displays the source of the loyalty member's profile
                    creation, whether it was from a website, application, or
                    in-store.
                  example: website
    getSiteDetails:
      type: object
      properties:
        siteID:
          type: integer
          description: >-
            Displays an identifier for the specific site. It is a unique
            numerical code assigned to each site provided by Annex Cloud.
          example: 9992280
        siteName:
          type: string
          description: Displays the name associated with the site.
          example: TestSite
        loyaltyProgramType:
          type: string
          description: Displays the type or of loyalty program associated with the site.
          example: Explicit with Retro
        createdOn:
          type: string
          description: >-
            Displays the date and time when the particular site was created in
            the system. The format date and time are shown as
            yyyy-MM-dd'T'HH:mm:ssZ.
          example: 2024-08-08T07:00:12+0000
        region:
          type: string
          description: Displays the geographical region associated with the site.
          example: US
        activatedModules:
          type: array
          description: Displays the status of modules activated for the site.
          example: >-
            Social Wish List, Loyalty Program, Social Refer a Friend, Incentive
            Engine
        numberOfUsers:
          type: integer
          description: >-
            Displays the numerical value representing the count of active
            members associated with the site.
          example: 2332
    deleteUserDetails:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            siteId:
              type: string
              description: Displays Annex Cloud site ID for the loyalty program.
              example: '29235480'
            id:
              type: string
              description: Displays the unique ID of the deleted loyalty member.
              example: jacklee2023
            requestedBy:
              type: string
              description: >-
                Displays the unique ID of the individual who has requested to
                delete the information of another loyalty member.
              example: user@domain.com
            email:
              type: string
              description: Displays the email address of the loyalty member.
              example: jacklee2023@gmail.com
            firstName:
              type: string
              description: Displays the first name of the loyalty member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the loyalty member.
              example: Deo
            optInStatus:
              type: string
              description: >-
                Displays the opt-in status as YES for opt-in or NO for opt-out.
                The default opt-in status is YES.
              example: 'YES'
            status:
              type: string
              description: >-
                If the activity-based membership status flag is OFF- Displays
                the loyalty member’s status as active or inactive. By default,
                the status is active and can be changed to inactive as per the
                client’s request. If the activity-based membership status flag
                is ON- Displays the member status based on the defined
                activity-based criteria.
              example: ACTIVE
            phone:
              type: string
              description: Displays the phone number of the loyalty member.
              example: 44-32456
            birthDate:
              type: string
              description: >-
                Displays the date of birth of the loyalty member in yyyy-MM-dd
                format.
              example: '1989-12-11'
            anniversaryDate:
              type: string
              description: >-
                Displays the loyalty member's anniversary date, which can be
                their birthdate, the date they joined the loyalty program or
                marriage date in yyyy-MM-dd format.
              example: '2023-12-11'
            createdDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member was created.
              example: 2024-08-08T07:00:12+0000
            updatedDate:
              type: string
              description: >-
                Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format on
                which the loyalty member was updated.
              example: 2024-08-08T07:00:12+0000
            message:
              type: string
              description: >-
                Displays the message related to success of the loyalty member's
                deletion.
              example: Member deleted successfully.
    getgroup:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            siteIdGrouped:
              type: string
              description: Displays the multiple site IDs separated by commas.
              example: 9991331,9912061,47802121
            detail:
              type: object
              description: Displays the following information-
              properties:
                siteId:
                  type: string
                  description: Displays Annex Cloud site ID for the loyalty program.
                  example: '29235480'
                id:
                  type: string
                  description: Displays the unique ID of the loyalty member.
                  example: jacklee2023
                email:
                  type: string
                  description: Displays the email address of the loyalty member.
                  example: jacklee2023@gmail.com
                firstName:
                  type: string
                  description: Displays the first name of the loyalty member.
                  example: John
                lastName:
                  type: string
                  description: Displays the last name of the loyalty member.
                  example: Deo
                zipCode:
                  type: string
                  description: Displays the zip code of the loyalty member's residence.
                  example: 51750
                optInStatus:
                  type: string
                  description: >-
                    Displays the opt-in status as YES for opt-in or NO for
                    opt-out. The default opt-in status is YES.
                  example: 'YES'
                optInDate:
                  type: string
                  description: >-
                    Displays the opt-in date of the loyalty member in
                    yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2024-08-08T07:00:12+0000
                status:
                  type: string
                  description: >-
                    If the activity-based membership status flag is OFF-
                    Displays the loyalty member’s status as active or inactive.
                    By default, the status is active and can be changed to
                    inactive as per the client’s request. If the activity-based
                    membership status flag is ON- Displays the current status of
                    the member.
                  example: ACTIVE
                activityBasedStatus:
                  type: object
                  description: >-
                    When the activity-based membership flag is turned ON, it
                    displays the following information regarding the member's
                    upcoming status.
                  properties:
                    milestone:
                      type: integer
                      description: >-
                        Displays the upcoming milestone of the member based on
                        their activities. The administrator can configure a
                        maximum of five milestones.
                      example: 1
                    nextStatus:
                      type: string
                      description: >-
                        Displays the member's upcoming status, which can be
                        Dormant or Lapsed. This status can be customized by the
                        administrator.
                      example: Dormant
                    statusDate:
                      type: string
                      description: >-
                        Displays the date when the member's status will change
                        in YYYY-MM-DD format.
                      example: '2024-02-02'
                phone:
                  type: string
                  description: Displays the phone number of the loyalty member.
                  example: 123-123-4567
                birthDate:
                  type: string
                  description: >-
                    Displays the date of birth of the loyalty member in
                    yyyy-MM-dd format.
                  example: '1989-12-11'
                anniversaryDate:
                  type: string
                  description: >-
                    Displays the loyalty member's anniversary date, which can be
                    their birthdate, the date they joined the loyalty program or
                    marriage date in yyyy-MM-dd format.
                  example: '2023-12-11'
                userProfileImageUrl:
                  type: string
                  description: >-
                    Displays the image URL for the loyalty member’s profile
                    picture.
                  example: >-
                    https://www.socialannex.com/public/manageoptionsdesign16/images/product_landing/loyalty-hover.png
                source:
                  type: string
                  description: >-
                    Displays the source of the loyalty member's profile
                    creation, whether it was from a website, application, or
                    in-store.
                  example: website
                createDate:
                  type: string
                  description: >-
                    Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format
                    on which the loyalty member profile was created.
                  example: 2024-08-08T07:00:12+0000
                updateDate:
                  type: string
                  description: >-
                    Displays the date and time in yyyy-MM-dd’T’HH:mm:ssZ format
                    on which the loyalty member was updated.
                  example: 2024-08-08T07:00:12+0000
                totalSpendCurrency:
                  type: integer
                  description: Displays the total currency spent by the loyalty member.
                  example: 134
            extendedAttribute:
              type: object
              description: >-
                Displays the member attributes defined in your program
                configuration. This can be customized according to requirements.
                It accepts multiple parameters; however, these parameters must
                be defined under Products > Additional Loyalty Settings >
                Extended Attributes. Note - The extended attributes listed below
                are examples only. All extended attributes must be configured
                for the program as stated above.
              properties:
                userType:
                  description: >-
                    Displays the employment status of the member as employed,
                    unemployed, or student.
                  example: Employed
                  type: string
                userStatus:
                  description: >-
                    Displays the unique referrer code provided by the
                    Refer-a-Friend program (if applicable), when creating a
                    loyalty member profile.
                  example: Enabled
                  type: string
            raf:
              type: object
              description: >-
                Displays the incentiveId and referrerCode. This functionality is
                accessible to clients who have the Refer a Friend (RAF) module.
                Note - This module is only displayed to new members who sign up
                using a referrer code and take advantage of the loyalty program.
              properties:
                personalLink:
                  type: string
                  description: Displays the unique refer a friend bitly link.
                  example: https://bit.ly/3rShgt7"
                inviteCode:
                  type: string
                  description: >-
                    Displays the unique invite code shared by the loyalty member
                    to invite others to the loyalty program.
                  example: 3rShgt7
                referrerCode:
                  type: string
                  description: >-
                    Displays the unique referral code from the referrer, used
                    while creating a member (referee).
                  example: 3bhqc5k
                referrerName:
                  type: string
                  description: >-
                    Displays the name of the referrer whose referrer code was
                    used while creating a member (referee).
                  example: Adam
            hierarchyData:
              type: object
              description: >-
                Displays the following information about the group with which
                the member is associated.
              properties:
                groupId:
                  type: string
                  description: >-
                    Displays the ID of the group that the loyalty member belongs
                    to.
                  example: '91'
                addedOn:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member was added to
                    the group in yyyy-MM-dd'T'HH:mm:ssZ format.
                  example: 2020-10-12T00:00:00+0000
                groupAvailablePoints:
                  type: string
                  description: >-
                    Displays the total available points for the group. It is the
                    cumulative points of the group members.
                  example: 500
            topLevel/bottomLevel:
              type: object
              description: Displays the following details.
              properties:
                siteId:
                  type: string
                  description: Displays the Annex Cloud site ID for the loyalty program.
                  example: '29235480'
                siteName:
                  type: string
                  description: Displays the name of the site.
                  example: Socialannextestsite
                groupName:
                  type: string
                  description: >-
                    Displays the name of the group to which the loyalty member
                    is added.
                  example: Sweet Family 15
                memberId:
                  type: string
                  description: >-
                    Displays the member ID of the loyalty member associated with
                    the group.
                  example: user@domain.com
                blockedStatus:
                  type: string
                  description: >-
                    Display the blocked status of the loyalty member. (If Show
                    Blocked User Details functionality is enabled from the super
                    admin.). If the member is blocked, then it shows YES
                    otherwise it shows No.
                  example: 'YES'
                blockedBy:
                  type: string
                  description: >-
                    Displays the email address of the individual who blocked the
                    loyalty member. (If the Show Blocked User Details
                    functionality is enabled from the super admin.)
                  example: user@domain.com
                blockedDate:
                  type: string
                  description: >-
                    Displays the date on which the loyalty member was blocked in
                    yyyy-MM-dd'T'HH:mm:ssZ format. (If the Show Blocked User
                    Details functionality is enabled from the super admin.)
                  example: 2020-10-12T00:00:00+0000
    userdatasearchresp:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following details-
          properties:
            userId:
              type: string
              description: Displays the unique member ID of the loyalty member.
              example: exsdf1038
            firstName:
              type: string
              description: Displays the first name of the loyalty member.
              example: John
            lastName:
              type: string
              description: Displays the last name of the loyalty member.
              example: Deo
            email:
              type: string
              description: Displays the email address of the loyalty member.
              example: jacklee2023@gmail.com
            optInDate:
              type: string
              description: >-
                Displays the opt-in date of the loyalty member in
                yyyy-MM-dd'T'HH:mm:ssZ format.
              example: 2024-08-08T07:00:12+0000
            resourceURL:
              type: string
              description: >-
                Displays the source URL of the loyalty member's creation,
                whether it was from a website or an application.
              example: website
            totalRecords:
              type: string
              description: >-
                Displays the total number of records found while searching for
                loyalty member details.
              example: 100
            pages:
              type: string
              description: >-
                Displays the total number of pages that contain the details of
                the loyalty members who have been searched.
              example: 50
            currentPage:
              type: string
              description: >-
                Displays the current page number, which contains information
                related to the member search.
              example: 5
    patchTransactionErasureResp:
      type: object
      properties:
        Data:
          type: object
          description: Displays the following parameters-
          properties:
            orderId:
              type: string
              description: >-
                Displays the unique order ID of the order placed by the loyalty
                member.
              example: A2034354570
            userId:
              type: string
              description: Displays the unique ID of the loyalty member.
              example: exsdf1038
            pointsRefunded:
              type: integer
              description: >-
                Displays the points refunded to the loyalty member following the
                erasure of a transaction or the cancellation of an order. (In
                this scenario, the 100 points in the example indicate that the
                points were utilized to complete transaction erasure. The points
                are being reimbursed to the member when the transaction erasure
                is reversed).
              example: 100
            orderAttribute:
              type: object
              description: Displays the following details.
              properties:
                attribute_1:
                  type: string
                  description: >-
                    Displays a description of the attributes associated with an
                    order. The order attributes are completely configurable
                    based on the needs of the client.
                  example: Value1
    AddBlockList:
      type: object
      properties:
        userBlockListedData:
          type: object
          description: >-
            Displays the following details regarding the members added to the
            blocklist.
          properties:
            alreadyBlocklistedUser:
              type: array
              description: >-
                Displays the list of members that have been added to the
                blocklist, in accordance with administrator-initiated requests.
              example: sa.matthenryy12@gmail.com, joyroy.saa12
        domainBlocklistedData:
          type: object
          description: >-
            Displays the following details regarding the domains added to the
            blocklist.
          properties:
            alreadyBlocklistedDomain:
              type: array
              description: >-
                Displays the list of domains that have been added to the
                blocklist, in accordance with administrator-initiated requests.
              example: testdomain1.com
        blockedBy:
          type: string
          description: >-
            Displays the email ID of the administrator that has requested for
            users, domains, or both be added to the blocklist.
          example: xyz@annexcloud.com
    getBlockListDetails:
      type: object
      properties:
        blocklistUsers:
          type: object
          properties:
            userId:
              type: string
              description: >-
                Displays the user IDs of the members that have been added to the
                blocklist.
              example: sa.matthenryy12@gmail.com, joyroy.saa12
        blocklistDomain:
          type: object
          properties:
            domainId:
              type: string
              description: >-
                Displays the name of domains that have been added to the
                blocklist.
              example: testdomain1.com
    DeleteBlocklist:
      type: object
      properties:
        deletedUserData:
          type: object
          properties:
            userNotExistedInBlocklist:
              type: array
              description: >-
                Displays the user IDs of the members that have been requested to
                be deleted but do not exist in the blocklist. Multiple user IDs
                that do not exist in the blocklist are displayed separated with
                a comma.
              example: sa.matthenryy12@gmail.com, joyroy.saa12
        deletedDomainData:
          type: object
          properties:
            domainNotExistedInBlocklist:
              type: array
              description: >-
                Displays the domains that have been requested to be deleted but
                do not exist in the blocklist. Multiple domains that do not
                exist in the blocklist are displayed separated with a comma.
              example: testdomain1.com
tags:
  - name: Users
    description: >-
      Welcome to the User API Documentation for Annex Cloud! This comprehensive
      guide is designed to empower developers, administrators, and system
      integrators with the knowledge and tools necessary to seamlessly interact
      with our loyalty platform's user-related functionalities. As the
      cornerstone of our customer engagement ecosystem, the Users API enables
      you to effortlessly manage user profiles, personalize experiences, and
      unlock the full potential of our loyalty solutions.


      Whether you're aiming to integrate user registration into your
      application, retrieve user information for tailored experiences, or track
      user activity for insightful analytics, this documentation will serve as
      your compass in navigating the world of user management within our
      loyalty-based framework. We understand that your technical expertise is as
      unique as the experiences you aim to deliver to your users, and that's why
      we've crafted this guide to be both informative for newcomers and
      insightful for seasoned developers.


      By leveraging the power of the User API, you'll gain the ability to
      create, update, and retrieve user profiles, harnessing valuable data to
      drive loyalty strategies and cultivate lasting relationships. From
      conceptual overviews to in-depth endpoints and practical examples, we've
      curated a resource that not only imparts technical know-how but also
      encourages innovation and creativity in building user-centric solutions.


      Thank you for choosing Annex Cloud as your partner in loyalty solutions.
  - name: Points
    description: >-
      Welcome to the Points API documentation for Annex Cloud, your gateway to
      unlocking a world of loyalty-based rewards and customer engagement. In
      this comprehensive guide, we'll walk you through the powerful capabilities
      of our Points API, designed to seamlessly integrate with your systems and
      empower you to create unforgettable experiences for your customers.


      At Annex Cloud, we understand that building lasting relationships with
      your customers is at the core of your business. Our Points API provides
      you with the tools to effortlessly implement a robust loyalty program that
      not only drives customer retention but also enhances brand affinity.
      Whether you're a developer looking to integrate our API or a business
      leader seeking to harness the potential of loyalty rewards, this
      documentation will equip you with the knowledge and insights needed to
      succeed.


      From awarding points for purchases and referrals to offering personalized
      rewards and exclusive perks, our Points API puts the control in your
      hands. With clear and concise endpoints, accompanied by code samples and
      real-world use cases, you'll be able to quickly grasp the API's
      functionality and start building innovative loyalty solutions that set you
      apart in today's competitive market.


      Get ready to embark on a journey that goes beyond transactions. Let's dive
      into the intricacies of the Points API, where creativity meets technology
      to redefine the way you connect with your customers and drive sustainable
      business growth.
  - name: Action
    description: >-
      Welcome to the Action API Documentation for Annex Cloud! We understand
      that crafting an exceptional loyalty program involves more than just
      rewarding points—it's about creating dynamic and engaging experiences for
      your customers. Our Loyalty Actions API is your gateway to elevating your
      loyalty program, allowing you to design and implement meaningful
      interactions that resonate with your audience. The Loyalty Actions API by
      Annex Cloud is a powerful tool designed to help you go beyond traditional
      loyalty rewards. With this API, you can:


      Drive Customer Engagement-  Create interactive and personalized
      experiences to keep your customers actively involved in your loyalty
      program.


      Enable Real-time Interactions-  Implement actions that trigger instantly
      based on customer behavior, ensuring timely and relevant rewards.


      Enhance User Experience-  Seamlessly integrate actions into your existing
      applications, websites, and platforms to provide a cohesive and enjoyable
      user experience.


      Encourage Desired Behaviors- Design and deploy actions that align with
      your business objectives, encouraging customers to take specific actions
      that benefit both them and your brand.


      At Annex Cloud, we believe in the power of meaningful interactions to
      strengthen the bond between your brand and your customers. This
      documentation is your key to unlocking the full potential of our Loyalty
      Actions API, and we're excited to embark on this journey with you. Thank
      you for choosing Annex Cloud to enhance your loyalty program, and let's
      create extraordinary experiences together! Let's get started!
  - name: Activity
    description: >-
      Welcome to the Activity API documentation for Annex Cloud! Here, we are
      excited to guide you through the dynamic world of loyalty-based
      interactions and engagement. Our Activity API empowers you to seamlessly
      integrate and enhance your loyalty program with real-time activity
      tracking, enabling you to craft personalized experiences for your valued
      customers.


      In this comprehensive guide, you will find everything you need to know to
      leverage the full potential of our Activity API. Whether you are a
      seasoned developer looking to integrate our API into your existing
      systems, or a business visionary seeking to create innovative loyalty
      solutions, we have got you covered.


      From tracking points accumulation and rewards redemption to monitoring
      user interactions and crafting targeted campaigns, our Activity API opens
      doors to a new realm of customer engagement possibilities. We understand
      the significance of fostering lasting relationships with your clientele,
      and this API paves the way for fostering those connections in meaningful
      and profitable ways.


      Through easy-to-follow examples, detailed endpoints, request and response
      formats, this documentation will empower you to harness the power of our
      Activity API effectively. 


      Explore the API, experiment with its capabilities, and unlock the
      potential to redefine loyalty experiences for your customers. The
      possibilities are boundless, and the rewards are waiting. Let us get
      started!
  - name: Tiers
    description: >-
      Welcome to the Tiers API Documentation for Annex Clouds cutting-edge
      loyalty program platform. Our Tiers API empowers developers, businesses,
      and partners to seamlessly integrate and enhance their applications with
      our dynamic and customizable loyalty tiers system. This API documentation
      serves as your comprehensive guide to understanding and implementing the
      Tiers API, unlocking the full potential of loyalty-driven engagement for
      your customers.


      Whether you are looking to reward long-term patrons, incentivize higher
      spending, or create personalized experiences for your member base, our
      Tiers API offers a versatile solution that aligns with your unique
      business goals. By integrating this API, you can effortlessly design and
      manage multi-tiered loyalty structures that captivate, engage, and retain
      your audience, all while enjoying the ease of integration and scalability
      that our platform provides.


      Throughout this documentation, we will delve into the core functionalities
      of the Tiers API, walking you through the steps to seamlessly incorporate
      loyalty tiers into your applications. From setting up tier parameters and
      defining eligibility criteria, to handling tier transitions and leveraging
      tier-specific benefits, we have got you covered with clear instructions
      and code examples.
  - name: Rewards
    description: >-
      At Annex Cloud, we understand the power of loyalty and the importance of
      rewarding your customers for their continued support. Our Loyalty Rewards
      API is designed to help you seamlessly integrate and enhance your loyalty
      program, making it easier than ever to create engaging, customized, and
      rewarding experiences for your customers. Using our Rewards API, you can
      easily access and utilize members' rewards data, allowing you to keep tabs
      on your loyal customer base, their preferences, and their engagement with
      your program. Additionally, you can access a comprehensive list of rewards
      used by your members, providing insights into what incentives are most
      appealing and effective.


      This documentation covers everything you need to get started with our
      Loyalty Rewards API, including detailed information on available API
      endpoints and how to use them.


      Thank you for choosing Annex Cloud for your loyalty needs, and we look
      forward to helping you build stronger, more loyal customer relationships.
  - name: Segment
    description: >-
      Segment module can be used to differentiate the Users into groups which
      can be used in other loyalty modules for offers or campaigns. Define
      segments and conditions and use them to incentivize your members.
  - name: Campaign
    description: >-
      Welcome to the Loyalty Program Campaigns API Documentation for Annex
      Cloud! This comprehensive guide is designed to empower developers,
      businesses, and stakeholders to seamlessly integrate and leverage our
      Loyalty Program Campaigns API within their applications and systems.


      Our loyalty-based company understands the significance of fostering
      meaningful relationships with our valued customers. As such, we have
      crafted a powerful API that enables businesses to create, manage, and
      optimize loyalty campaigns, driving customer engagement, loyalty, and
      retention.


      Annex Cloud’s Loyalty Program Campaigns API is a robust and flexible tool
      that facilitates the integration of our loyalty program capabilities into
      your applications and platforms. Through this API, you can design and
      execute diverse loyalty campaigns, offering tailored rewards and
      incentives to your customers based on their actions, purchases, or
      interactions with your brand.



      By integrating our API, you unlock a plethora of benefits:



      Customized Loyalty Campaigns: Design unique loyalty campaigns that align
      with your business goals and resonate with your customer base.



      Enhanced Customer Engagement: Drive customer engagement by offering
      personalized rewards and promotions, enhancing their loyalty and advocacy.



      Real-time Performance Insights: Obtain real-time analytics and insights
      into the performance of your loyalty campaigns, allowing you to optimize
      strategies for maximum effectiveness.



      Seamless Integration: Easily integrate the Loyalty Program Campaigns API
      into your existing systems, ensuring a smooth and efficient loyalty
      program management process.



      This documentation covers essential aspects, endpoints, request and
      response examples, and best practices to ensure a seamless integration and
      utilization of the Loyalty Program Campaigns API. Let's embark on this
      journey to elevate your loyalty programs and build lasting connections
      with your cherished customers.
  - name: Orders
    description: >-
      Welcome to the Orders API documentation for Annex Cloud, where loyalty and
      seamless customer experiences converge. This API empowers developers,
      partners, and integrators to tap into the core of our loyalty-based
      ecosystem, enabling the creation of innovative and personalized solutions
      that enhance customer engagement and drive business growth.


      In this comprehensive guide, you will find all the essential information
      needed to integrate with our Orders API seamlessly. Whether you're a
      seasoned developer seeking to leverage the power of loyalty data or a
      business owner aiming to enhance customer satisfaction, this documentation
      will serve as your compass to navigate the world of loyalty-driven
      transactions.


      From placing orders and tracking purchases to utilizing loyalty rewards
      within the checkout process, the Orders API opens a realm of
      possibilities. By harnessing this interface, you can craft applications
      that bridge the gap between exceptional user experiences and business
      success.


      We've designed this documentation to provide clear insights into the
      capabilities, endpoints, authentication, and best practices for utilizing
      the Orders API effectively. As you embark on this integration journey, we
      encourage you to explore the diverse use cases, reference implementations,
      and code snippets that will help you hit the ground running.


      Thank you for choosing Annex Cloud as your partner in delivering
      unparalleled loyalty experiences. Let's dive into the intricacies of the
      Orders API and pave the way for loyalty-driven innovation that transforms
      the way customers interact with your brand. 
  - name: BlockList
    description: >-
      Welcome to Annex Cloud's Loyalty Blocklist API- a powerful tool designed
      to fortify the security and integrity of your loyalty program. In the
      dynamic landscape of customer engagement and rewards, ensuring the
      trustworthiness of your platform is paramount. Our Blocklist API is
      crafted to be the guardian of your loyalty ecosystem, providing a robust
      defense against fraudulent activities, unauthorized access, and other
      potential threats.


      Elevate your loyalty program security with Annex Cloud's Loyalty Blocklist
      API.
  - name: Product
    description: >-
      Welcome to the Annex Cloud Products API Documentation! We're excited to
      have you here as you explore the powerful tools and capabilities our
      Loyalty Program offers through this API.


      At Annex Cloud, we understand the significance of fostering customer
      loyalty. Our mission is to help businesses like yours build lasting
      relationships with their customers by offering engaging and rewarding
      loyalty programs. Our Products API is a key component of this mission,
      allowing you to seamlessly integrate our loyalty features into your
      applications and systems.


      This documentation is designed to be your comprehensive guide to using our
      Products API effectively. Whether you're a seasoned developer looking to
      dive into the technical details or a business owner seeking to enhance
      customer engagement, you'll find valuable information here to help you get
      started and make the most of our loyalty solutions.


      To begin using our Products API, you'll need an API key and a clear
      understanding of how our endpoints work. We've organized this
      documentation into user-friendly sections, including:
        
        
        Authentication: Learn how to securely authenticate your requests.
        
        
        Endpoints: Explore the various API endpoints available and how to use them effectively.
        
        
        Examples: Find practical examples and use cases to inspire your integration.


      We're here to support you on your journey to building a more loyal
      customer base and boosting your business's success. If you have any
      questions or need assistance, please don't hesitate to reach out to our
      dedicated support team.


      Thank you for choosing Annex Cloud as your partner in loyalty. Let's work
      together to create rewarding experiences for your customers.
  - name: Others
    description: >-
      At Annex Cloud, we understand the diverse needs of our clients and the
      dynamic landscape of the loyalty industry. The Others API is crafted to
      cater to specific requirements that go beyond the standard
      functionalities, offering you flexibility and customization.

      Through strategic utilization of Store ID and Site ID, you gain the power
      to precisely identify and manage various aspects of your loyalty program
      across different stores and sites.

      We invite you to delve into the Others API and elevate your loyalty
      strategy to meet the specific needs of your audience and unlock new
      dimensions of customer engagement.
  - name: Survey
    description: >-
      Welcome to the Survey API documentation for Annex Cloud! This
      comprehensive guide provides all the essential information and resources
      needed to integrate and interact with our survey platform
      programmatically.

      Our Survey API allows you to seamlessly integrate our powerful survey
      capabilities into your applications, websites, or systems. With this API,
      you can create, manage, and retrieve surveys, questions, responses, and
      more, empowering you to tailor survey experiences that align with your
      unique requirements.

      This documentation is designed to assist you in understanding how to
      leverage our API effectively, enabling you to:


      Create Surveys: Dynamically generate surveys with specific questions and
      formats to suit your needs.


      Retrieve Survey Data: Access survey responses and other relevant data for
      analysis or display.


      Manage Surveys and Questions: Edit, delete, or modify existing surveys and
      questions to maintain an up-to-date and relevant survey structure.


      Integrate Seamlessly: Integrate the survey capabilities seamlessly into
      your existing applications or platforms to collect valuable insights.


      The subsequent sections will guide you through the necessary steps,
      providing examples and explanations to facilitate a smooth integration
      process.
  - name: Store
    description: >-
      Welcome to the Store API documentation for Annex Cloud! We are thrilled to
      walk you through the exciting world of loyalty-based interactions and
      engagement. Our Store API allows you to seamlessly integrate and enhance
      your loyalty program by tracking real-time store details, enabling you to
      create personalized experiences for your valued customers.


      The Store API is used to create stores in bulk, update the information of
      the created stores, and fetch all the details of the existing stores. Each
      store is identified by a unique store ID, which distinguishes it from
      other stores.
  - name: Hierarchy Management
    description: >-
      Welcome to the Hierarchy Management API documentation for Annex Cloud! We
      are thrilled to walk you through the exciting world of loyalty-based
      interactions and engagement. Our Hierarchy Management API allows you to
      seamlessly integrate and enhance your loyalty program by tracking
      real-time Hierarchy Management details, enabling you to create
      personalized experiences for your valued customers.


      The API methods covered in this document will enable you to create new
      groups, manage the activities of existing groups, and retrieve group
      details.
  - name: Issuance
    description: >-
      Welcome to the Annex Cloud Issuance API documentation, where loyalty and
      seamless customer experiences converge. This comprehensive guide provides
      everything you need to seamlessly integrate with our transaction/issuance
      API. Whether you’re an experienced developer leveraging loyalty data or a
      business owner enhancing customer satisfaction, this documentation will
      guide you through the world of loyalty-driven transactions.


      The Order API lacks the ability to handle specific dynamic attributes
      during order creation. To address this limitation, we have introduced the
      Issuance API, designed to store and process orders. Unlike the Order API,
      this new API does not include predefined calculations and mirrors the
      functionalities of the Order API.


      Clients who would like to leverage more dynamic order attributes using the
      Issuance API will need to first calculate the points for spending and
      determine how members earn points. They will then send this value to our
      API, which should then accept it and grant the corresponding benefits
      based on the received payload.
  - name: Receipt
    description: >-
      At Annex Cloud, we recognize the significance of loyalty and the value of
      rewarding your customers for their ongoing support. Our Loyalty Receipts
      API is designed to help you seamlessly integrate and enhance your loyalty
      program by enabling receipt upload, verification, and reward management,
      making it easier than ever to create engaging, customized, and rewarding
      experiences for your customers.


      This documentation covers all aspects of the receipt upload and
      verification process. Once a receipt is successfully verified, members
      will earn points that they can redeem for coupons or use to purchase
      products based on their preferences.


      Thank you for choosing Annex Cloud for your loyalty needs. We look forward
      to assisting you in building stronger and more loyal customer
      relationships.
security:
  - MuseumPlaceholderAuth: []
