PUT /v1/{location_id}/orders/{order_id}
Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions:
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id |
String | Yes |
The ID of the order's associated location. |
order_id |
String | Yes |
The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
canceled_note |
String | No |
A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. |
action |
String | Yes |
The action to perform on the order (COMPLETE, CANCEL, or REFUND). |
completed_note |
String | No |
A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. |
shipped_tracking_number |
String | No |
The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. |
refunded_note |
String | No |
A merchant-specified note about the refunding of the order. Only valid if action is REFUND. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.