Export product IDs

Use this endpoint to return a paginated lists of product IDs.

Prerequisites

To use this endpoint, you’ll need an API key with the purchases.product_list permission.

Rate limit

For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the /custom_attributes, /events, and /events/list endpoints, as documented in API rate limits.

Request parameters

Example request

1
https://rest.iad-01.braze.com/purchases/product_list?page=1

Response

1
2
3
4
5
6
7
8
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "products": [
    "product_name" (string), the name of the product
  ],
  "message": "success"
}