You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 23, 2021. It is now read-only.
varlocationId=locationId_example; // string | The ID of the order's associated location.
308
+
varorderId=orderId_example; // string | The ID of the order to update.
307
309
varbody=newUpdateOrderRequest(); // UpdateOrderRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details.
**locationId** | **string**| The ID of the order's associated location. |
331
+
**orderId** | **string**| The ID of the order to update. |
328
332
**body** | [**UpdateOrderRequest**](UpdateOrderRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. |
Copy file name to clipboardExpand all lines: src/Square.Connect/Api/OrdersApi.cs
+42-10
Original file line number
Diff line number
Diff line change
@@ -117,8 +117,10 @@ public interface IOrdersApi : IApiAccessor
117
117
/// Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
118
118
/// </remarks>
119
119
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
120
+
/// <param name="locationId">The ID of the order's associated location.</param>
121
+
/// <param name="orderId">The ID of the order to update.</param>
120
122
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
@@ -127,9 +129,11 @@ public interface IOrdersApi : IApiAccessor
127
129
/// Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
128
130
/// </remarks>
129
131
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
132
+
/// <param name="locationId">The ID of the order's associated location.</param>
133
+
/// <param name="orderId">The ID of the order to update.</param>
130
134
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
131
135
/// <returns>ApiResponse of UpdateOrderResponse</returns>
@@ -229,9 +233,11 @@ public interface IOrdersApi : IApiAccessor
229
233
/// Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
230
234
/// </remarks>
231
235
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
236
+
/// <param name="locationId">The ID of the order's associated location.</param>
237
+
/// <param name="orderId">The ID of the order to update.</param>
232
238
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
233
239
/// <returns>Task of UpdateOrderResponse</returns>
@@ -240,9 +246,11 @@ public interface IOrdersApi : IApiAccessor
240
246
/// Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
241
247
/// </remarks>
242
248
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
249
+
/// <param name="locationId">The ID of the order's associated location.</param>
250
+
/// <param name="orderId">The ID of the order to update.</param>
243
251
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
244
252
/// <returns>Task of ApiResponse (UpdateOrderResponse)</returns>
@@ -1047,22 +1055,32 @@ public async System.Threading.Tasks.Task<ApiResponse<SearchOrdersResponse>> Sear
1047
1055
/// UpdateOrder Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
1048
1056
/// </summary>
1049
1057
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
1058
+
/// <param name="locationId">The ID of the order's associated location.</param>
1059
+
/// <param name="orderId">The ID of the order to update.</param>
1050
1060
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
/// UpdateOrder Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
1060
1070
/// </summary>
1061
1071
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
1072
+
/// <param name="locationId">The ID of the order's associated location.</param>
1073
+
/// <param name="orderId">The ID of the order to update.</param>
1062
1074
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
1063
1075
/// <returns>ApiResponse of UpdateOrderResponse</returns>
localVarPostBody=Configuration.ApiClient.Serialize(body);// http body (model) parameter
@@ -1128,11 +1148,13 @@ public ApiResponse< UpdateOrderResponse > UpdateOrderWithHttpInfo (UpdateOrderRe
1128
1148
/// UpdateOrder Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
1129
1149
/// </summary>
1130
1150
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
1151
+
/// <param name="locationId">The ID of the order's associated location.</param>
1152
+
/// <param name="orderId">The ID of the order to update.</param>
1131
1153
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
1132
1154
/// <returns>Task of UpdateOrderResponse</returns>
@@ -1141,10 +1163,18 @@ public async System.Threading.Tasks.Task<UpdateOrderResponse> UpdateOrderAsync (
1141
1163
/// UpdateOrder Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does).
1142
1164
/// </summary>
1143
1165
/// <exception cref="Square.Connect.Client.ApiException">Thrown when fails to make API call</exception>
1166
+
/// <param name="locationId">The ID of the order's associated location.</param>
1167
+
/// <param name="orderId">The ID of the order to update.</param>
1144
1168
/// <param name="body">An object containing the fields to POST for the request. See the corresponding object definition for field details.</param>
1145
1169
/// <returns>Task of ApiResponse (UpdateOrderResponse)</returns>
0 commit comments