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

# Get Store by ID

> Learn how to query a specific store in your account using the endpoint GET /stores/{storeId}.

## 🏪 Get Store by ID

This endpoint allows you to **query a specific store** in your account by its ID.

It is ideal for:

* Loading full details of a store
* Fetching related data (categories, products, coupons and payments)
* Validating that a store exists before other operations

## 🔐 Authentication

This route **requires authentication** via **API Key**, sent in the request header:

```http theme={null}
Authorization: YOUR_API_KEY_HERE
```

## 📥 Route Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `storeId` | `string (UUID)` | Yes | ID of the store to be queried. |

## 📋 Example Request

```bash theme={null}
curl --location "https://api.cabrapi.com.br/v1/stores/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
--header "Authorization: YOUR_API_KEY_HERE"
```

## 📊 Example Response (200)

```json theme={null}
{
	"code": "SUCCESS",
	"store": {
		"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"name": "Minha Loja",
		"position": 1,
		"description": "Loja de exemplo",
		"image": "https://example.com/store.png",
		"template": "PERSONALIZADO",
		"domain": "minhaloja-web.cabrapi.com.br",
		"metadata": null,
		"createdAt": "2026-02-28T12:00:00.000Z",
		"updatedAt": "2026-02-28T12:00:00.000Z",
		"categories": [],
		"products": [],
		"coupons": [],
		"payment": []
	}
}
```

## ❌ Possible Errors

| Status | Code | When it happens |
| - | - | - |
| `400` | `INVALID_DATA` | When `storeId` is not a valid UUID. |
| `401` | `API_KEY_NOT_PROVIDED` | `Authorization` header not sent. |
| `401` | `INVALID_API_KEY` | Invalid or not found API Key. |
| `401` | `UNAUTHENTICATED` | Session/user not authenticated in the request context. |
| `403` | `USER_DISABLED` | User account disabled or deleted. |
| `403` | `NO_ACTIVE_SUBSCRIPTION` | Account has no active plan. |
| `404` | `STORE_NOT_FOUND` | When the store does not exist, was removed, or does not belong to your account. |
| `429` | `RATE_LIMIT_EXCEEDED` | Plan per-minute request limit exceeded. |
| `500` | `INTERNAL_SERVER_ERROR` | Internal failure while processing the request. |
| `503` | `SERVICE_UNAVAILABLE` | Service temporarily unavailable. |

## Observations

* `categories`, `products` and `coupons` are returned ordered by `position`.

## 🔗 Useful Links

* [Authentication Documentation](https://docs.cabrapi.com.br/pages/en/api-reference/authorization.md)
* [List Stores](https://docs.cabrapi.com.br/pages/en/api-reference/store/get.md)
* [Create Store](https://docs.cabrapi.com.br/pages/en/api-reference/store/post.md)
* [Update Store](https://docs.cabrapi.com.br/pages/en/api-reference/store/put.md)
* [Delete Store](https://docs.cabrapi.com.br/pages/en/api-reference/store/delete.md)

Update: 28/02/2026 as 00:00


## OpenAPI

````yaml GET /stores/{storeId}
openapi: 3.1.0
info:
  title: caBRAPI
  version: 1.0.0
servers:
  - url: https://api.cabrapi.com.br/v1
security: []
paths:
  /stores/{storeId}:
    parameters:
      - in: path
        name: storeId
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 50
    get:
      tags:
        - Stores
      summary: Get store by ID
      operationId: getStore
      parameters:
        - $ref: '#/components/parameters/StoreId'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    example: SUCCESS
                    type: string
                  store:
                    $ref: '#/components/schemas/StoreDetail'
                required:
                  - code
                  - store
                type: object
          description: Store with related entities.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: INVALID_DATA
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: API_KEY_NOT_PROVIDED, INVALID_API_KEY, UNAUTHENTICATED
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: USER_DISABLED, NO_ACTIVE_SUBSCRIPTION
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: STORE_NOT_FOUND
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Rate limit exceeded.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Service unavailable.
      security:
        - ApiKey: []
components:
  parameters:
    StoreId:
      in: path
      name: storeId
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 50
  schemas:
    StoreDetail:
      allOf:
        - $ref: '#/components/schemas/Store'
        - type: object
          properties:
            categories:
              type: array
              items:
                $ref: '#/components/schemas/Category'
            products:
              type: array
              items:
                $ref: '#/components/schemas/Product'
            coupons:
              type: array
              items:
                $ref: '#/components/schemas/Coupon'
            payment:
              type: array
              items:
                $ref: '#/components/schemas/Payment'
          required:
            - categories
            - products
            - coupons
            - payment
    Error:
      properties:
        code:
          example: STORE_NOT_FOUND
          type: string
      required:
        - code
      type: object
    Store:
      properties:
        createdAt:
          format: date-time
          type: string
        description:
          nullable: true
          type: string
        domain:
          nullable: true
          type: string
        id:
          format: uuid
          type: string
        image:
          nullable: true
          type: string
        metadata:
          nullable: true
          type: object
        name:
          type: string
        position:
          type: integer
        template:
          enum:
            - PERSONALIZADO
            - N/A
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - name
        - position
        - template
        - createdAt
        - updatedAt
      type: object
    Category:
      description: Store product category.
      properties:
        createdAt:
          format: date-time
          type: string
        description:
          nullable: true
          type: string
        id:
          format: uuid
          type: string
        image:
          nullable: true
          type: string
        metadata:
          nullable: true
          type: object
        name:
          type: string
        position:
          type: integer
        storeId:
          format: uuid
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - name
        - position
        - storeId
        - createdAt
        - updatedAt
      type: object
    Product:
      description: Store product.
      properties:
        categories:
          items:
            properties:
              id:
                format: uuid
                type: string
              name:
                type: string
            required:
              - id
              - name
            type: object
          type: array
        createdAt:
          format: date-time
          type: string
        delivery:
          enum:
            - DIGITAL
            - PHYSICAL
          type: string
        description:
          nullable: true
          type: string
        disabled:
          type: boolean
        id:
          format: uuid
          type: string
        image:
          nullable: true
          type: string
        metadata:
          nullable: true
          type: object
        name:
          type: string
        position:
          type: integer
        price:
          type: number
        sold:
          type: integer
        stock:
          type: integer
        storeId:
          format: uuid
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - id
        - name
        - position
        - price
        - delivery
        - stock
        - sold
        - storeId
        - disabled
        - createdAt
        - updatedAt
        - categories
      type: object
    Coupon:
      description: Store discount coupon.
      properties:
        categories:
          items:
            properties:
              id:
                format: uuid
                type: string
              name:
                type: string
            required:
              - id
              - name
            type: object
          type: array
        code:
          type: string
        createdAt:
          format: date-time
          type: string
        discount:
          type: integer
        expiredAt:
          format: date-time
          nullable: true
          type: string
        id:
          format: uuid
          type: string
        position:
          type: integer
        products:
          items:
            properties:
              id:
                format: uuid
                type: string
              name:
                type: string
            required:
              - id
              - name
            type: object
          type: array
        rules:
          items:
            properties:
              type:
                enum:
                  - SINGLE_USE_PER_CUSTOMER
                  - MIN_ORDER_AMOUNT
                  - AFFILIATE_ONLY
                  - MIN_ITEMS_QUANTITY
                  - PAYMENT_METHOD
                type: string
              value: {}
            required:
              - type
            type: object
          nullable: false
          type: array
        storeId:
          format: uuid
          type: string
        updatedAt:
          format: date-time
          type: string
        useLimit:
          type: integer
      required:
        - id
        - code
        - discount
        - position
        - useLimit
        - storeId
        - createdAt
        - updatedAt
        - products
        - categories
        - rules
        - expiredAt
      type: object
    Payment:
      description: Store payment/charge.
      properties:
        affiliateCode:
          nullable: true
          type: string
        affiliateCommission:
          nullable: true
          type: object
          properties:
            code:
              type: string
            name:
              type: string
            email:
              nullable: true
              type: string
            value:
              type: number
          required:
            - code
            - name
            - value
        coupon:
          type: boolean
        cpf:
          nullable: true
          type: string
        createdAt:
          format: date-time
          type: string
        email:
          format: email
          type: string
        gateway:
          type: string
        id:
          format: uuid
          type: string
        metadata:
          nullable: true
          type: object
        name:
          type: string
        price:
          type: number
        products:
          items:
            properties:
              description:
                nullable: true
                type: string
              id:
                format: uuid
                type: string
              image:
                nullable: true
                type: string
              name:
                type: string
              price:
                type: number
            required:
              - id
              - name
              - price
            type: object
          type: array
        shipment:
          enum:
            - PENDING
            - PREPARING
            - SHIPPED
            - DELIVERED
            - RETURNED
            - CANCELLED
          type: string
        status:
          enum:
            - PENDING
            - APPROVED
            - REJECTED
            - CANCELLED
            - REFUNDED
            - CHARGED_BACK
            - EXPIRED
          type: string
        storeId:
          format: uuid
          type: string
        updatedAt:
          format: date-time
          type: string
        uuid:
          format: uuid
          type: string
      required:
        - id
        - uuid
        - status
        - name
        - email
        - price
        - coupon
        - gateway
        - shipment
        - storeId
        - createdAt
        - updatedAt
        - products
      type: object
  securitySchemes:
    ApiKey:
      in: header
      name: Authorization
      type: apiKey
      x-default: YOUR_API_KEY_HERE

````

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