POST api/cancelOrder
Cancel orders: delete order, return stock back, refund franpos gift cards
Request Information
Allows multi-location processing, in case of using parent location token restrictByLocations parameter is strongly recommended with comma separated list of locations to select from or update in
URI Parameters
None.
Body Parameters
Collection of ReturnOrderInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | integer |
None. |
|
| LocationId | integer |
None. |
|
| IsFullRefund |
Default logic (if false) - mark original order as deleted and rollback any activities were happened when sale, like a payment transactions, inventory changes and so on. If it's true - it will left sale as is and just create another refund-order in same way as our normal flow of the system - but skip payments processing (payments should be processed before that call outside the system). |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"OrderId": 1,
"LocationId": 2,
"IsFullRefund": true
},
{
"OrderId": 1,
"LocationId": 2,
"IsFullRefund": true
}
]
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |