Either the order_entries or orders field is set, depending on whether
return_entries is set on the SearchOrdersRequest.
SearchOrdersResponse
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
orderEntries |
?(OrderEntry[]) |
Optional | A list of OrderEntries that fit the query conditions. The list is populated only if return_entries is set to true in the request. |
getOrderEntries(): ?array | setOrderEntries(?array orderEntries): void |
orders |
?(Order[]) |
Optional | A list of Order objects that match the query conditions. The list is populated only if return_entries is set to false in the request. |
getOrders(): ?array | setOrders(?array orders): void |
cursor |
?string |
Optional | The pagination cursor to be used in a subsequent request. If unset, this is the final response. For more information, see Pagination. |
getCursor(): ?string | setCursor(?string cursor): void |
errors |
?(Error[]) |
Optional | Errors encountered during the search. | getErrors(): ?array | setErrors(?array errors): void |
{
"cursor": "123",
"order_entries": [
{
"location_id": "057P5VYJ4A5X1",
"order_id": "CAISEM82RcpmcFBM0TfOyiHV3es",
"version": 1
},
{
"location_id": "18YC4JDH91E1H",
"order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
"version": 182
},
{
"location_id": "057P5VYJ4A5X1",
"order_id": "CAISEM52YcpmcWAzERDOyiWS3ty",
"version": 182
}
],
"orders": [
{
"id": "id2",
"location_id": "location_id6",
"reference_id": "reference_id0",
"source": {
"name": "name4"
},
"customer_id": "customer_id0",
"line_items": [
{
"uid": "uid8",
"name": "name8",
"quantity": "quantity4",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name2",
"abbreviation": "abbreviation4"
},
"area_unit": "IMPERIAL_ACRE",
"length_unit": "IMPERIAL_INCH",
"volume_unit": "METRIC_LITER",
"weight_unit": "IMPERIAL_WEIGHT_OUNCE"
},
"precision": 54,
"catalog_object_id": "catalog_object_id0",
"catalog_version": 12
},
"note": "note4",
"catalog_object_id": "catalog_object_id2"
},
{
"uid": "uid8",
"name": "name8",
"quantity": "quantity4",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name2",
"abbreviation": "abbreviation4"
},
"area_unit": "IMPERIAL_ACRE",
"length_unit": "IMPERIAL_INCH",
"volume_unit": "METRIC_LITER",
"weight_unit": "IMPERIAL_WEIGHT_OUNCE"
},
"precision": 54,
"catalog_object_id": "catalog_object_id0",
"catalog_version": 12
},
"note": "note4",
"catalog_object_id": "catalog_object_id2"
}
]
},
{
"id": "id2",
"location_id": "location_id6",
"reference_id": "reference_id0",
"source": {
"name": "name4"
},
"customer_id": "customer_id0",
"line_items": [
{
"uid": "uid8",
"name": "name8",
"quantity": "quantity4",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name2",
"abbreviation": "abbreviation4"
},
"area_unit": "IMPERIAL_ACRE",
"length_unit": "IMPERIAL_INCH",
"volume_unit": "METRIC_LITER",
"weight_unit": "IMPERIAL_WEIGHT_OUNCE"
},
"precision": 54,
"catalog_object_id": "catalog_object_id0",
"catalog_version": 12
},
"note": "note4",
"catalog_object_id": "catalog_object_id2"
},
{
"uid": "uid8",
"name": "name8",
"quantity": "quantity4",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name2",
"abbreviation": "abbreviation4"
},
"area_unit": "IMPERIAL_ACRE",
"length_unit": "IMPERIAL_INCH",
"volume_unit": "METRIC_LITER",
"weight_unit": "IMPERIAL_WEIGHT_OUNCE"
},
"precision": 54,
"catalog_object_id": "catalog_object_id0",
"catalog_version": 12
},
"note": "note4",
"catalog_object_id": "catalog_object_id2"
}
]
},
{
"id": "id2",
"location_id": "location_id6",
"reference_id": "reference_id0",
"source": {
"name": "name4"
},
"customer_id": "customer_id0",
"line_items": [
{
"uid": "uid8",
"name": "name8",
"quantity": "quantity4",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name2",
"abbreviation": "abbreviation4"
},
"area_unit": "IMPERIAL_ACRE",
"length_unit": "IMPERIAL_INCH",
"volume_unit": "METRIC_LITER",
"weight_unit": "IMPERIAL_WEIGHT_OUNCE"
},
"precision": 54,
"catalog_object_id": "catalog_object_id0",
"catalog_version": 12
},
"note": "note4",
"catalog_object_id": "catalog_object_id2"
},
{
"uid": "uid8",
"name": "name8",
"quantity": "quantity4",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name2",
"abbreviation": "abbreviation4"
},
"area_unit": "IMPERIAL_ACRE",
"length_unit": "IMPERIAL_INCH",
"volume_unit": "METRIC_LITER",
"weight_unit": "IMPERIAL_WEIGHT_OUNCE"
},
"precision": 54,
"catalog_object_id": "catalog_object_id0",
"catalog_version": 12
},
"note": "note4",
"catalog_object_id": "catalog_object_id2"
}
]
}
],
"errors": [
{
"category": "MERCHANT_SUBSCRIPTION_ERROR",
"code": "INVALID_EXPIRATION",
"detail": "detail6",
"field": "field4"
},
{
"category": "MERCHANT_SUBSCRIPTION_ERROR",
"code": "INVALID_EXPIRATION",
"detail": "detail6",
"field": "field4"
}
]
}