Terminal Hardware Orders Preview

A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.

Was this section helpful? Yes No

Create a Terminal Hardware Order

POST / v1 / terminal / hardware_orders

Retrieve a Terminal Hardware Order

GET / v1 / terminal / hardware_orders /:id

List all Terminal Hardware Orders

GET / v1 / terminal / hardware_orders

Cancel a Terminal Hardware Order

POST / v1 / terminal / hardware_orders /:id / cancel

Preview a Terminal Hardware Order

GET / v1 / terminal / hardware_orders / preview

Test mode: Mark a Terminal Hardware Order as Delivered

POST / v1 / test_helpers / terminal / hardware_orders /:id / deliver

Test mode: Mark a Terminal Hardware Order as Ready To Ship

POST / v1 / test_helpers / terminal / hardware_orders /:id / mark_ready_to_ship

Test mode: Mark a Terminal Hardware Order as Shipped

POST / v1 / test_helpers / terminal / hardware_orders /:id / ship

Test mode: Mark a Terminal Hardware Order as Undeliverable

POST / v1 / test_helpers / terminal / hardware_orders /:id / mark_undeliverable

The TerminalHardwareOrder object Preview

Attributes

id string Unique identifier for the object.
amount integer A positive integer in the smallest currency unit. Represents the total cost for the order.
currency enum Three-letter ISO currency code, in lowercase. Must be a supported currency.
hardware _ order _ items array of objects An array of line items ordered.
metadata nullable map 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 _ type enum The method of payment for this order. Possible enum values monthly_invoice A consolidated invoice issued by Stripe at the end of each month. none No charges apply. payment_intent A one-time payment processed at the time of order creation in the dashboard.
shipping object Shipping address for the order.
shipping _ method string The Shipping Method for the order.
status enum The status of the terminal hardware order. Possible enum values canceled 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

object string, value is "terminal.hardware_order"
created timestamp
livemode boolean
po _ number nullable string
shipment _ tracking array of objects
tax integer
total _ tax _ amounts array of objects

The TerminalHardwareOrder object

{ "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_OEu70OWVaQ0DG3", "amount": 450, "country": "US", "currency": "usd", "product": "thpr_NGubNsbUoS1oik" } } ], "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": "thsm_MfuTjLaPEgXMa4", "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

POST / v1 / terminal / hardware_orders

Creates a new TerminalHardwareOrder object.

Parameters

hardware _ order _ items array of objects Required An array of line items to order.
payment _ type enum Required The method of payment for this order. Possible enum values monthly_invoice A consolidated invoice issued by Stripe at the end of each month.
shipping object Required Shipping address for the order.
shipping _ method string Required The Shipping Method for the order.
metadata map 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 _ number string

Returns

Returns a TerminalHardwareOrder object if creation succeeds.

cURL

Response

{ "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_OEu70OWVaQ0DG3", "amount": 450, "country": "US", "currency": "usd", "product": "thpr_NGubNsbUoS1oik" } } ], "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": "thsm_MfuTjLaPEgXMa4", "status": "pending", "tax": 1002, "total_tax_amounts": [ { "amount": 1002, "inclusive": false, "rate": { "display_name": "Sales Tax", "jurisdiction": "LOS ANGELES", "percentage": 8.25 } } ], "updated": null}