Get Items

This API retrieves item attribute details for catalog items using their unique item IDs. The attributes can include the title, price, category, link, image_link, and the respective creation date.

POST /catalog/{catalog_id}/items/search

Get Items

cURL

curl --request POST \
  --url https://api-{dc}.moengage.com/v1/catalog/{catalog_id}/items/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "items": [
    "P001",
    "P002",
    "P003",
    "P004"
  ]
}
'

200

{
  "items": [
    {
      "catalog_id": "{{catalog_id}}",
      "feed_id": "{{feed_id}}",
      "title": "string",
      "description": "string",
      "link": "https://link.in/",
      "image_link": "https://link.in/",
      "price_currency": "USD",
      "creation_date": "2024-05-10T07:03:00.18Z",
      "last_updated": "2024-05-10T07:03:00.18Z",
      "product_id": "string",
      "price": 29.99,
      "date": "2022-04-05T00:00:00.00Z",
      "sale_start_date": "2025-08-27T19:26:38.00Z",
      "store_location": "12.9716,77.5946"
    }
  ]
}

{
  "error-code": "invalid-request",
  "message": "Item count should be greater than 0 and less than or equal to 50"
}

{
  "error-code": "request-unauthenticated",
  "message": "Your request is unauthorized. Please verify your credentials and try again."
}

{
  "error-code": "request-denied",
  "message": "Your account does not have access to the Catalog APIs."
}

{
  "error-code": "catalog-not-found",
  "message": "We could not find any API based catalog for the provided catalog id."
}

{
  "error-code": "payload-size-exceeded",
  "message": "Your payload size exceeds the 5MB limit. Please reduce the payload size and try again."
}

Rate Limit

• Request limit: You can get 100 item attribute details per minute OR 1000 item attribute details per hour. You can request up to 50 items per request.

• Payload size limit: 5 MB only when the Content-Length header is provided.

The limit is a COMBINED limit across all Catalog APIs for a specific user.

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

• Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
• Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY · string · required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Path Parameters

catalog_id · string · required

The unique identifier for the catalog, obtained during catalog creation.

Body

application/json

items · string[] · required

A list of unique IDs (strings) that represent the items you want to fetch. This field accepts a maximum of 50 item IDs per request. If the count exceeds this limit, the request results in an error.

Note: The request may fail if mandatory attributes are missing from the item configuration.

Maximum array length: 50

Example:

["P001", "P002", "P003", "P004"]

Response

200

application/json

Items retrieved successfully.

items · object[]

A list of catalog item objects matching the requested item IDs.

Show child attributes