7b222e8ec91c
List products
Returns a paginated list of products
Query parameters
The number of items to retrieve
A string representing the event series ID
A string representing the add-on status
Unix timestamp filter that returns items with matched created_at value.
Unix timestamp filter that returns items with created_at greater than given value.
Unix timestamp filter that returns items with created_at greater than or equal given value.
Unix timestamp filter that returns items with created_at less than given value.
Unix timestamp filter that returns items with created_at less than or equal given value.
Unix timestamp filter that returns items with matched updated_at value.
Unix timestamp filter that returns items with updated_at greater than the given value.
Unix timestamp filter that returns items with updated_at greater than or equal to the given value.
Unix timestamp filter that returns items with updated_at less than given value.
Unix timestamp filter that returns items with updated_at less than or equal given value.
Response
A successfully returned list of products
Example response
{
"data": [
{
"object": "product",
"id": "pr_1",
"booking_fee": 100,
"created_at": {
"date": "2020-05-01",
"formatted": "Fri 1 May 2020 10:30 PM",
"iso": "2020-05-01T22:30:00+01:00",
"time": "22:30",
"timezone": "+01:00",
"unix": 1588368600
},
"currency": "usd",
"description": "This is a product",
"event_series_ids": [
"es_123",
"es_234",
"es_345"
],
"instructions": "Buy this product at the venue",
"issued_count": 0,
"issue_ticket_voucher": "false",
"voucher_id": null,
"membership_type_id": null,
"linked_to_all_event_series": "true",
"name": "Test Product",
"price": 956,
"quantity": 10,
"sell_in_store": "false",
"status": "on_sale",
"updated_at": {
"date": "2020-05-01",
"formatted": "Fri 1 May 2020 10:30 PM",
"iso": "2020-05-01T22:30:00+01:00",
"time": "22:30",
"timezone": "+01:00",
"unix": 1588368600
}
}
],
"links": {
"next": "/v1/products?starting_after=pr_120",
"previous": "/v1/products?ending_before=pr_100"
}
}