CTRLK

Shared components

Catalogs over API

|

View as Markdown

The Catalogs API is an Infobip feature that enables you to create catalogs for your products and services. You can then use these catalogs in interactions with end users.

Follow the Authentication guide to secure your connection with Infobip.

Catalogs

For catalogs, you can:

1. Create catalog: You can create a new catalog in one of the following ways:

  • To create a catalog with a predefined set of fields, choose Products, Articles, or Stores catalog type. The catalog fields get created automatically. You can specify additional custom fields.
  • To create a catalog with only custom fields, choose the Blank catalog type.

2. Get catalog: You can get catalogs in one of the following ways.

  • ID-based: Use the catalog identifier to get a specific catalog.
  • Query-based: Get a set of catalogs that meet the specified criteria.

3. Update catalog: Update the name and description of a catalog.

4. Delete catalog

Catalog fields

For catalog fields, you can:

1. Create fields

2. Get catalog field: You can get catalog fields in one of the following ways.

  • ID-based: Use the field identifier to get a specific field in a catalog.
  • Query-based: Get a set of fields, which meet the specified criteria, in a catalog. Example: All fields of a particular size in the catalog.

3. Update field

4. Delete field

Catalog items

For catalog items or records, you can:

1. Add items: Create one or more new items in a catalog.

2. Get catalog item: You can get catalog items in one of the following ways.

  • ID-based: Use the item identifier to get a specific item in a catalog.
  • Query-based: Get a set of items, which meet the specified criteria, in a catalog. Example: All items of a particular size in the catalog.

3. Update catalog item: You can update catalog items in one of the following ways.

  • ID-based: Use the item identifier to update a specific item in a catalog.
  • Query-based: Update a set of items in a catalog, based on the specified criteria. Example: Bulk update the discount from 30% to None after the sale is over.

4. Delete catalog item: You can delete catalog items in one of the following ways.

  • ID-based : Use the item identifier to delete a specific item in a catalog.
  • Query-based : Delete a set of items, which meet the specified criteria, in a catalog. Example: All items of a particular size in the catalog.

5. Get item count : Get the total number of items in a catalog.