# The bundle object

A bundle object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/bundles` endpoint.

## Fields

| Field                                         | Type      | Description                                                                                                                                                                                         |
| --------------------------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                      | `string`  | `bundles`                                                                                                                                                                                           |
| **id**                                        | `string`  | The bundle unique identifier                                                                                                                                                                        |
| links.**self**                                | `string`  | The bundle endpoint URL                                                                                                                                                                             |
| attributes.**code**                           | `string`  | The bundle code, that uniquely identifies the bundle within the market.                                                                                                                             |
| attributes.**name**                           | `string`  | The internal name of the bundle.                                                                                                                                                                    |
| attributes.**currency\_code**                 | `string`  | The international 3-letter currency code as defined by the ISO 4217 standard.                                                                                                                       |
| attributes.**description**                    | `string`  | An internal description of the bundle.                                                                                                                                                              |
| attributes.**image\_url**                     | `string`  | The URL of an image that represents the bundle.                                                                                                                                                     |
| attributes.**do\_not\_ship**                  | `boolean` | Indicates if the bundle doesn't generate shipments (all sku\_list's SKUs must be do\_not\_ship).                                                                                                    |
| attributes.**do\_not\_track**                 | `boolean` | Indicates if the bundle doesn't track the stock inventory (all sku\_list's SKUs must be do\_not\_track).                                                                                            |
| attributes.**price\_amount\_cents**           | `integer` | The bundle price amount for the associated market, in cents.                                                                                                                                        |
| attributes.**price\_amount\_float**           | `float`   | The bundle price amount for the associated market, float.                                                                                                                                           |
| attributes.**formatted\_price\_amount**       | `string`  | The bundle price amount for the associated market, formatted.                                                                                                                                       |
| attributes.**compare\_at\_amount\_cents**     | `integer` | The compared price amount, in cents. Useful to display a percentage discount.                                                                                                                       |
| attributes.**compare\_at\_amount\_float**     | `float`   | The compared price amount, float.                                                                                                                                                                   |
| attributes.**formatted\_compare\_at\_amount** | `string`  | The compared price amount, formatted.                                                                                                                                                               |
| attributes.**\_compute\_price\_amount**       | `boolean` | Send this attribute if you want to compute the price\_amount\_cents as the sum of the prices of the bundle SKUs for the market.                                                                     |
| attributes.**\_compute\_compare\_at\_amount** | `boolean` | Send this attribute if you want to compute the compare\_at\_amount\_cents as the sum of the prices of the bundle SKUs for the market.                                                               |
| attributes.**skus\_count**                    | `integer` | The total number of SKUs in the bundle.                                                                                                                                                             |
| attributes.**\_add\_tags**                    | `string`  | Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.                                                              |
| attributes.**\_remove\_tags**                 | `string`  | Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.                                                            |
| attributes.**created\_at**                    | `string`  | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**                    | `string`  | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**                      | `string`  | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin**              | `string`  | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**                       | `object`  | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**market**                      | `object`  | The associated market.                                                                                                                                                                              |
| relationships.**sku\_list**                   | `object`  | The associated SKU list.                                                                                                                                                                            |
| relationships.**skus**                        | `array`   | The associated SKUs.                                                                                                                                                                                |
| relationships.**attachments**                 | `array`   | The associated attachments.                                                                                                                                                                         |
| relationships.**events**                      | `array`   | The associated events.                                                                                                                                                                              |
| relationships.**tags**                        | `array`   | The associated tags. Cannot be passed by sales channels.                                                                                                                                            |
| relationships.**event\_stores**               | `array`   | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                                 | `string`  | The resource environment (can be one of `test` or `live`)                                                                                                                                           |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.commercelayer.io/core-api-reference/bundles/object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.