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.
Cancel a Terminal Hardware OrderPreview feature
Sets the status of a terminal hardware order from pending
to canceled
.
Parameters
No parameters.
Returns
Returns the TerminalHardwareOrder
object.
Preview a Terminal Hardware OrderPreview feature
Get a preview of a TerminalHardwareOrder without creating it.
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 (that has not been created) if the preview succeeds.