SearchOrdersResponse

May 8, 2019 ยท View on GitHub

squareconnect.models.search_orders_response

Description

Only one of order_entries or orders fields will be set, depending on whether return_entries was set on the SearchOrdersRequest.

Properties

NameTypeDescriptionNotes
order_entrieslist[OrderEntry]List of OrderEntries that fit the query conditions. Populated only if `order_entries` was set to `true` in the request.[optional]
orderslist[Order]List of Orders that match query conditions. Populated only if `return_entries` in the request is set to `false`.[optional]
cursorstrThe pagination cursor to be used in a subsequent request. If unset, this is the final response. See Pagination for more information.[optional]
errorslist[Error]Errors encountered during the search.[optional]
unconvertible_transaction_idslist[str]List of transaction IDs identifying transactions that could not be converted to an `Order`. Empty if `return_entries` is true, however, attempts to retrieve those orders may encounter subsequent `unconvertible_transcation_ids` Note that this field will not be present after SearchOrders moves from BETA to GA.[optional]

[Back to Model list] [Back to API list] [Back to README]