List all TerminalHardwareProduct
objects.
Parameters
- statusenum
Only return products that have the given status. Defaults to available.
Possible enum valuesavailable
Available for new orders.
unavailable
Can no longer be used for order creation.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of terminal hardware products. Each entry in the array is a separate Product object.
{ "object": "list", "url": "/v1/terminal/hardware_products", "has_more": false, "data": [ { "id": "thpr_MJfotcxYT5Hwsm", "object": "terminal.hardware_product", "status": "available", "type": "bbpos_wisepos_e", "unavailable_after": null } ]}