The TerminalHardwareProduct object Preview

Attributes

• id string Unique identifier for the object.
• object string, value is "terminal.hardware_product" String representing the object’s type. Objects of the same type share the same value.
• status enum The status of the terminal hardware product. Possible enum values available Available for new orders. unavailable Can no longer be used for order creation.
• type string The type of product.
• unavailable _ after nullable integer If all the SKUs for this product have an unavailable_after then this is the max unavailable_after in the related setting timestamp. Otherwise, null.

The TerminalHardwareProduct object

{ "id": "thpr_MJfotcxYT5Hwsm", "object": "terminal.hardware_product", "status": "available", "type": "bbpos_wisepos_e", "unavailable_after": null}

Retrieve a Terminal Hardware Product Preview

GET / v1 / terminal / hardware_products /:id

Retrieves a TerminalHardwareProduct object.

Parameters

No parameters.

Returns

Returns a TerminalHardwareProduct object if a valid identifier was provided.

cURL

Response

{ "id": "thpr_MJfotcxYT5Hwsm", "object": "terminal.hardware_product", "status": "available", "type": "bbpos_wisepos_e", "unavailable_after": null}

List all Terminal Hardware Products Preview

GET / v1 / terminal / hardware_products

List all TerminalHardwareProduct objects.

Parameters

• status enum Only return products that have the given status. Defaults to available. Possible enum values available Available for new orders. unavailable Can no longer be used for order creation.

More parameters

• ending _ before string
• limit integer
• starting _ after string

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.

cURL

Response