---
title: "Get shares related to this store"
method: GET
path: "/v2/user/customer/stores/{storeId}/shares"
tags: ["Customer - Shares"]
---

# Get shares related to this store

`GET /v2/user/customer/stores/{storeId}/shares`

## Request

- Base URL: `https://api.beezup.com`
- URL: `https://api.beezup.com/v2/user/customer/stores/{storeId}/shares`
- Auth: none declared
- TypeScript: <https://skmtc.dev/beezup/apis/beezup-merchant-api/docs/v2/user/customer/stores/:storeId/shares/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `storeId` string, guid, required

## Headers

- `If-None-Match` string

## Response `200`

The sharing list of the store

- StoreShares
  - `links` StoreSharesLinks, required
    - `self` 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
            - `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
    - `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
            - `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
  - `shares` StoreShare[], required
    - `userId` string, guid, required: The user identifier
    - `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
    - `links` StoreShareLinks, required: The different actions you can make on this store share
      - `deleteShare` LinksDeleteStoreShareLink
        - `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

## Other responses

- `304`: The ETag sent in the http header If-None-Match did not change. So you are up to date !
- `404`: Store not found or customer not the owner
- `default`: Occurs when something goes wrong

---

[API](https://skmtc.dev/beezup/apis/beezup-merchant-api.md) - [All operations](https://skmtc.dev/beezup/apis/beezup-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beezup/apis/beezup-merchant-api/revisions/3d07c0591478?raw)