Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/square/square/doc/models/ |
Upload File : |
# Search Orders Query
Contains query criteria for the search.
## Structure
`SearchOrdersQuery`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `filter` | [`?SearchOrdersFilter`](/doc/models/search-orders-filter.md) | Optional | Filtering criteria to use for a `SearchOrders` request. Multiple filters<br>are ANDed together. | getFilter(): ?SearchOrdersFilter | setFilter(?SearchOrdersFilter filter): void |
| `sort` | [`?SearchOrdersSort`](/doc/models/search-orders-sort.md) | Optional | Sorting criteria for a `SearchOrders` request. Results can only be sorted<br>by a timestamp field. | getSort(): ?SearchOrdersSort | setSort(?SearchOrdersSort sort): void |
## Example (as JSON)
```json
{
"filter": {
"state_filter": {
"states": [
"CANCELED",
"COMPLETED"
]
},
"date_time_filter": {
"created_at": {
"start_at": "start_at6",
"end_at": "end_at6"
},
"updated_at": {
"start_at": "start_at0",
"end_at": "end_at2"
},
"closed_at": {
"start_at": "start_at0",
"end_at": "end_at2"
}
},
"fulfillment_filter": {
"fulfillment_types": [
"SHIPMENT",
"PICKUP",
"SHIPMENT"
],
"fulfillment_states": [
"PREPARED",
"COMPLETED",
"CANCELED"
]
},
"source_filter": {
"source_names": [
"source_names0"
]
},
"customer_filter": {
"customer_ids": [
"customer_ids7",
"customer_ids8"
]
}
},
"sort": {
"sort_field": "UPDATED_AT",
"sort_order": "DESC"
}
}
```