# List

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/content/stores:
    get:
      summary: List
      deprecated: false
      description: Returns list of Stores
      tags:
        - API Reference/Public API/CMS Content/Stores
      parameters:
        - name: external_id
          in: query
          description: Filter stores by external id
          required: false
          example: '1'
          schema:
            type: string
        - name: search
          in: query
          description: >-
            When present, returns records matching this value (e.g. it's present
            in name)
          required: false
          example: presale
          schema:
            type: string
        - name: ids[]
          in: query
          description: When present, returns records with specific ids
          required: false
          example:
            - '1'
            - '2'
          schema:
            type: array
            items:
              type: integer
        - 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: 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:
                  stores:
                    type: array
                    items:
                      $ref: '#/components/schemas/Store'
                  pagination_info:
                    $ref: '#/components/schemas/PaginationInfo'
                x-apidog-orders:
                  - stores
                  - pagination_info
                required:
                  - stores
                  - pagination_info
                x-apidog-ignore-properties: []
              example:
                stores:
                  - id: 71
                    name: Graham - Kessler
                    type: store
                    slug: graham-kessler
                    description: >-
                      Perspiciatis casus avaritia templum brevis supplanto
                      votum. Demergo cur cubo cicuta suffoco debeo demens totus
                      in. Vulnero brevis quod suppono caput. Audeo velum
                      auxilium una. Pariatur cunctatio despecto tripudio adsum.
                      Patior sit pecto vinum. Caute distinctio turbo claro.
                      Denique vestrum crastinus veniam antea suus vallum aptus.
                    zip_code: 20536-3733
                    region: null
                    address: 48266 White Harbor
                    city: West Chasehaven
                    phone_number: 1-491-686-0580 x60090
                    email: Lydia.Funk3@yahoo.com
                    website_url: https://lovely-sediment.biz/
                    url: /71/graham-kessler
                    website_text: proident consequat officia tempor
                    location_description: >-
                      Candidus audacia verbera cedo apparatus aiunt. Cubicularis
                      sunt cunae collum. Laborum umerus velit arto ubi ullam
                      acceptus. Dicta taceo labore denuo correptius combibo.
                    map_key: null
                    social_profiles: null
                    opening_hours: null
                    opening_hours_text: null
                    status_message: >-
                      Spargo quidem triduana depopulo tubineus curo delectus.
                      Barba crepusculum supra quo vulgaris circumvenio deludo
                      earum convoco uter. Advenio color textilis brevis coniecto
                      assentator super sequi sub aestus.
                    categories: []
                    logo: null
                    images:
                      - identifier: '1'
                        created_at: '2022-11-09T15:46:00.252860Z'
                        image_details: null
                    external_id: '94'
                    external_url: https://sparse-haircut.name/
                  - id: 54
                    name: Altenwerth Weissnat
                    type: store
                    slug: altenwerth-weissnat
                    description: >-
                      Ex adinventitias caterva coruscus utpote torrens dolores
                      dedecor vomica. Tenetur acsi tumultus ullus vindico
                      tametsi varius tego spiculum. Amoveo cilicium defluo alo
                      suscipio vociferor patrocinor dolore pax universe. Bibo
                      accendo vereor trans spiculum vobis.
                    zip_code: 98912-7092
                    region: labore Ut proident consectetur
                    address: 20569 Kylee Radial
                    city: Johnpaulburgh
                    phone_number: 393-758-9101 x1301
                    email: Andreane4@gmail.com
                    website_url: https://troubled-breastplate.biz
                    url: /54/altenwerth-weissnat
                    website_text: ullamco in dolore consectetur proident
                    location_description: >-
                      Acerbitas alveus vulticulus depromo apud cervus cetera.
                      Desipio copia corroboro cum considero pecus thalassinus
                      curatio ustulo amplus.
                    map_key: null
                    social_profiles:
                      facebook: https://usable-shoulder.com
                      instagram: https://simple-forgery.org
                      linkedin: https://aggravating-birdcage.org
                    opening_hours: null
                    opening_hours_text: null
                    status_message: >-
                      Unde vox avaritia curso maxime. Asper vespillo sublime
                      tricesimus. Umbra suspendo voluptatum.
                    categories: []
                    logo: null
                    images:
                      - identifier: '1'
                        created_at: '2022-11-09T15:46:00.252860Z'
                        image_details:
                          width: 81647278
                          height: 52537050
                    external_id: '63'
                    external_url: https://experienced-travel.us/
                  - id: 63
                    name: Aufderhar LLC
                    type: store
                    slug: aufderhar-llc
                    description: >-
                      Delicate adinventitias uredo arx venustas certus carcer.
                      Turpis colo sublime. Denuncio excepturi advoco caterva
                      unus utique non sortitus certus. Officia arbitro candidus
                      depereo comis.
                    zip_code: '62221'
                    region: null
                    address: 823 Wilford Neck
                    city: Buckridgeland
                    phone_number: 1-604-419-9415 x463
                    email: Amalia36@gmail.com
                    website_url: https://best-palate.net/
                    url: /63/aufderhar-llc
                    website_text: minim eiusmod dolor
                    location_description: >-
                      Calamitas thymum cubitum texo summa. Cumque virgo deduco.
                      Claudeo exercitationem eaque assumenda deleo. Distinctio
                      apostolus undique. Versus alo arbitro aedificium sint
                      tubineus spectaculum umerus suscipio. Spiculum auctor ait
                      catena triduana canis succurro. Coma vallum urbanus
                      commodi terror stillicidium sursum sto. Tristis maxime
                      ulterius curvo.
                    map_key: sed
                    social_profiles:
                      facebook: https://lasting-sandbar.org
                      instagram: https://slight-cork.info/
                      linkedin: https://light-switch.us/
                    opening_hours:
                      - type: weekday
                        period: monday
                        hours:
                          opens_at: '09:00'
                          closes_at: '18:00'
                        description: Text
                      - type: weekday
                        period: sunday
                        hours:
                          opens_at: '12:00'
                          closes_at: '15:00'
                        description: Text
                    opening_hours_text: enim anim commodo non
                    status_message: >-
                      Certus statua delego caelum strues theca succurro autus.
                      Deserunt cubicularis velum beatus adfero. Delectatio
                      corona abundans demo aufero adflicto vaco suspendo amo
                      creta.
                    categories:
                      - id: 55608743
                        title: Tools
                        slug: tools
                      - id: 96581683
                        title: Kids
                        slug: kids
                    logo: null
                    images: []
                    external_id: '82'
                    external_url: https://first-license.net/
                pagination_info:
                  total_count: 2
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Public API/CMS Content/Stores
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3510903-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: ''
    Store:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
          x-apidog-mock: '{{$company.name}}'
        type:
          type: string
          default: store
        slug:
          type: string
        description:
          type: string
          nullable: true
        zip_code:
          type: string
          x-apidog-mock: '{{$location.zipCode}}'
          nullable: true
        region:
          type: string
          nullable: true
        address:
          type: string
          x-apidog-mock: '{{$location.streetAddress}}'
          nullable: true
        city:
          type: string
          x-apidog-mock: '{{$location.city}}'
          nullable: true
        phone_number:
          type: string
          x-apidog-mock: '{{$phone.number}}'
          nullable: true
        email:
          type: string
          x-apidog-mock: '{{$internet.email}}'
          nullable: true
        website_url:
          type: string
          x-apidog-mock: '{{$internet.url}}'
          nullable: true
        url:
          type: string
          nullable: true
        website_text:
          type: string
          description: Text to display along page Website URL
          nullable: true
        location_description:
          type: string
          description: Text describing Store location within Venue
          nullable: true
        map_key:
          type: string
          description: Identifier of Store on the virtual map
          nullable: true
        social_profiles:
          type: object
          properties:
            facebook:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            instagram:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            linkedin:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            snapchat:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            twitter:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            tiktok:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            youtube:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            pinterest:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            yelp:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            vimeo:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
            nextdoor:
              type: string
              x-apidog-mock: '{{$internet.url}}'
              nullable: true
          x-apidog-orders:
            - facebook
            - instagram
            - linkedin
            - snapchat
            - twitter
            - tiktok
            - youtube
            - pinterest
            - yelp
            - vimeo
            - nextdoor
          x-apidog-ignore-properties: []
          nullable: true
        opening_hours:
          anyOf:
            - $ref: '#/components/schemas/OpeningHoursList'
            - type: 'null'
        opening_hours_text:
          type: string
          description: Free-text description of opening hours
          nullable: true
        status_message:
          type: string
          description: custom store status
          nullable: true
        categories:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                minimum: 1
              title:
                type: string
                x-apidog-mock: '{{$commerce.department}}'
              slug:
                type: string
            x-apidog-refs: {}
            x-apidog-orders:
              - id
              - title
              - slug
            required:
              - id
              - title
              - slug
            x-apidog-ignore-properties: []
        logo:
          anyOf:
            - &ref_0
              $ref: '#/components/schemas/File'
            - type: 'null'
        images:
          type: array
          items: *ref_0
        external_id:
          type: string
          description: External id of the store from provider
          nullable: true
        external_url:
          type: string
          description: Store webisite outside of CMS (from scraped website for example)
          nullable: true
      x-apidog-orders:
        - id
        - name
        - type
        - slug
        - description
        - zip_code
        - region
        - address
        - city
        - phone_number
        - email
        - website_url
        - url
        - website_text
        - location_description
        - map_key
        - social_profiles
        - opening_hours
        - opening_hours_text
        - status_message
        - categories
        - logo
        - images
        - external_id
        - external_url
      required:
        - id
        - name
        - type
        - slug
        - description
        - zip_code
        - region
        - address
        - city
        - phone_number
        - email
        - website_url
        - url
        - website_text
        - location_description
        - map_key
        - social_profiles
        - opening_hours
        - opening_hours_text
        - status_message
        - categories
        - logo
        - images
        - external_id
        - external_url
      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: ''
    OpeningHoursList:
      type: array
      items:
        $ref: '#/components/schemas/OpeningHoursItem'
      description: 'See: [Opening Hours](doc-342133)'
      x-apidog-folder: ''
    OpeningHoursItem:
      type: object
      examples:
        - type: weekday
          period: monday
          hours:
            opens_at: '09:00'
            closes_at: '18:00'
          description:
            en: Text
        - type: weekday
          period: sunday
          hours:
            opens_at: '12:00'
            closes_at: '15:00'
          description:
            en: Text
        - type: day
          period: '2025-05-15'
          hours: null
          description:
            en: Closed
      properties:
        type:
          type: string
          examples:
            - weekday
          const: weekday
        period:
          anyOf:
            - description: 'For type: "day"'
              $ref: '#/components/schemas/date'
            - type: string
              enum:
                - monday
                - tuesday
                - wednesday
                - thursday
                - friday
                - saturday
                - sunday
              x-apidog-enum:
                - value: monday
                  name: ''
                  description: ''
                - value: tuesday
                  name: ''
                  description: ''
                - value: wednesday
                  name: ''
                  description: ''
                - value: thursday
                  name: ''
                  description: ''
                - value: friday
                  name: ''
                  description: ''
                - value: saturday
                  name: ''
                  description: ''
                - value: sunday
                  name: ''
                  description: ''
              description: 'For type: "weekday"'
        hours:
          type: object
          properties:
            opens_at:
              type: string
              description: Hour of entity opening time
              examples:
                - '09:00'
              pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
            closes_at:
              type: string
              description: |
                Hour of entity closing time
              examples:
                - '15:00'
              pattern: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$
          x-apidog-orders:
            - opens_at
            - closes_at
          required:
            - opens_at
            - closes_at
          description: When null, object is closed at this period
          x-apidog-ignore-properties: []
          nullable: true
        description:
          description: Additional description useful for "day" type
          $ref: '#/components/schemas/LocalizedContent'
      x-apidog-orders:
        - type
        - period
        - hours
        - description
      readOnly: true
      required:
        - type
        - period
        - hours
      x-apidog-refs: {}
      x-apidog-ignore-properties: []
      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: ''
    date:
      type: string
      format: date
      examples:
        - '2023-01-15'
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```