v1

latestOpenAPI 3.1.02026-07-26141236.8 KB
Points Products

List points products

Retrieves a list of points products based on the specified filters.

get/points_products

Query parameters

exchange_type'fixed' | 'variable'

Filter results to only points products with the provided exchange_type.

Example:variable

Filter results to only points products with the provided exchange_type.

page_sizeinteger

The maximum number of points products to retrieve.

The maximum number of points products to retrieve.

pageinteger

The page of points products to retrieve.

The page of points products to retrieve.

Response

The points products were successfully retrieved.

Example response

{
  "points_products": [
    {
      "id": 132456921,
      "exchange_type": "variable",
      "exchange_description": "100 Points = $1 off",
      "variable_points_step": 100,
      "variable_points_step_reward_value": 1,
      "variable_points_min": 100,
      "variable_points_max": 5000,
      "reward": {
        "id": 924565472,
        "name": "Order discount",
        "image_url": "https://platform-images.smilecdn.co/3755938.png",
        "created_at": "2024-04-04T15:10:42.030Z",
        "updated_at": "2024-04-04T15:10:42.030Z"
      },
      "created_at": "2024-04-04T15:10:42.030Z",
      "updated_at": "2024-04-04T15:10:42.030Z"
    }
  ]
}