Skip to main content
The MoEngage Catalog API allows you to manage product and item catalogs. Use these endpoints to create new catalogs, define custom schemas, and perform bulk operations for ingesting, updating, or deleting items.

​
Endpoints

The Catalog API is a collection of the following endpoints:

​
FAQs

​
Catalog Management

The API will return a 409 Conflict error with the error code duplicate-catalog-name. Catalog names must be unique within your workspace.
Yes, you can use the Add Catalog Attributes (PATCH) endpoint. Note that if you send attributes that already exist in the schema, they will be ignored and listed in the duplicate-item-attributes array in the response.
You can define up to 50 attributes per catalog, including the 4 mandatory attributes.
API catalogs automate real-time updates such as price and quantity. They offer improved efficiency and scalability by updating only specific products, unlike file-based catalogs, which require the replacement of the whole file at each processing schedule. These APIs can be accessed and used to update from any location.
Each error code is a uniquely defined shorthand representation for the type of error, providing a quick reference that can be used to diagnose, troubleshoot, and address the problem based on a predefined set of error conditions.
No, the datatype cannot be changed once an attribute has been defined in the catalog. You can add a new attribute to the catalog with a different datatype as needed.
A maximum of 50 attributes can be added to the catalog.
Before updating existing items with new attributes, you must first add the new attribute to the catalog schema using the ‘Add catalog attribute’ API. Only then will your update requests for including new attributes be successful.
The request will be processed successfully marking such items as invalid. The response will include the count of these invalid item IDs.

​
Item Ingestion and Updates

The API returns a 200 OK with a detailed breakdown. The response body will include a valid count and an invalid count with a details array specifying which document_ids failed and why (e.g., data type mismatch or missing attributes).
No. The id is the primary key. To change an ID, you must delete the existing item and ingest it as a new item.
Yes, the bulk-delete endpoint supports a maximum of 50 item IDs per request.
All MoEngage catalog APIs operate synchronously. This means that every catalog API request is processed in real time, and you can see the changes instantly.

​
Get Item Details

Each error code is a uniquely defined shorthand representation for the type of error, providing a quick reference that can be used to diagnose, troubleshoot, and address the problem based on a predefined set of error conditions.
No, the data type cannot be changed once an attribute has been defined in the catalog. You can add a new attribute to the catalog using the Add new catalog attribute API with a different data type as needed.

​
Postman Collections

Test these endpoints immediately using our Postman collection. View Postman Collection