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
canceledOrder was canceled. Please create a new order to receive these items.deliveredOrder has been delivered!pendingOrder has been received and can still be canceled.ready_to_shipOrder has been confirmed and is pending shipment. It cannot be canceled.shippedOrder has been shipped, and can no longer be canceled.undeliverableOne 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
Cancel a Terminal Hardware Order Preview
POST / v1 / terminal / hardware_orders /:id / cancel
Sets the status of a terminal hardware order from pending to canceled.
Parameters
No parameters.
Returns
Returns the TerminalHardwareOrder object.
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": "canceled", "tax": 1002, "total_tax_amounts": [ { "amount": 1002, "inclusive": false, "rate": { "display_name": "Sales Tax", "jurisdiction": "LOS ANGELES", "percentage": 8.25 } } ], "updated": null}