Terminal Hardware Product Preview
A TerminalHardwareProduct is a category of hardware devices that are generally similar, but may have variations depending on the country it’s shipped to.
TerminalHardwareSKUs represent variations within the same Product (for example, a country specific device). For example, WisePOS E is a TerminalHardwareProduct and a WisePOS E - US and WisePOS E - UK are TerminalHardwareSKUs.
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- statusenum
The status of the terminal hardware product.
Possible enum valuesavailable
Available for new orders.
unavailable
Can no longer be used for order creation.
- typestring
The type of product.
- unavailable_
afternullable integer If all the SKUs for this product have an unavailable_after then this is the max unavailable_after in UNIX timestamp. Otherwise, null.
{ "id": "thpr_MJfotcxYT5Hwsm", "object": "terminal.hardware_product", "status": "available", "type": "bbpos_wisepos_e", "unavailable_after": null}
Retrieves a TerminalHardwareProduct
object.
Parameters
No parameters.
Returns
Returns a TerminalHardwareProduct
object if a valid identifier was provided.
{ "id": "thpr_MJfotcxYT5Hwsm", "object": "terminal.hardware_product", "status": "available", "type": "bbpos_wisepos_e", "unavailable_after": null}
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 - limitinteger
- starting_
afterstring
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 } ]}
Terminal Hardware SKU Preview
A TerminalHardwareSKU represents a SKU for Terminal hardware. A SKU is a representation of a product available for purchase, containing information such as the name, price, and images.