# List Retailers

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v4/stores/retailers:
    get:
      summary: List Retailers
      deprecated: false
      description: ''
      tags:
        - API Reference/Management API/Stores/V4 API/Retailers
      parameters:
        - name: per_page
          in: query
          description: >-
            Number of results to be returned per request. See: [API
            Pagination](doc-341638)
          example: 10
          schema:
            type: integer
            default: '10'
        - name: page_no
          in: query
          description: 'Number of results page. See: [API Pagination](doc-341638)'
          example: 1
          schema:
            type: integer
            minimum: 1
            default: '1'
        - name: sort_by[]
          in: query
          description: 'See: [Sorting params](doc-341639)'
          example: id
          schema:
            type: string
            default: id
        - name: sort_directions[]
          in: query
          description: 'See: [Sorting params](doc-341639)'
          example: DESC
          schema:
            type: string
            enum:
              - ASC
              - DESC
            examples:
              - ASC
              - DESC
            default: DESC
            x-apidog-enum:
              - value: ASC
                name: ''
                description: ''
              - value: DESC
                name: ''
                description: ''
        - 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:
                  retailers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Retailer'
                  pagination_info:
                    $ref: '#/components/schemas/PaginationInfo'
                x-apidog-orders:
                  - retailers
                  - pagination_info
                required:
                  - retailers
                  - pagination_info
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Management API/Stores/V4 API/Retailers
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511061-run
components:
  schemas:
    PaginationInfo:
      type: object
      properties:
        count:
          type: integer
          description: Actual number of results returned in request
          readOnly: true
          examples:
            - 1000
        total_count:
          type: integer
          description: Number of all available results
          minimum: 1
          examples:
            - 2050
        per_page:
          type: integer
          description: Number of results returned per request
          readOnly: true
          examples:
            - 1000
        total_pages:
          type: integer
          description: Number of all available pages
          readOnly: true
          examples:
            - 3
        current_page:
          type: integer
          readOnly: true
          examples:
            - 1
        next_page:
          type: integer
          description: Next available page (null when it's a last page)
          readOnly: true
          examples:
            - 2
          nullable: true
        prev_page:
          type: integer
          description: Next available page (null when it's a first page)
          readOnly: true
          examples:
            - null
          nullable: true
        is_first_page:
          type: boolean
          readOnly: true
          examples:
            - true
        is_last_page:
          type: boolean
          readOnly: true
          examples:
            - false
        is_out_of_range:
          type: boolean
          description: Is given `per_page` param out of range?
          readOnly: true
          examples:
            - false
        offset:
          type: integer
          readOnly: true
          examples:
            - 0
      required:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      x-apidog-orders:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    Retailer:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        name:
          type: string
          examples:
            - Placewise
        slug:
          type: string
          description: When not provided, it's auto-generated from name
          examples:
            - slug
        country:
          $ref: '#/components/schemas/country'
        description:
          anyOf:
            - $ref: '#/components/schemas/LocalizedContent'
              readOnly: true
            - type: 'null'
        phone_number:
          anyOf:
            - $ref: '#/components/schemas/msisdn'
            - type: 'null'
        email:
          anyOf:
            - $ref: '#/components/schemas/email'
            - type: 'null'
        website_url:
          description: Address of the external website of Retailer/Retailer
          anyOf:
            - &ref_1
              $ref: '#/components/schemas/url'
            - type: 'null'
        logo:
          description: 'Must be uploaded as a file of type: retailer_logo'
          anyOf:
            - &ref_0
              description: 'Must be uploaded as a file of type: retailer_logo'
              $ref: '#/components/schemas/File'
              readOnly: true
            - type: 'null'
        us_legacy_data:
          anyOf:
            - $ref: '#/components/schemas/cms.us_legacy_data'
            - type: 'null'
        external_master:
          anyOf:
            - $ref: '#/components/schemas/cms.external_master'
            - type: 'null'
        social_profiles:
          $ref: '#/components/schemas/cms.social_profiles'
        images:
          type: array
          items: *ref_0
          description: 'Must be uploaded as a file of type: retailer_image'
          readOnly: true
        created_at:
          $ref: '#/components/schemas/date_time.created_at'
        updated_at:
          description: Time of record last update
          $ref: '#/components/schemas/date_time.updated_at'
      x-apidog-orders:
        - id
        - name
        - slug
        - country
        - description
        - phone_number
        - email
        - website_url
        - logo
        - us_legacy_data
        - external_master
        - social_profiles
        - images
        - created_at
        - updated_at
      required:
        - id
        - name
        - slug
        - country
        - description
        - phone_number
        - email
        - website_url
        - logo
        - us_legacy_data
        - external_master
        - social_profiles
        - images
        - created_at
        - updated_at
      readOnly: true
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date_time.updated_at:
      type: string
      description: Time of the last record update
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    date_time.created_at:
      type: string
      description: Time of record creation
      format: date-time
      examples:
        - '2022-11-05T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    cms.social_profiles:
      type: object
      properties:
        facebook: *ref_1
        twitter: *ref_1
        instagram: *ref_1
        linkedin: *ref_1
        snapchat: *ref_1
        tiktok: *ref_1
        youtube: *ref_1
        pinterest: *ref_1
      x-apidog-orders:
        - facebook
        - twitter
        - instagram
        - linkedin
        - snapchat
        - tiktok
        - youtube
        - pinterest
      description: 'URLs on specific social media '
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    cms.external_master:
      type: string
      description: 'When present, the record is being synced from given external source '
      examples:
        - scraper
      x-apidog-folder: ''
    cms.us_legacy_data:
      type: object
      properties: {}
      x-apidog-orders: []
      description: Extra content for migrated content from legacy system
      additionalProperties: true
      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: ''
    url:
      type: string
      examples:
        - https://example.com
      x-apidog-folder: ''
    email:
      type: string
      format: email
      examples:
        - somebody@example.com
      x-apidog-folder: ''
    msisdn:
      type: string
      description: '[E.164 MSISDN](https://en.wikipedia.org/wiki/E.164) '
      examples:
        - '4740769126'
      x-apidog-folder: ''
    LocalizedContent:
      type: object
      properties: {}
      x-apidog-orders: []
      title: ''
      examples:
        - en: Text
      additionalProperties:
        type: string
        description: >-
          The actual set of languages depends on LC configuration. See:
          [Localization](doc-341959)
        examples:
          - Tekst
        nullable: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    country:
      type: string
      description: '[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)'
      examples:
        - 'NO'
      x-apidog-folder: ''
    id:
      type: integer
      description: Primary identifier of the record
      format: uint64
      readOnly: true
      examples:
        - 1
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```