# List Offers

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v3/{loyalty_club_slug}/members/me/offers:
    get:
      summary: List Offers
      deprecated: false
      description: >-
        Returns offers list.


        ## Query Parameters


        | Parameter               | Type      | Default    | Description

        |-------------------------|-----------|------------| -----------

        | scope                   | enum      | `standard` | Determines the
        scope the API operates on. See [Offers scoping](doc-341649#scoping)

        | per_page                | integer   | 100        | Number of results
        to be returned per request (100 is the maximum)

        | page_no                 | integer   | 1          | Number of results
        page

        | include_pagination_info | boolean   | false      | When true,
        pagination info (containing info like total records count, next page)
        will be returned

        | order_by                | string    | "name"     | See [`order_by`
        param](api-3510864#order_by-param)

        | collection_ids          | integer[] | null       | When present, only
        offers belonging to least one of given collections will be returned

        | stores                  | string[]  | null       | When present, only
        offers having at least one of given stores will be returned

        | store_ids               | integer[] | null       | When present, only
        offers having at least one of given stores will be returned

        | ids                     | integer[] | null       | When present, only
        offers with this id will be returned

        | type                    | string    | null       | When present, only
        offers of this type will be returned

        | campaign_id             | integer[] | null       | When present, only
        offers with this campaign_id will be returned

        | search                  | string    | null       | When present, only
        offers that match the query string will be returned

        | usable                  | boolean   | false      | When true, only
        offers that are usable will be returned

        | liked                   | boolean   | false      | When true, only
        offers that have been liked by member


        All parameters are optional.


        ### `order_by` param


        Offers list may be sorted by `order_by` param, which has similar syntax
        as ORDER BY keyword in SQL statements.


        For example `order_by=usable ASC, created_at DESC` will return offers
        sorted by their usability, then by their creation date.


        Following offer attributes may be used for sorting  in general:


        * name

        * usable_since

        * usable_until

        * created_at


        Only in member context (does not work with `/guest/` context: 


        * usable 

        * uses_left

        * liked 


        Also, when querying offers by *single* collection_id, the list may also
        be sorted by:


        * collection_position


        ## Response Body


        Key | Type | Optional? | Description

        --------- | --------- | -------- | ---------

        offers | Offer[] | no (may be empty)| See [Offer
        model](doc-341649#offer-model) 

        pagination_info | PaginationInfo | yes| See [Pagination info
        model](doc-341638)


        ## Example


        ```shell

        curl \

        "https://api.mpc.placewise.com/v3/infinity-mall/members/me/offers" \
            -H 'content-type: application/json' \
            -H 'authorization: Bearer 8433d608645345a45ce5a0f5ba1225e57546e86ac49e5fec842159dc82218522' \
            -H 'x-client-authorization: B7t9U9tsoWsGhrv2ouUoSqpM' \
            -H 'x-product-name: default' \
            -H 'x-user-agent: CURL manual test'
        ```


        When successful, returns a list of offers and pagination info. See
        [Offer model](doc-341649#offer-model) and [Offer
        model](doc-341649#offer-model)


        ```json

        {
          "offers": [
            {
              // (...) - see Offer model
            }
          ],
          "pagination_info": {
              // (...) - see Pagination info model
          }
        }

        ```
      tags:
        - API Reference/Public API/Offers/Offers
      parameters:
        - name: loyalty_club_slug
          in: path
          description: ''
          required: true
          example: infinity-mall
          schema:
            type: string
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  offers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Member%20Offer'
                x-apidog-orders:
                  - offers
                required:
                  - offers
                x-apidog-ignore-properties: []
              example:
                offers:
                  - id: 1552282
                    name: null
                    type: REGULAR
                    description: null
                    external_url: null
                    usable_since: '2025-06-28T10:00:00.0Z'
                    usable_until: '2030-05-05T15:00:00.0Z'
                    usage_authorization_token_required: false
                    collection_ids:
                      - 1029818
                    tags: []
                    shops:
                      - Espresso House
                    stores:
                      - Espresso House
                    store_ids:
                      - 36
                    files:
                      - null
                      - identifier: '1'
                        created_at: '2022-11-09T15:46:00.252860Z'
                        image_details: null
                      - null
                    display: {}
                    liked: false
                    usage: {}
                    extras:
                      designa_rebate_time_seconds: 56
                    authorization_code_displayed: true
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Public API/Offers/Offers
      x-apidog-status: pending
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3510864-run
components:
  schemas:
    Member Offer:
      type: object
      required:
        - id
        - type
        - usage_authorization_token_required
        - files
        - display
        - liked
        - usage
      properties:
        id:
          type: integer
          description: Unique identifier for the offer.
          examples:
            - 1552282
        name:
          type: string
          description: The name of the offer. Can be null.
          examples:
            - roses
            - null
          nullable: true
        type:
          type: string
          description: The type of the offer.
          enum:
            - REGULAR
            - BIRTHDAY
            - COMPETITION
          examples:
            - REGULAR
        description:
          type: string
          description: A description of the offer. Can be null.
          examples:
            - Special
            - null
          nullable: true
        external_url:
          type: string
          format: uri
          description: An external URL related to the offer, if any.
          examples:
            - https://example.com
            - null
          nullable: true
        usable_since:
          type: string
          format: date-time
          description: The date and time the offer becomes usable.
          examples:
            - '2025-06-28T10:00:00.000000Z'
          nullable: true
        usable_until:
          type: string
          format: date-time
          description: The date and time the offer ceases to be usable.
          examples:
            - '2030-05-05T15:00:00.000000Z'
            - null
          nullable: true
        usage_authorization_token_required:
          type: boolean
          description: Indicates if an authorization token is required to use the offer.
          examples:
            - false
        collection_ids:
          type: array
          description: A list of collection IDs this offer belongs to.
          items:
            type: integer
          examples:
            - - 1029818
        tags:
          type: array
          description: A list of tags associated with the offer.
          items:
            type: string
          examples:
            - - Benefit_10%
            - []
        shops:
          type: array
          description: A list of shop names where the offer is valid.
          items:
            type: string
          examples:
            - - Espresso House
        stores:
          type: array
          description: A list of store names where the offer is valid.
          items:
            type: string
          examples:
            - - Espresso House
        store_ids:
          type: array
          description: A list of store IDs where the offer is valid.
          items:
            type: integer
          examples:
            - - 36
        files:
          type: array
          description: A list of files associated with the offer, such as images.
          items:
            $ref: '#/components/schemas/File'
        display:
          type: object
          properties: {}
          x-apidog-orders: []
          x-apidog-ignore-properties: []
        liked:
          type: boolean
          description: Indicates whether the current user has liked this offer.
          examples:
            - false
        usage:
          type: object
          properties: {}
          x-apidog-orders: []
          x-apidog-ignore-properties: []
        extras:
          type: object
          description: A key-value object for extra, non-standard data.
          examples:
            - {}
            - designa_rebate_time_seconds: 56
          properties: {}
          x-apidog-orders: []
          x-apidog-ignore-properties: []
        authorization_code_displayed:
          type: boolean
          default: true
      x-apidog-orders:
        - id
        - name
        - type
        - description
        - external_url
        - usable_since
        - usable_until
        - usage_authorization_token_required
        - collection_ids
        - tags
        - shops
        - stores
        - store_ids
        - files
        - display
        - liked
        - usage
        - extras
        - authorization_code_displayed
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    File:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          examples:
            - https://example.com/image.png
        identifier:
          type: string
          description: Only present when parent record has many files
          examples:
            - '1'
        mime_type:
          type: string
          examples:
            - image/jpeg
          readOnly: true
          description: Only present in certain circumstances
          nullable: true
        created_at:
          type: string
          format: date-time
          examples:
            - '2022-11-09T15:46:00.252860Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          examples:
            - '2022-11-09T15:46:00.252860Z'
        image_details:
          type: object
          properties:
            width:
              type: integer
              minimum: 1
            height:
              type: integer
              minimum: 1
          x-apidog-orders:
            - width
            - height
          x-apidog-ignore-properties: []
          nullable: true
      x-apidog-orders:
        - url
        - identifier
        - mime_type
        - created_at
        - updated_at
        - image_details
      required:
        - url
        - created_at
        - updated_at
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```