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 : |
# Update Order Request
Defines the fields that are included in requests to the
[UpdateOrder](/doc/apis/orders.md#update-order) endpoint.
## Structure
`UpdateOrderRequest`
## Fields
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `order` | [`?Order`](/doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,<br>including line items that specify the products to purchase. `Order` objects also<br>include information about any associated tenders, refunds, and returns.<br><br>All Connect V2 Transactions have all been converted to Orders including all associated<br>itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
| `fieldsToClear` | `?(string[])` | Optional | The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)<br>fields to clear. For example, `line_items[uid].note`.<br>For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders#delete-fields). | getFieldsToClear(): ?array | setFieldsToClear(?array fieldsToClear): void |
| `idempotencyKey` | `?string` | Optional | A value you specify that uniquely identifies this update request.<br><br>If you are unsure whether a particular update was applied to an order successfully,<br>you can reattempt it with the same idempotency key without<br>worrying about creating duplicate updates to the order.<br>The latest order version is returned.<br><br>For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).<br>**Constraints**: *Maximum Length*: `192` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
## Example (as JSON)
```json
{
"order": {
"id": "id6",
"location_id": "location_id0",
"reference_id": "reference_id4",
"source": {
"name": "name2"
},
"customer_id": "customer_id4",
"line_items": [
{
"uid": "uid1",
"name": "name1",
"quantity": "quantity7",
"quantity_unit": {
"measurement_unit": {
"custom_unit": {
"name": "name9",
"abbreviation": "abbreviation1"
},
"area_unit": "METRIC_SQUARE_CENTIMETER",
"length_unit": "IMPERIAL_MILE",
"volume_unit": "GENERIC_FLUID_OUNCE",
"weight_unit": "METRIC_KILOGRAM"
},
"precision": 201,
"catalog_object_id": "catalog_object_id1",
"catalog_version": 135
},
"note": "note3",
"catalog_object_id": "catalog_object_id5"
}
]
},
"fields_to_clear": [
"fields_to_clear1"
],
"idempotency_key": "idempotency_key6"
}
```