Emporix Signed-In Customer Reward Points API

openapi: 3.2.0
info:
  title: Emporix Signed-In Customer Reward Points API
  version: ''
  contact:
    email: documentation@emporix.com
  description: 'Operations tagged Signed-In Customer Reward Points across 2 of this provider''s published API definitions: emporix-reward-points-openapi.yml, emporix-reward-points-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.emporix.io
security:
- OAuth2: []
tags:
- name: Signed-In Customer Reward Points
paths:
  /reward-points/public/customer:
    get:
      description: 'Fetches the number of reward points of a currently signed-in customer.


        **Note:** This public API endpoint is accessible to all customers.'
      operationId: GET-reward-points-fetch-logged-customer-points
      tags:
      - Signed-In Customer Reward Points
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                title: pointsOut
                type: integer
              examples:
                'Number of points ':
                  value: 1153
        '401':
          $ref: '#/components/responses/trait_unauthorized_401'
        '403':
          $ref: '#/components/responses/trait_forbidden_403'
        '500':
          $ref: '#/components/responses/trait_internal_500'
      parameters: []
      security:
      - CustomerAccessToken: []
      summary: Retrieving reward points of a signed-in customer
    servers:
    - url: https://api.emporix.io
  /reward-points/public/customer/summary:
    get:
      description: 'Retrieves a detailed summary of added and redeemed reward points of a signed-in customer.


        **Note:** This public API endpoint is accessible to all customers.'
      operationId: GET-reward-points-retrieve-logged-customer-reward-summary
      tags:
      - Signed-In Customer Reward Points
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pointsSummaryOut'
              examples:
                Customer Summary:
                  value:
                    customerId: '123'
                    activePoints: 1153
                    summary:
                      addedPointsList:
                      - id: zzpscd12uimlmybtthb
                        reference-id: B7011746
                        description: Bonuspunkte für Bestellung B7011746
                        points: 209
                        createdAt: '2020-09-03T09:45:02.248+00:00'
                        allPointsAfterCreation: 209
                        usedPoints: 209
                        validUntil: '2023-09-02T22:00:00.000+00:00'
                        usedWith:
                        - e7522b99-2448-44b5-8f68-8bffcc207d18
                      - id: c9joe623gl4obochkrmy8i
                        reference-id: B7011745
                        description: Bonuspunkte für Bestellung B7011745
                        points: 209
                        createdAt: '2020-09-03T09:45:02.318+00:00'
                        allPointsAfterCreation: 418
                        usedPoints: 209
                        validUntil: '2023-09-02T22:00:00.000+00:00'
                        usedWith:
                        - e7522b99-2448-44b5-8f68-8bffcc207d18
                      redeemedPointsList:
                      - id: e7522b99-2448-44b5-8f68-8bffcc207d18
                        description: Für 600 Punkte können Sie sich einen Gutschein über 5 Euro generieren lassen. Diesen Gutschein können Sie auch an Freunde und Bekannte weitergeben.
                        points: 600
                        createdAt: '2020-09-03T12:44:22.747+00:00'
                        allPointsAfterCreation: 2953
        '401':
          $ref: '#/components/responses/trait_unauthorized_401'
        '403':
          $ref: '#/components/responses/trait_forbidden_403'
        '500':
          $ref: '#/components/responses/trait_internal_500'
      parameters: []
      security:
      - CustomerAccessToken: []
      summary: Retrieving a reward points summary of a signed-in customer
    servers:
    - url: https://api.emporix.io
  /reward-points/public/customer/redeem:
    post:
      description: 'Gets the logged-in customer''s reward points, swaps them for a coupon code by using the given redemption option ID, and returns a coupon code.


        **Note:** This public API endpoint is accessible to all customers and is meant to be used on the storefront.'
      operationId: POST-reward-points-redeem-logged-customer-reward-points-coupon
      tags:
      - Signed-In Customer Reward Points
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/redeemCouponOut'
              examples:
                response:
                  value:
                    code: LLS-232394
        '400':
          $ref: '#/components/responses/trait_badRequest_400'
        '403':
          $ref: '#/components/responses/trait_forbidden_403'
        '404':
          $ref: '#/components/responses/trait_notFound_404'
        '500':
          $ref: '#/components/responses/trait_internal_500'
      parameters:
      - $ref: '#/components/parameters/siteCode'
      requestBody:
        content:
          application/json:
            schema:
              title: redeemOptionIn
              example:
                id: 575937654bf757001d8496c9
              type: object
              properties:
                id:
                  type: string
                  description: The ID of the redeem option used to convert points into a coupon.
              required:
              - id
            examples:
              Redeem points:
                value:
                  id: 575937654bf757001d8496c9
      security:
      - CustomerAccessToken: []
      summary: Redeeming a logged-in customer's reward points for a coupon code
    servers:
    - url: https://api.emporix.io
components:
  schemas:
    customerSummary:
      title: customerSummary
      type: object
      properties:
        addedPointsList:
          type: array
          items:
            $ref: '#/components/schemas/addedPoints'
        redeemedPointsList:
          type: array
          items:
            $ref: '#/components/schemas/redeemedPoints'
      required:
      - addedPointsList
    addedPoints:
      title: addedPoints
      type: object
      properties:
        id:
          type: string
        reference-id:
          type:
          - string
          - 'null'
          description: Order Id for which the points were created
        description:
          type: string
          description: Auto-generated description
        points:
          type: integer
          description: Number of points added in the operation
        createdAt:
          type: string
          format: date-time
        validUntil:
          format: date-time
          type: string
          description: The date until when the points can be redeemed
        allPointsAfterCreation:
          type: integer
          description: Number of points after creation
        usedPoints:
          type: integer
          description: Number of points already used
        usedWith:
          type: array
          items:
            type: string
      required:
      - points
    redeemCouponOut:
      title: CouponCode
      type: object
      properties:
        code:
          type: string
          description: Coupon code received after exchanging points
    redeemedPoints:
      title: redeemedPoints
      type: object
      properties:
        id:
          type: string
          description: Identifier of the redeemed points
        description:
          type: string
          description: A comment for the redeem operation
        points:
          type: integer
          description: The amount of the redeemed points
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the points were redeemed
        allPointsAfterCreation:
          type: integer
          description: Number of points after creation
      required:
      - points
    pointsSummaryOut:
      title: pointsSummaryOut
      type: object
      properties:
        customerId:
          type: string
          description: Id of the customer to whom the points are assigned
        activePoints:
          type: integer
          description: Active points that can be redeemed
        summary:
          $ref: '#/components/schemas/customerSummary'
  responses:
    trait_badRequest_400:
      description: Request syntactically incorrect. Details of the error are included in the response payload.
      content:
        application/json:
          schema:
            title: error
            description: Schema for API specified errors.
            example:
              status: 400
              message: There are validation problems, see details section for more information
              moreInfo: ''
              type: validation_violation
              details:
              - field: tenant
                message: size must be between 3 and 16
                type: invalid_header
            type: object
            properties:
              status:
                minimum: 100
                maximum: 599
                description: Original HTTP error code, should be consistent with the response HTTP code
                type: integer
              title:
                pattern: '[a-z]+[a-z_]*[a-z]+'
                description: 'Classification of the error type in the lower case with underscore format, for example: `validation_failure`'
                type: string
              type:
                description: Type of the error.
                type: string
              instance:
                type: string
                description: Resource link
              detail:
                description: Detailed information about the error.
                type: string
          examples:
            Bad request:
              value:
                type: about:blank
                title: Bad Request
                status: 400
                detail: Invalid request content.
                instance: /customer/61443563/addPoints
    trait_internal_500:
      description: Internal error
      content:
        application/json:
          schema:
            title: error
            description: Schema for API specified errors.
            type: object
            properties:
              timestamp:
                description: Timestamp when the error occurred.
                type: string
              status:
                description: Original HTTP error code, should be consistent with the response HTTP code
                type: integer
              error:
                description: Descriptive error message for debugging
                type: string
              path:
                description: Path of a resource that caused the error.
                type: string
          examples:
            Internal error:
              value:
                timestamp: '2023-10-12T06:41:03.866+00:00'
                status: 500
                error: Internal Server Error
                path: /customer/30010284222
    trait_forbidden_403:
      description: 'Given authorization scopes are not sufficient and do not match required scopes.

        '
      content:
        application/json:
          schema:
            title: error
            description: Schema for API specified errors.
            type: object
            properties:
              code:
                minimum: 100
                maximum: 599
                description: Original HTTP error code, should be consistent with the response HTTP code
                type: integer
              status:
                pattern: '[a-z]+[a-z_]*[a-z]+'
                description: 'Classification of the error type in the lower case with underscore format, for example: `validation_failure`'
                type: string
              message:
                description: Descriptive error message for debugging
                type: string
              details:
                description: List of problems causing this error
                type: array
                items:
                  title: errorDetail
                  description: Schema for a specific error cause
                  type: string
            required:
            - code
            - status
          examples:
            Forbidden:
              value:
                code: 403
                status: Forbidden
                message: Scope validation failed
                details:
                - Missing required scopes '[rewardspoints.rewardpoints_view, saasag.rewardpoints_view]'
    trait_unauthorized_401:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
          examples:
            Unauthorized:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
    trait_notFound_404:
      description: 'Entity not found.

        '
      content:
        application/json:
          schema:
            title: error
            description: Schema for API specified errors.
            type: object
            properties:
              type:
                description: 'Classification of the error type in the lower case with underscore format, for example: `validation_failure`'
                type: string
              status:
                description: Original HTTP error code, should be consistent with the response HTTP code
                type: integer
              message:
                description: Descriptive error message for debugging
                type: string
              details:
                description: List of problems causing this error
                type: array
                items:
                  title: errorDetail
                  description: Schema for a specific error cause
                  type: string
          examples:
            Not Found:
              value:
                type: resource_not_found
                status: 404
                message: No reward points found for customer 202429132
  parameters:
    siteCode:
      name: siteCode
      in: query
      required: false
      schema:
        type: string
        default: main
      description: Site code, defined when a site is created.
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.emporix.io/oauth/token
          scopes:
            rewardspoints.rewardpoints_view: Nedeed to view reward points information
            rewardspoints.rewardpoints_manage: Needed to manage reward points
    CustomerAccessToken:
      type: http
      scheme: bearer
x-refined-from:
- emporix-reward-points-openapi.yml
- emporix-reward-points-openapi.yml