api/v1/orders/{id}/cancel
Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/{id}/cancel
Summary
Cancels an order only if its current state is pending, stalled or open. Complete and failed orders cannot be cancelled
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The order id that's been requested to be cancelled |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
OrderResponseModelName | Description | Type | Additional information |
---|---|---|---|
OrderId | globally unique identifier |
None. |
|
Created | date |
None. |
|
State | OrderState |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderId": "0a5c33c2-9f64-47cc-b599-878997e82c2a", "Created": "2024-03-12T13:05:39.7165767+00:00", "State": 0 }
application/xml, text/xml
Sample:
<OrderResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders" />