Get a Bundle's Component Products

GET 
/catalogs/:catalog_id/releases/:release_id/products/:product_id/relationships/component_products

With Product Experience Manager, you can create and manage bundles. A bundle is a purchasable product, comprising of one or more products that you want to sell together.

You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity.

This endpoint returns a list of component product IDs for the specified bundle.

Including Resources

Using the include parameter, you can retrieve top-level resources, such as, files or main image, bundle component products and product attributes, such as SKU or slug.

Parameter	Required	Description
component_products	Optional	The component product data and key attribute data, such as SKU or slug, to return for component products in a product bundle.
main_image	Optional	The main images associated with a product.
files	Optional	Any files associated with a product.

See Including Resources.

Request

Path Parameters

catalog_id stringrequired

The catalog ID.

release_id stringrequired

The unique identifier of a published release of the catalog or latestPublished for the most recently published version.

product_id stringrequired

The product ID.

Query Parameters

page[limit] int64

Possible values: >= 1

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

Responses

200

The list of component product IDs of a specific bundle product from a catalog.

application/json

Schema

Schema

meta object

Contains the results for the entire collection.

results object

Total number of results for the entire collection.

total int64

Total number of results for the entire collection.

page object

limit int64

The maximum number of records for all pages.

offset int64

The current offset by number of pages.

current int64

The current number of pages.

total int64

The total number of records for the entire collection.

data object[]
A list of product identifiers.
Array [
id uuid
A unique identifier for a product.
type string
Possible values: [product]
This represents the type of object being returned. Always product.
]
links object

Links allow you to move between requests.

self urinullable

Single entities use a self parameter with a link the specific resource.

first urinullable

Always the first page.

last urinullable

This is null if there is only one page.

prev urinullable

This is null if there is only one page.

next urinullable

This is null if there is only one page.

Example (from schema)

{
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 0,
      "offset": 0,
      "current": 0,
      "total": 0
    }
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "product"
    }
  ],
  "links": {
    "self": "string",
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}

default

The unexpected error.

application/json

Schema

Schema

errors object[]
Array [
detail string
status string
title string
]

Example (from schema)

{
  "errors": [
    {
      "detail": "not processable",
      "status": "422",
      "title": "There was a problem processing your request."
    }
  ]
}

Loading...