Intake APIs: Bundles and Bundle Rules Sets

Intake APIs are available for the following actions in Product Catalog:

Creating, retrieving, and updating
- Products and product rules sets
- Bundles and bundle rules sets
- Work units
Discontinuing
- Products and product rules sets
- Bundles and bundle rules sets
- Releasing work units

To try out these APIs, visit the bundles endpoints page, the products endpoints page, and the work unit endpoints page.

Create Bundles and Bundle Rules Sets

Use the Create Bundle request to add bundles, optional bundles rules set(s) to a catalog.

When you create a bundle, you can also do the following in the same request:

Associate existing products to the bundle
Create products and their product rules sets and associate them to the bundle

Content of Create Bundle Request	Method	Path (used for authorization)
In the body of the request: Bundle identification and description elements Optional: data for one or more bundle rules sets Optional: Work unit ID `autoRelease` field with the True or False indicator At least two products: The product record identifier of one or more distributed products to be referenced in the bundle and/or Data for one or more new products to be created After creating a product, the system places its record identifier in the bundle as a reference. The referenced products will be associated with the bundle, but they will also exist as standalone entities. In addition, these products can be associated with other bundles.	POST	`/transition/intake/products/v1/airlines/{cxr}` Note: Replace {cxr} with the catalog owner code.

Retrieve Bundles and Bundle Rules Sets

Use the Retrieve Bundle request to get bundle(s) and their bundle rules sets from a catalog.

Content of Retrieve Bundle Request	Method	Path (used for authorization)
Retrieve by bundle or product key match fields In the body of the request: Catalog owner code (required in both the body of the request and the URL) Optional: specify that rule IDs (not rule data) should be returned Bundle key match fields or Key match fields of the products in a bundle Note: The response returns the record identifiers of the products associated with the bundle(s). No product data is returned. See * below	POST	`/transition/intake/bundles/v1/airlines/{cxr}/criteria` Note: Replace `{cxr}` with the catalog owner code. This criteria may return multiple bundles.
Retrieve by catalog type and catalog owner In the body of the request: Catalog type (airline) Catalog owner code Note: The response returns the record identifiers of the products associated with the bundle(s). No product data is returned. See * below	POST	`/transition/intake/bundles/v1/airlines/{cxr}/criteria` Note: Replace `{cxr}` with the catalog owner code. This criteria may return multiple bundles.
Retrieve by catalog owner and bundle record identifier In the request URL: Catalog owner code Bundle record identifier Note: The response returns the record identifiers and the data of the products associated with the bundle(s). See * below	GET	`/transition/intake/bundles/v1/airlines/{cxr}/{recId}` Notes: Replace `{cxr}` with the catalog owner code Replace `{recId}` with the bundle record identifier

*By default, the response returns distributed products only.

To retrieve incomplete bundles as well, add includeIncomplete=true in the request URL.
To retrieve discontinued bundles that have not been purged yet, add Discontinue=true in the request URL.
Bundles are purged seven days after the Discontinue date.
To retrieve Intake/API data only or auto-populated data only, add createdVia
- createdVia = api
- createdVia = autopopulate

📝 If a retrieved bundle was created via the Intake API, it will have at least two products.
If a retrieved bundle was created with the auto-populate process from the Branded Fares application, it may have fewer than two products. Such bundles contain a field named “nonBundleBrand = X.”

Update Bundles and Bundle Rules Sets

Use the Update Bundle request to update bundles(s) and their bundle rules sets.

Bundles created with the Intake API can be updated.
Bundles created with the auto-populate process cannot be updated.

Content of Update Bundle Request	Method	Path (used for authorization)
Update by bundle key match fields In the body of the request: Catalog type (airline) Catalog owner code (required in both the body of the request and the URL) Key match fields that uniquely identify the bundle Optional: Work unit ID `autoRelease` field with the True or False indicator Data to be updated	PATCH	`/transition/intake/bundles/v1/airlines/{cxr}/updates` Note: Replace `{cxr}` with the catalog owner code.
Update by catalog owner and bundle record identifier In the body of the request: Catalog owner code (required in both the body of the request and the URL) Bundle record identifier (also required in the request URL) Optional: Work unit ID `autoRelease` field with the True or False indicator Data to be updated	PATCH	`/transition/intake/bundles/v1/airlines/{cxr}/{recId}` Notes: Replace `{cxr}` with the catalog owner code. Replace `{recId}` with the product record identifier.

Types of Bundle Updates

Type of Bundle Update	Action
Update a bundle element	To add an element, submit the element and value. To change the value of an existing element, submit the element with a new value. To remove an existing element, submit the element with a `“null”` value, a blank space, or an empty string. The request has to include only the element being updated.
Add a bundle rules set	In the request, list the: `Add` action `bundleRulesSetIdOwnerDefined` of the bundle rules set to be added New bundle rules data To add multiple rules, list additional `bundleRulesSetIdOwnerDefined` fields and the applicable data.
Replace a bundle rules set	In the request, list the: `Replace` action `bundleRulesSetIdOwnerDefined` of the bundle rules set to be replaced New data that is required for the `bundleRulesSetIdOwnerDefined` Notes: Be sure to include all of the data for the bundle rules set, not just data that needs to be replaced. The new data replaces all of the existing data in the bundle rules set. Any other embedded bundle rules sets remain the same. To replace multiple rules, list additional `bundleRulesSetIdOwnerDefined` fields and new data.
Remove a bundle rules set	In the request, list the: `Remove` action `bundleRulesSetIdOwnerDefined` to be removed Any other embedded bundle rules sets remain in effect.
Associate an distributed product to a bundle	In the request list the: Record identifier of each distributed product to be associated to the bundle Any product rules sets in the product(s) will also be associated to the bundle.
Create a product and associate it to a bundle	In the request list the: `Add` action Data for the product(s), and optionally, their product rules sets Note: Products cannot be updated from within a bundle.
Disassociate a product from a bundle	In the request list the: `Disassociate` action Key match fields of the products to be disassociated from the bundle

Discontinue Bundles

Use the Discontinue Bundle request to discontinue bundles(s) and their bundle rules sets from a catalog.

One bundle at a time can be discontinued.
Before a bundle can be discontinued, its associated products must be disassociated from it.

Bundle Discontinue Option	Method	Path (used for authorization)
Discontinue by bundle key match fields In the body of the request: Catalog type (airline) Catalog owner code (required in both the body of the request and the URL) Key match fields that uniquely identify the bundle Optional: Work unit ID `autoRelease` field with the True or False indicator	POST	`/transition/intake/bundles/v1/airlines/{cxr}/discontinuations` Note: Replace `{cxr}` with the catalog owner code.
Discontinue by catalog owner and product record identifier In the request URL: Catalog owner code Bundle record identifier Note: When a Discontinue request is using the DELETE method, its associated work unit is always auto-released.	DELETE	`/transition/intake/bundles/v1/airlines/{cxr}/{recId}` Notes: Replace `{cxr}` with the catalog owner code. Replace `{recId}` with the product ID.

Bundle Key Match Fields

Following is a list of bundle key match fields. Using key match fields is one option for retrieving products.

📝 Multiple bundle key match fields may be required to uniquely identify a bundle.
Limitations apply to the number of bundles that can be retrieved.

Bundle Key Match Field	Uniquely Identifies a Bundle	Description
`recId`	Yes	Alphanumeric value that uniquely identifies a bundle Assigned at the time a bundle is created
`bundleCode`	No*	Code assigned to a brand in the Branded Fares application Defined by the Catalog owner
`bundleName`	No*	Name assigned to a brand in the Branded Fares application Not used for display purposes Defined by the Catalog owner
`bundleCodeOwnerDefined`	Yes	Code identifying a bundle Defined by the Catalog owner

*When an API request contains this field, other key match fields must be provided to ensure that the bundle can be uniquely identified