> ## Documentation Index
> Fetch the complete documentation index at: https://docs.archeraffiliates.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List a brand's storefront destinations

> Returns the active Amazon Store pages that can be promoted for one brand. Identify the brand with either `brand_id` or its exact `brand_name`. If an active homepage is available, it is the first returned page. Pass both a returned row's `brand_id` and `store_page_id` to `POST /generate_attribution_link`.



## OpenAPI

````yaml /docs/api-reference/openapi.json get /storefront_links
openapi: 3.1.0
info:
  title: Archer Affiliates API
  description: API that allows use of features on the Archer Platform
  version: '2.0'
servers:
  - url: https://api.archeraffiliates.com
    description: Production
security: []
paths:
  /storefront_links:
    get:
      tags:
        - Storefront Links
      summary: List a brand's storefront destinations
      description: >-
        Returns the active Amazon Store pages that can be promoted for one
        brand. Identify the brand with either `brand_id` or its exact
        `brand_name`. If an active homepage is available, it is the first
        returned page. Pass both a returned row's `brand_id` and `store_page_id`
        to `POST /generate_attribution_link`.
      operationId: get_storefront_links_storefront_links_get
      parameters:
        - name: brand_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Brand identifier from `GET /brands`.
            title: Brand Id
          description: Brand identifier from `GET /brands`.
        - name: brand_name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Exact brand name, matched case-insensitively.
            title: Brand Name
          description: Exact brand name, matched case-insensitively.
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: How many storefront pages to skip.
            default: 0
            title: Skip
          description: How many storefront pages to skip.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: How many storefront pages to return (1-500).
            default: 100
            title: Limit
          description: How many storefront pages to return (1-500).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorefrontLinksResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    StorefrontLinksResponse:
      properties:
        brand_id:
          type: string
          title: Brand Id
        brand_name:
          type: string
          title: Brand Name
        storefront_enabled:
          type: boolean
          title: Storefront Enabled
        total_count:
          type: integer
          title: Total Count
          description: Total matching storefront pages before pagination.
        fetched_count:
          type: integer
          title: Fetched Count
        skip:
          type: integer
          title: Skip
        limit:
          type: integer
          title: Limit
        storefront_links:
          items:
            $ref: '#/components/schemas/StorefrontLinkOption'
          type: array
          title: Storefront Links
      type: object
      required:
        - brand_id
        - brand_name
        - storefront_enabled
        - total_count
        - fetched_count
        - skip
        - limit
        - storefront_links
      title: StorefrontLinksResponse
      description: Storefront destinations for a selected brand.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StorefrontLinkOption:
      properties:
        store_page_id:
          type: string
          title: Store Page Id
          description: >-
            Amazon's brand-scoped store-page identifier. Pass this as
            `store_page_id` together with the row's `brand_id` to `POST
            /generate_attribution_link`.
        brand_id:
          type: string
          title: Brand Id
        brand_name:
          type: string
          title: Brand Name
        store_name:
          type: string
          title: Store Name
        page_name:
          type: string
          title: Page Name
        page_url:
          type: string
          title: Page Url
          description: The Amazon page before an attribution tag is added.
        marketplace:
          type: string
          title: Marketplace
          description: Amazon marketplace this storefront page belongs to.
        is_homepage:
          type: boolean
          title: Is Homepage
        total_asins:
          type: integer
          title: Total Asins
        live_asins:
          type: integer
          title: Live Asins
          description: Products on this page that are currently promotable.
      type: object
      required:
        - store_page_id
        - brand_id
        - brand_name
        - store_name
        - page_name
        - page_url
        - marketplace
        - is_homepage
        - total_asins
        - live_asins
      title: StorefrontLinkOption
      description: One brand storefront destination available for link generation.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: token

````