> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/pt/developers/api/reference/bundles/get-bundle.md).

# Get a bundle

> Returns a single active bundle with its component items.

Components may reference deleted items, which are marked with `deleted: true`.

`GET https://rest.boxhero-app.com/v1/bundles/{bundle_id}`

## Autorização

- `Authorization` (string, obrigatório): Cabeçalho de autenticação Bearer no formato `Bearer <token>`, em que `<token>` é o seu [token de API](https://www.boxhero.io/docs/pt/developers/api/authentication).

## Parâmetros de caminho

- `bundle_id` (integer, minimum 0, maximum 2147483647, obrigatório)

## Respostas

**200** The requested bundle.

- `item` (Bundle, obrigatório): A bundle with its component items. Bundles have no stock of their own; inventory is tracked at the component-item level.

  - `id` (integer, minimum 0, maximum 2147483647, obrigatório): Bundle id.
  - `name` (string, obrigatório): Bundle display name.
  - `sku` (string, obrigatório): Stock Keeping Unit. Unique within the team.
  - `barcode` (string, obrigatório): Primary barcode for the bundle. Empty string when not assigned.
  - `cost` (string, obrigatório): Cost per bundle, as a decimal string. Independent from component item costs.
  - `price` (string, obrigatório): Selling price per bundle, as a decimal string. Independent from component item prices.
  - `photo_url` (string, nullable, obrigatório): URL of the bundle photo. `null` when no photo is set.
  - `memo` (string, obrigatório): Free-text memo. Empty string when not set.
  - `components` (array of BundleComponent, obrigatório): Component list. Bundles cannot contain other bundles.

    - `item` (ExtendedItemEntity, obrigatório): Reference to an item or bundle embedded in order, return, transaction, and bundle component responses.

      - `id` (integer, minimum 0, maximum 2147483647, obrigatório): Item or bundle id.
      - `name` (string, obrigatório): Display name.
      - `sku` (string, obrigatório): SKU. Empty string when unset.
      - `barcode` (string, obrigatório): Barcode. Empty string when unset.
      - `deleted` (boolean, obrigatório): Whether the underlying item or bundle is deleted.
    - `quantity` (number, obrigatório): Quantity of this item required per bundle.

**401** Missing or invalid API token.

- `id` (string, obrigatório): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, obrigatório): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Valores possíveis: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, obrigatório): Human-readable summary of the error, in English.
- `correlationID` (string, obrigatório): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, obrigatório): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, obrigatório)
  - `message` (string, obrigatório)

**404** No bundle with the given id was found in this team.

- `id` (string, obrigatório): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, obrigatório): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Valores possíveis: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, obrigatório): Human-readable summary of the error, in English.
- `correlationID` (string, obrigatório): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, obrigatório): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, obrigatório)
  - `message` (string, obrigatório)

**429** Rate limit exceeded. Check `RateLimit`, `Retry-After`, and `X-RateLimit-*` response headers before retrying.

- `id` (string, obrigatório): Unique exception id (`ex_` followed by 32 lowercase hex chars, no dashes — e.g. `ex_8f5c0c8e0e0a4a3c9b3f4f2c4f6c8d2a`). Quote this in support tickets so we can find the request in our logs.
- `type` (string, obrigatório): Stable, machine-readable error code (RFC 7807-style URI fragment). Branch your error handling on this, not on `title`.

  Valores possíveis: `/errors/not-found`, `/errors/invalid-request`, `/errors/invalid-team-mode`, `/errors/tokens/invalid`, `/errors/tokens/required`, `/errors/too-many-requests`, `/errors/core/usage-limit-exceeded`, `/errors/core/forbidden`, `/errors/core/unhandled`, `/errors/unhandled`
- `title` (string, obrigatório): Human-readable summary of the error, in English.
- `correlationID` (string, obrigatório): Request correlation id (`rq_` followed by 32 lowercase hex chars, no dashes — e.g. `rq_01abf3...`). Identical to the `X-Correlation-Id` response header. Pass an `X-Correlation-Id` request header to thread your trace through to ours.
- `instance` (string, obrigatório): Pointer to the specific failing resource (e.g. `/items/12345`). Path-only, no `/v1` version prefix.
- `code` (string): Sub-reason code surfaced from upstream BoxHero core (on core-mapped 4xx) or from the gateway itself (e.g. `not-available-for-api-token` on 403). Use this for fine-grained branching after dispatching on `type`.
- `errors` (array of object): Field-level error details. Present on `/errors/invalid-request` (400) responses. Each entry locates a single failure via JSONPath-like `path` segments and a human-readable `message`.

  - `path` (array of string | number, obrigatório)
  - `message` (string, obrigatório)

Requisição

**cURL**

```bash
curl --request GET \
  --url 'https://rest.boxhero-app.com/v1/bundles/{bundle_id}' \
  --header "Authorization: Bearer $BOXHERO_API_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch("https://rest.boxhero-app.com/v1/bundles/{bundle_id}", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BOXHERO_API_TOKEN}`,
  },
});
const data = await response.json();
```

**Python**

```python
import os
import requests

response = requests.get(
    "https://rest.boxhero-app.com/v1/bundles/{bundle_id}",
    headers={
        "Authorization": "Bearer " + os.environ["BOXHERO_API_TOKEN"],
    },
)
data = response.json()
```

**HTTP**

```http
GET /v1/bundles/{bundle_id} HTTP/1.1
Host: rest.boxhero-app.com
Authorization: Bearer <token>
```

Resposta

**200**

```json
{
  "item": {
    "id": 4042,
    "name": "Starter Kit",
    "sku": "BUNDLE-STARTER",
    "barcode": "8801234567890",
    "cost": "12.50",
    "price": "29.99",
    "photo_url": null,
    "memo": "",
    "count_of_components": 2,
    "components": [
      {
        "item": {
          "id": 14290445,
          "name": "Finish Setting Powder",
          "sku": "SKU-12345678",
          "barcode": "2097678335587",
          "deleted": false
        },
        "quantity": 1
      },
      {
        "item": {
          "id": 14290446,
          "name": "Hydrating Face Toner",
          "sku": "SKU-12345679",
          "barcode": "2097678335588",
          "deleted": false
        },
        "quantity": 2
      }
    ]
  }
}
```

**401**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/tokens/required",
  "title": "Missing API token. Provide a Bearer token in the Authorization header.",
  "example": "Bearer wqnot0dlysdg5vymubzi4kiv"
}
```

**404**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/not-found",
  "title": "No bundle with the given id was found in this team.",
  "instance": "/bundles/12345"
}
```

**429**

```json
{
  "id": "ex_8f5c0c8e-0e0a-4a3c-9b3f-4f2c4f6c8d2a",
  "correlationID": "01J9X8K9XZ4ZWV9T8MQ8B7H7C2",
  "type": "/errors/too-many-requests",
  "title": "Too many requests.",
  "instance": "/bundles/12345",
  "retryAfter": 60
}
```