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

# Get the all-access pass

> Return the store's all-access pass, or null when none is on sale.

## Request

```http theme={null}
GET /digital/pass
x-shop-id: {{shopId}}
```

## Headers

| Header | Type | Description |
| - | - | - |
| `x-shop-id` | string | Identify the shop context. |

<Note>
  This endpoint is public, like `/products`: no sign-in is needed to show the pass price on a catalog page. It is only meaningful on digital stores. The pass covers every listed product the seller marked as included, for 30 days from each purchase.
</Note>

## Successful response

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Pass retrieved",
    "data": {
        "pass": {
            "name": "All-access pass",
            "description": "Every book in the store for 30 days.",
            "price": 7500,
            "periodDays": 30,
            "productCount": 12
        }
    }
}
```

When the store has no pass on sale (never configured, or switched off) `pass` is `null`:

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Pass retrieved",
    "data": { "pass": null }
}
```

To buy the pass, add it to the cart with `{ "allAccess": true }` using [Add item to cart](/api-reference/endpoint/cart/add-item).


## OpenAPI

````yaml api-reference/openapi.json GET /digital/pass
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /digital/pass:
    get:
      summary: Get the all-access pass
      description: >-
        Returns the store's all-access pass, or `{ "pass": null }` when the
        store has none on sale. Public, like `/products`. Digital stores only in
        practice: other store types simply have no pass.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
      responses:
        '200':
          description: The pass, or null.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Pass retrieved
                  data:
                    type: object
                    properties:
                      pass:
                        $ref: '#/components/schemas/DigitalPassSummary'
                    example:
                      pass:
                        name: All-access pass
                        description: Every book in the store for 30 days.
                        price: 7500
                        periodDays: 30
                        productCount: 12
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  schemas:
    DigitalPassSummary:
      type: object
      nullable: true
      description: The store's all-access pass, or `null` when none is on sale.
      properties:
        name:
          type: string
        description:
          type: string
        price:
          type: number
        periodDays:
          type: integer
          description: Length of one purchase in days (30).
        productCount:
          type: integer
          description: Listed products the pass covers.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.