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

NameDescriptionTypeAdditional information
id

The order id that's been requested to be cancelled

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

OrderResponseModel
NameDescriptionTypeAdditional information
OrderId

globally unique identifier

None.
Created

date

None.
State

OrderState

None.

Response Formats

application/json, text/json

Sample: 
{
  "OrderId": "0d8a1e1a-02c1-4ef0-a0ea-8462b1020f84",
  "Created": "2024-11-21T11:06:40.2651459+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" />