List all products in your catalog
gift_card
: A gift card is a payout that can be redeemed for a specific value.subscription
: A subscription is a payout that can be ordered for a specific duration.payment
: A payment is a payout that can be ordered for a specific value.payout_type
field to determine which object to use to extract details for the product. The different payout types have different fields, so you should use the appropriate object to extract the details you need.
The dated version of the API, if not specified a default is used. See API versioning for more information.
Filter by products which can be ordered. If true
, returns only those which can be ordered, if false
, returns all products.
Filter by countries where a product can be redeemed in. To specify multiple countries repeat the parameter for each country, e.g. ?countries_redeemable_in=US&countries_redeemable_in=GB
. You can pull the list of supported countries from the list countries endpoint.
ISO 3166 ALPHA-2 country code
Filter by product categories. To specify multiple categories repeat the parameter for each category, e.g. ?categories=fashion&categories=department-stores
. You can pull the list of categories from the list categories endpoint.
Product category name
A cursor for use in pagination to return the previous set of results. The before and after cursors are mutually exclusive (you can't use them at the same time). You can get a value from the pagination.cursors.before
field in the response. See pagination for more information.
"A-123"
A cursor for use in pagination to return the next set of results. The before and after cursors are mutually exclusive (you can't use them at the same time). You can get a value from the pagination.cursors.after
field in the response. See pagination for more information.
"A-789"
A limit on the number of items to be returned. See pagination for more information on how to use this parameter.
1 <= x <= 500
List of products in your catalog
The response is of type object
.