List benefits

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/benefits \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "POINTS",
      "status": "DRAFT",
      "stock": {
        "type": "UNLIMITED",
        "limited": {
          "quantity": 4503599627370495
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "object": "benefit",
      "points": {
        "value": 4503599627370495,
        "card_definition_id": "<string>"
      },
      "points_proportional": {
        "calculation_type": "PRE_DISCOUNT_ORDER_AMOUNT",
        "card_definition_id": "<string>",
        "order": {
          "amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5
          },
          "total_amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5
          },
          "metadata": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "property": "<string>"
          }
        },
        "customer": {
          "metadata": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "property": "<string>"
          }
        },
        "custom_event": {
          "metadata": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "property": "<string>"
          }
        },
        "order_items": {
          "amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "applicable_to": [
              {
                "type": "product",
                "product": {
                  "id": "<string>"
                },
                "sku": {
                  "id": "<string>"
                },
                "products_collection": {
                  "id": "<string>"
                }
              }
            ]
          },
          "subtotal_amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "applicable_to": [
              {
                "type": "product",
                "product": {
                  "id": "<string>"
                },
                "sku": {
                  "id": "<string>"
                },
                "products_collection": {
                  "id": "<string>"
                }
              }
            ]
          },
          "quantity": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "applicable_to": [
              {
                "type": "product",
                "product": {
                  "id": "<string>"
                },
                "sku": {
                  "id": "<string>"
                },
                "products_collection": {
                  "id": "<string>"
                }
              }
            ]
          }
        }
      },
      "material": {
        "type": "PRODUCT",
        "product": {
          "id": "<string>"
        },
        "sku": {
          "product_id": "<string>",
          "id": "<string>"
        }
      },
      "digital": {
        "type": "GIFT_VOUCHERS",
        "gift_vouchers": {
          "campaign_id": "<string>",
          "balance": 4503599627370495.5
        },
        "discount_coupons": {
          "campaign_id": "<string>"
        }
      }
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "object": "list"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 500,
  "key": "api_error",
  "message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}

List benefits

Documentation in progress

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

Returns a cursor-paginated list of benefits. Supports filtering by id, name, status, type, and created_at, ordering by created_at, name, and type (prefix with - for descending), and cursor-based pagination. Deleted benefits are excluded. Multiple filters are combined with the junction (AND by default). The same field cannot be ordered both ascending and descending at the same time.

GET

loyalties

benefits

List benefits

curl --request GET \
  --url https://{cluster}.voucherify.io/v2/loyalties/benefits \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "POINTS",
      "status": "DRAFT",
      "stock": {
        "type": "UNLIMITED",
        "limited": {
          "quantity": 4503599627370495
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "object": "benefit",
      "points": {
        "value": 4503599627370495,
        "card_definition_id": "<string>"
      },
      "points_proportional": {
        "calculation_type": "PRE_DISCOUNT_ORDER_AMOUNT",
        "card_definition_id": "<string>",
        "order": {
          "amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5
          },
          "total_amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5
          },
          "metadata": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "property": "<string>"
          }
        },
        "customer": {
          "metadata": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "property": "<string>"
          }
        },
        "custom_event": {
          "metadata": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "property": "<string>"
          }
        },
        "order_items": {
          "amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "applicable_to": [
              {
                "type": "product",
                "product": {
                  "id": "<string>"
                },
                "sku": {
                  "id": "<string>"
                },
                "products_collection": {
                  "id": "<string>"
                }
              }
            ]
          },
          "subtotal_amount": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "applicable_to": [
              {
                "type": "product",
                "product": {
                  "id": "<string>"
                },
                "sku": {
                  "id": "<string>"
                },
                "products_collection": {
                  "id": "<string>"
                }
              }
            ]
          },
          "quantity": {
            "every": 4503599627370496,
            "value": 4503599627370495.5,
            "applicable_to": [
              {
                "type": "product",
                "product": {
                  "id": "<string>"
                },
                "sku": {
                  "id": "<string>"
                },
                "products_collection": {
                  "id": "<string>"
                }
              }
            ]
          }
        }
      },
      "material": {
        "type": "PRODUCT",
        "product": {
          "id": "<string>"
        },
        "sku": {
          "product_id": "<string>",
          "id": "<string>"
        }
      },
      "digital": {
        "type": "GIFT_VOUCHERS",
        "gift_vouchers": {
          "campaign_id": "<string>",
          "balance": 4503599627370495.5
        },
        "discount_coupons": {
          "campaign_id": "<string>"
        }
      }
    }
  ],
  "cursor": {
    "next": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "object": "list"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 500,
  "key": "api_error",
  "message": "Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Query Parameters

limit

default:10

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

Required range: 1 <= x <= 100

order

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to -created_at. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

Available options:

-created_at,

created_at,

name,

-name,

-type,

type

cursor

string | null

Continues pagination. Pass the cursor.next value from a previous response. Format lcrsben_[a-f0-9]+. The cursor matches the filters and order of that response.

Pattern: ^lcrsben_[a-f0-9]+$

filters

Loyalties Benefits List Request Query · object | null

Filters the results. Pass a deep object, for example filters[name][conditions][$contains]=gold. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter. Request query schema for GET /v2/loyalties/benefits.

Show child attributes

Response

Cursor-paginated list of benefits

Response body schema for GET /v2/loyalties/benefits.

data

object[]

required

Benefits matching the query, in the requested order.

Show child attributes

cursor

object | null

required

Pagination cursor. null when there are no more results.

Show child attributes

object

string

required

Type of the object. Always list.

Allowed value: "list"

Introduction

Endpoints

Events

List benefits

Authorizations

Query Parameters

Response