Terminal Hardware OrderPreview feature
A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.
The TerminalHardwareOrder objectPreview feature
Attributes
- idstring
Unique identifier for the object.
- amountinteger
A positive integer in the smallest currency unit. Represents the total cost for the order.
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- hardware_
order_ itemsarray of objects An array of line items ordered.
- metadatanullable object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- payment_
typeenum One of
monthly_invoice
,payment_intent
, ornone
. - shippingobject
Shipping address for the order.
- shipping_
methodstring The Shipping Method for the order.
- statusenum
The status of the terminal hardware order.
More attributes
- objectstring
- createdtimestamp
- livemodeboolean
- po_
numbernullable string - shipment_
trackingarray of objects - taxinteger
- total_
tax_ amountsarray of objects - updatednullable timestamp
Create a Terminal Hardware OrderPreview feature
Creates a new TerminalHardwareOrder
object.
Parameters
- hardware_
order_ itemsarray of objectsRequired An array of line items to order.
- payment_
typeenumRequired The method of payment for this order.
- shippingobjectRequired
Shipping address for the order.
- shipping_
methodstringRequired The Shipping Method for the order.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- po_
numberstring
Returns
Returns a TerminalHardwareOrder
object if creation succeeds.
Retrieve a Terminal Hardware OrderPreview feature
Retrieves a TerminalHardwareOrder
object.
Parameters
No parameters.
Returns
Returns a TerminalHardwareOrder
object if a valid identifier was provided.
List all Terminal Hardware OrdersPreview feature
List all TerminalHardwareOrder
objects.
Parameters
- statusenum
Only return orders that have the given status.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of terminal hardware orders. Each entry in the array is a separate order object.