---
title: "Get store list"
method: GET
path: "/v2/user/customer/stores"
tags: ["Customer - Stores"]
---

# Get store list

`GET /v2/user/customer/stores`

## Headers

- `If-None-Match` string

## Response `200`

Store list

- StoreList
  - `links` StoreListLinks, required — The action links you can do globally on stores
    - `self` LinksGetStoresLink
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
    - `createStore` LinksCreateStoreLink
      - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
      - `docUrl` string, uri — The documentation related to this operation.
      - `description` string — The description of the link
      - `href` string, required — Indicate the relative uri for this link
      - `operationId` string — The operationId to call.
      - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
      - `parameters` object
      - `urlTemplated` boolean — indicates whether the href is templated or not
      - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
      - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
      - `info` BeezUPCommonInfoSummaries
        - `successes` BeezUPCommonSuccessSummary[]
          - `successCode` string
          - `successMessage` string
          - `successArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
        - `errors` BeezUPCommonErrorSummary[]
          - `utcDate` string, date-time
          - `errorGuid` string, uuid
          - `errorCode` string
          - `errorMessage` string
          - `technicalErrorMessage` string
          - `exceptionDetail` BeezUPCommonExceptionDetail
            - `helpLink` string
            - `message` string
            - `stackTrace` string
            - `type` string
          - `errorArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
          - `source` string
        - `warnings` BeezUPCommonWarningSummary[]
          - `technicalErrorMessage` string
          - `warningMessage` string
          - `warningCode` string
          - `warningArguments` object
        - `informations` BeezUPCommonInfoSummary[]
          - `informationCode` string
          - `informationMessage` string
          - `informationArguments` object
          - `propertyName` string
          - `propertyValue` string
          - `objectName` string
  - `stores` Store[], required
    - `storeId` string, guid, required — The store identifier
    - `name` string, required — The store name. Must be unique.
    - `url` string, required — The url of your store
    - `countryIsoCodeAlpha3` string, required — The country iso code alpha 3 based on the list of values /user/lov/StoreCountryWithInternational
    - `currencyCode` string, required — The currency code <a href="https://en.wikipedia.org/wiki/ISO_4217">(ISO 4217)</a>
    - `sectors` StoreSector[], required — The store's sectors based on the list of values /user/lov/ParamSector
    - `userRole` 'Owner' | 'User', required — Indicates the role can have a user on a store. * Owner: Indicates that you are the owner of this store * User: Indicates that you are a simple user on this store
    - `status` 'Active' | 'SystemBlocked' | 'UserBlocked', required — The store status * Active: When the store is active * SystemBlocked: When the store is blocked by the system * UserBlocked: When the store is blocked on GO not on the system
    - `ownerUserId` string, guid, required — The user id of the owner of the store
    - `offerId` integer, required — The offer id based on /offers. Not a free offer of course.
    - `offerName` string, required — The offer Name
    - `shareCount` integer, required — The share count related to this store
    - `creationUtcDate` string, date-time, required — The creation date of the store
    - `goVersion` integer, required — The version of GO to use
    - `links` StoreLinks, required — The action links for this store
      - `self` LinksGetStoreLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `deleteStore` LinksDeleteStoreLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `updateStore` LinksUpdateStoreLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `shares` LinksGetStoreSharesLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
      - `share` LinksShareStoreLink
        - `label` string — The label corresponding to the link. This label is automatically translated based on the Accept-Language http header.
        - `docUrl` string, uri — The documentation related to this operation.
        - `description` string — The description of the link
        - `href` string, required — Indicate the relative uri for this link
        - `operationId` string — The operationId to call.
        - `method` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' | 'HEAD' — Indicate the http method to use on this link
        - `parameters` object
        - `urlTemplated` boolean — indicates whether the href is templated or not
        - `allRequiredParamsProvided` boolean — indicates whether all required params have been provided
        - `allOptionalParamsProvided` boolean — indicates whether all optionals params have been provided
        - `info` BeezUPCommonInfoSummaries
          - `successes` BeezUPCommonSuccessSummary[]
            - `successCode` string
            - `successMessage` string
            - `successArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
          - `errors` BeezUPCommonErrorSummary[]
            - `utcDate` string, date-time
            - `errorGuid` string, uuid
            - `errorCode` string
            - `errorMessage` string
            - `technicalErrorMessage` string
            - `exceptionDetail` BeezUPCommonExceptionDetail
              - …
            - `errorArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
            - `source` string
          - `warnings` BeezUPCommonWarningSummary[]
            - `technicalErrorMessage` string
            - `warningMessage` string
            - `warningCode` string
            - `warningArguments` object
          - `informations` BeezUPCommonInfoSummary[]
            - `informationCode` string
            - `informationMessage` string
            - `informationArguments` object
            - `propertyName` string
            - `propertyValue` string
            - `objectName` string
    - `isTest` boolean, required — Is the store a test or a production store

## Other responses

- `304` — The ETag sent in the http header If-None-Match did not change. So you are up to date !
- `default` — Occurs when something goes wrong

---

[API](https://skmtc.net/beezup/apis/beezup-merchant-api.md) · [All operations](https://skmtc.net/beezup/apis/beezup-merchant-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beezup/beezup-merchant-api/revisions/557b7feddf8a/schema)