Terminal Hardware Order Preview feature
A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.
- POST/
The TerminalHardwareOrder object Preview 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_
, orintent none
. - shippingobject
Shipping address for the order.
- shipping_
methodstring The Shipping Method for the order.
- statusenum
The status of the terminal hardware order.
Possible enum valuescanceled
Order was canceled. Please create a new order to receive these items.
delivered
Order has been delivered!
pending
Order has been received and can still be canceled.
ready_
to_ ship Order has been confirmed and is pending shipment. It cannot be canceled.
shipped
Order has been shipped, and can no longer be canceled.
undeliverable
One or more of the order’s items could not be delivered.
More attributes
- objectstring
- createdtimestamp
- livemodeboolean
- po_
numbernullable string - shipment_
trackingarray of objects - taxinteger
- total_
tax_ amountsarray of objects - updatednullable timestamp
{ "id": "thor_1Nj6mu2eZvKYlo2CRG74vB9n", "object": "terminal.hardware_order", "amount": 13602, "created": 1692995962, "currency": "usd", "hardware_order_items": [ { "amount": 11800, "currency": "usd", "quantity": 2, "terminal_hardware_sku": { "id": "thsku_L5fys7HZ5o02Nc", "amount": 450, "country": "AT", "currency": "eur", "product": "thpr_MJfof7SLvdkG6T" } } ], "livemode": true, "metadata": {}, "payment_type": "monthly_invoice", "po_number": null, "shipment_tracking": [], "shipping": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Main Street", "line2": "", "postal_code": "94111", "state": "CA" }, "amount": 800, "company": "Rocket Rides", "currency": "usd", "email": "test@example.com", "name": "Jenny Rosen", "phone": "15555555555" }, "shipping_method": "standard", "status": "pending", "tax": 1002, "total_tax_amounts": [ { "amount": 1002, "inclusive": false, "rate": { "display_name": "Sales Tax", "jurisdiction": "LOS ANGELES", "percentage": 8.25 } } ], "updated": null}
Create a Terminal Hardware Order Preview 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.
{ "id": "thor_1Nj6mu2eZvKYlo2CRG74vB9n", "object": "terminal.hardware_order", "amount": 13602, "created": 1692995962, "currency": "usd", "hardware_order_items": [ { "amount": 11800, "currency": "usd", "quantity": 2, "terminal_hardware_sku": { "id": "thsku_L5fys7HZ5o02Nc", "amount": 450, "country": "AT", "currency": "eur", "product": "thpr_MJfof7SLvdkG6T" } } ], "livemode": true, "metadata": {}, "payment_type": "monthly_invoice", "po_number": null, "shipment_tracking": [], "shipping": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Main Street", "line2": "", "postal_code": "94111", "state": "CA" }, "amount": 800, "company": "Rocket Rides", "currency": "usd", "email": "test@example.com", "name": "Jenny Rosen", "phone": "15555555555" }, "shipping_method": "standard", "status": "pending", "tax": 1002, "total_tax_amounts": [ { "amount": 1002, "inclusive": false, "rate": { "display_name": "Sales Tax", "jurisdiction": "LOS ANGELES", "percentage": 8.25 } } ], "updated": null}
Retrieve a Terminal Hardware Order Preview feature
Retrieves a TerminalHardwareOrder
object.
Parameters
No parameters.
Returns
Returns a TerminalHardwareOrder
object if a valid identifier was provided.
{ "id": "thor_1Nj6mu2eZvKYlo2CRG74vB9n", "object": "terminal.hardware_order", "amount": 13602, "created": 1692995962, "currency": "usd", "hardware_order_items": [ { "amount": 11800, "currency": "usd", "quantity": 2, "terminal_hardware_sku": { "id": "thsku_L5fys7HZ5o02Nc", "amount": 450, "country": "AT", "currency": "eur", "product": "thpr_MJfof7SLvdkG6T" } } ], "livemode": true, "metadata": {}, "payment_type": "monthly_invoice", "po_number": null, "shipment_tracking": [], "shipping": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Main Street", "line2": "", "postal_code": "94111", "state": "CA" }, "amount": 800, "company": "Rocket Rides", "currency": "usd", "email": "test@example.com", "name": "Jenny Rosen", "phone": "15555555555" }, "shipping_method": "standard", "status": "pending", "tax": 1002, "total_tax_amounts": [ { "amount": 1002, "inclusive": false, "rate": { "display_name": "Sales Tax", "jurisdiction": "LOS ANGELES", "percentage": 8.25 } } ], "updated": null}
List all Terminal Hardware Orders Preview feature
List all TerminalHardwareOrder
objects.
Parameters
- statusenum
Only return orders that have the given status.
Possible enum valuescanceled
Order was canceled. Please create a new order to receive these items.
delivered
Order has been delivered!
pending
Order has been received and can still be canceled.
ready_
to_ ship Order has been confirmed and is pending shipment. It cannot be canceled.
shipped
Order has been shipped, and can no longer be canceled.
undeliverable
One or more of the order’s items could not be delivered.
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.
{ "object": "list", "url": "/v1/terminal/hardware_orders", "has_more": false, "data": [ { "id": "thor_1Nj6mu2eZvKYlo2CRG74vB9n", "object": "terminal.hardware_order", "amount": 13602, "created": 1692995962, "currency": "usd", "hardware_order_items": [ { "amount": 11800, "currency": "usd", "quantity": 2, "terminal_hardware_sku": { "id": "thsku_L5fys7HZ5o02Nc", "amount": 450, "country": "AT", "currency": "eur", "product": "thpr_MJfof7SLvdkG6T" } } ], "livemode": true, "metadata": {}, "payment_type": "monthly_invoice", "po_number": null, "shipment_tracking": [], "shipping": { "address": { "city": "San Francisco", "country": "US", "line1": "1234 Main Street", "line2": "", "postal_code": "94111", "state": "CA" }, "amount": 800, "company": "Rocket Rides", "currency": "usd", "email": "test@example.com", "name": "Jenny Rosen", "phone": "15555555555" }, "shipping_method": "standard", "status": "pending", "tax": 1002, "total_tax_amounts": [ { "amount": 1002, "inclusive": false, "rate": { "display_name": "Sales Tax", "jurisdiction": "LOS ANGELES", "percentage": 8.25 } } ], "updated": null } {...} {...} ],}