BrazeEx.Api.ExportPurchases (braze_ex v1.0.3)

API calls for all endpoints tagged ExportPurchases.

Link to this section Summary

Functions

Product IDs List

This endpoint returns paginated lists of product IDs.

Link to this section Functions

Link to this function

purchases_product_list_get(connection, opts \\ [])

@spec purchases_product_list_get(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

product-ids-list

Product IDs List

This endpoint returns paginated lists of product IDs.

rate-limit

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 /events/list endpoint, as documented in API rate limits.

response

Response

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"products": [
  "5499334426779",
  "5499334819995",
  "5499335442587",
  "5499335835803",
  "Calendula Face Mask Peel",
  "Dior Lip Gloss",
  "Rice Bowl",
  "product_name"
],
"message": "success"
}

parameters

Parameters

  • connection (BrazeEx.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :authorization (String.t):
    • :page (integer()): (Optional) Integer The page of your product list that you would like to view.

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure