Intake APIs: Products and Product 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 Products and Product Rule Sets

Use the Create Product request to add products and optional product rules set(s) to a catalog.

Content of Create Product Request	Method	Path (used for authorization)
In the body of the request: Product identification and description elements Optional: data for one or more product rules sets Optional: Work unit ID `autoRelease` field with the True or False indicator Consult API contract for additional elements	POST	`/transition/intake/products/v1/airlines/{cxr}` Note: Replace {cxr} with the catalog owner code

📝 Products can also be created at the time a bundle is created.

Retrieve Products and Product Rule Sets

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

Content of Retrieve Product Request	Method	Path (used for authorization)
Retrieve by 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 only (not rule data) should be returned Product key match fields See * below	POST	`/transition/intake/products/v1/airlines/{cxr}/criteria` Note: Replace {cxr} with the catalog owner code. This criteria may return multiple products.
Retrieve by catalog type and catalog owner In the request URL: Catalog type Catalog owner code See * below	GET	`/transition/intake/products/v1/airlines/{type}{cxr}` Note: Replace {type} with airline and {cxr} with the catalog owner code. This criteria may return multiple products.
Retrieve by catalog owner and product record identifier In the request URL: Catalog owner code Product record identifier See * below	GET	`/transition/intake/products/v1/airlines/{cxr}/{recId}` Notes: Replace {cxr} with the catalog owner code Replace {recId} with the product record identifier

*By default, the response returns distributed products only.

To retrieve incomplete products as well, add includeIncomplete=true in the request URL
To retrieve discontinued products that have not been purged yet, add Discontinue=true in the request URL
Products 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

Update Products and Product Rule Sets

Use the Update Product request to update product(s) and their product rules sets.

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

Content of Update Product Request	Method	Path (used for authorization)
Update by product 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 product Optional: Work unit ID `autoRelease` field with the True or False indicator Data to be updated	PATCH	`/transition/intake/products/v1/airlines/{cxr}/updates` Note: Replace {cxr} with the catalog owner code
Update by catalog owner and product record identifier In the body of the request: Catalog owner code (required in both the body of the request and the URL) Product record identifier (required in both the body of the request and the URL) Optional: Work unit ID `autoRelease` field with the True or False indicator Data to be updated	PATCH	`/transition/intake/products/v1/airlines/{cxr}/{recId}` Notes: Replace {cxr} with the catalog owner code Replace {recId} with the product record identifier

Types of Product Updates

Type of Product Update	Action
Update a product 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. Requests have to include only the element being updated.
Add a product rules set	In the request, list the: `Add` action `productRulesSetIdOwnerDefined` of the product rules set to be added New product rules data To add multiple rules, list additional `productRulesSetIdOwnerDefined` fields and the applicable data.
Replace a product rules set	In the request, list the: Replace action `productRulesSetIdOwnerDefined` of the product rules set to be replaced New data that is required for the `productRulesSetIdOwnerDefined` Notes: Be sure to include all of the data for the product rules set, not just data that needs to be replaced. The new data replaces all of the existing data in the product rules set. Any other embedded product rules sets remain the same. To replace multiple rules, list additional `productRulesSetIdOwnerDefined` fields and new data.
Remove a product rules set	In the request, list the: Remove action `productRulesSetIdOwnerDefined` Any other embedded product rules sets remain in effect.

Discontinue Products

Use the Discontinue Product request to discontinue product(s) and their product rules sets from a catalog.

One product at a time can be discontinued.
A product that is associated with a bundle cannot be discontinued. The product must first be disassociated from the bundle.

Content of Discontinue Product Request	Method	Path (used for authorization)
Discontinue by product 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 product Optional: Work unit ID `autoRelease` field with the True or False indicator	POST	`/transition/intake/products/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 Product record identifier Note: When a Discontinue request is using the DELETE method, its associated work unit is always auto-released.	DELETE	`/transition/intake/products/v1/airlines/{cxr}/{recId}` Notes: Replace `{cxr}` with the catalog owner code Replace `{recId}` with the product ID

Product Key Match Fields

Following is a list of product key match fields.

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

Product Key Match Field	Uniquely Identifies a Product	Description
`recId` `productRecId`*	Yes	Alphanumeric value that uniquely identifies a product. Assigned by Product Catalog at the time a product is created.
`serviceIdRFISC`*	Yes, when used alone No, when used with any other key match field	Standard industry code that describes the type of service. Use for products that fit a recognized industry service type. Applies to all products. Must exist in ATPCO S5/800 Subcodes amenity types. Can be reused only when properly differentiated.
`serviceIdOwnerDefined`*	Yes	Airline’s unique ID for a products. Use to uniquely identify or customize a product. Applies to all products. Must be unique across all products.
`serviceIdAmenityType`	No	Standard industry code that defines the Amenity category for a product. Applies to all products. Must align with `serviceIdRFISC` and product type. Drives validation and downstream processing.
`serviceIdSSRCode`	Yes, when used with `serviceIdRFISC` No, when used alone	Industry standard Special Service Request code for identifying services. Use when a product or service is requested through SSR messaging, Applies to SSR-driven services. Must align with IATA SSR standards. Supports downstream messaging and fulfillment.
`serviceIdDCSCode`	Yes, when used with `serviceIdRFISC` or `serviceIdOwnerDefined` Cannot be used alone as a key match field	Applies to baggage products only. Airline’s unique DCS code for baggage products. Use to differentiate baggage products, such as weight, pieces, priority baggage, and so on.
`serviceIdPADISCode`	Yes, when used with `serviceIdRFISC` No, when used alone	Applies to seat products only. Standard code used to describe seat characteristics, such as aisle, window, extra legroom, and so on. Use with RFISC to differentiate multiple seat products
`type`*	No	Type of product, as listed in the ProductType Appendix of the Product Catalog data dictionary. Examples: entertainment, lounge, priority boarding, loyalty, and eSim.

*Use these fields when retrieving a bundle by product key match fields.