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}

Retrieve a Terminal Hardware Order Preview

GET / v1 / terminal / hardware_orders /:id

Retrieves a TerminalHardwareOrder object.

Parameters

No parameters.

Returns

Returns a TerminalHardwareOrder object if a valid identifier was provided.

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}

List all Terminal Hardware Orders Preview

GET / v1 / terminal / hardware_orders

List all TerminalHardwareOrder objects.

Parameters

status enum Only return orders that have the given status. 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 parameters

ending _ before string
limit integer
starting _ after string

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.

cURL

Response