The bundle object
A comprehensive list of the bundle resource's attributes and relationships
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 |
|
|
id |
| The bundle unique identifier |
links.self |
| The bundle endpoint URL |
attributes._compute_compare_at_amount |
| 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._compute_price_amount |
| 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.code |
| The bundle code, that uniquely identifies the bundle within the market. |
attributes.compare_at_amount_cents |
| The compared price amount, in cents. Useful to display a percentage discount. |
attributes.compare_at_amount_float |
| The compared price amount, float. |
attributes.created_at |
| Time at which the resource was created. |
attributes.currency_code |
| The international 3-letter currency code as defined by the ISO 4217 standard. |
attributes.description |
| An internal description of the bundle. |
attributes.do_not_ship |
| Indicates if the bundle doesn't generate shipments (all sku_list's SKUs must be do_not_ship). |
attributes.do_not_track |
| Indicates if the bundle doesn't track the stock inventory (all sku_list's SKUs must be do_not_track). |
attributes.formatted_compare_at_amount |
| The compared price amount, formatted. |
attributes.formatted_price_amount |
| The bundle price amount for the associated market, formatted. |
attributes.image_url |
| The URL of an image that represents the bundle. |
attributes.metadata |
| 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. |
attributes.name |
| The internal name of the bundle. |
attributes.price_amount_cents |
| The bundle price amount for the associated market, in cents. |
attributes.price_amount_float |
| The bundle price amount for the associated market, float. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code. |
attributes.skus_count |
| The total number of SKUs in the bundle. |
attributes.updated_at |
| Time at which the resource was last updated. |
relationships.attachments |
| The associated attachments. |
relationships.events |
| The associated events. |
relationships.market |
| The associated market. |
relationships.sku_list |
| The associated SKU list. |
relationships.skus |
| The associated SKUs. |
relationships.tags |
| The associated tags. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated