---
title: "Store List Response"
url: "https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c/schemas/StoreListResponse"
---

> Full API specification: https://developer.retailexpress.com.au/apis/public-api-0/versions/d2454f6f-56f1-4fd6-9cd1-82871d94bd1c.md

# Store List Response

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: PublicApi
  version: 0.1.0
servers:
  - url: https://api.retailexpress.com.au/{basePath}
    variables:
      basePath:
        default: v1
components:
  schemas:
    PageNumber:
      title: Page Number
      type: integer
      description: The current page number
    Store:
      type: object
      properties:
        country:
          title: Country
          type: string
          description: The country of the address
        last_modified_on:
          $ref: "#/components/schemas/LastModifiedOn"
        email_address:
          title: Email Address
          type: string
          description: The email address of the store
        post_code:
          title: Postcode
          type: string
          description: The postcode of the address
        external_reference:
          title: External Reference
          type: string
          description: An external reference given to the store for external systems
        timezone_id:
          title: Timezone Identifier
          type: string
          description: The timezone identifier for the store
        address_line_1:
          title: Address Line 1
          type: string
          description: The first line of the address
        name:
          title: Name
          type: string
          description: The name of the store
        suburb:
          title: Suburb
          type: string
          description: The suburb of the address
        phone_number:
          title: Phone Number
          type: string
          description: The phone number of the store
        address_line_2:
          title: Address Line 2
          type: string
          description: The second line of the address
        state:
          title: State
          type: string
          description: The state of the address
        id:
          title: ID
          type: string
          description: The ID of the store
      description: A retail store/outlet
    TotalRecords:
      title: Total Record Count
      type: integer
      description: The total number of records in your query
    TotalPages:
      title: Total Page Count
      type: integer
      description: The total number of pages in your query
    PageSize:
      title: Page Size
      type: integer
      description: The maximum number of records in a single page
    LastModifiedOn:
      title: Last Modified On
      type: string
      description: The date and time the record was last modified
      format: date-time
    StoreListResponse:
      title: Store List Response
      type: object
      properties:
        page_number:
          $ref: "#/components/schemas/PageNumber"
        stores:
          type: array
          description: A list of stores
          items:
            $ref: "#/components/schemas/Store"
        total_records:
          $ref: "#/components/schemas/TotalRecords"
        total_pages:
          $ref: "#/components/schemas/TotalPages"
        page_size:
          $ref: "#/components/schemas/PageSize"
```