api/v1/orders/simswap
Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/simswap
Summary
Create a Sim Swap order
Request Information
URI Parameters
None.
Body Parameters
The SimSwapOrderModel contains the original SIM and the new SIM that will be swapped against
CreateSimSwapOrderModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OriginalSimId | globally unique identifier |
None. |
|
| NewSimId | globally unique identifier |
None. |
|
| Reason | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"OriginalSimId": "f871979f-4316-45f7-991b-3c9082143064",
"NewSimId": "39691ca4-1c76-41b6-b5a6-8556caafd37f",
"Reason": "sample string 3"
}
application/xml, text/xml
Sample:
<CreateSimSwapOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <Reason>sample string 3</Reason> <NewSimId>39691ca4-1c76-41b6-b5a6-8556caafd37f</NewSimId> <OriginalSimId>f871979f-4316-45f7-991b-3c9082143064</OriginalSimId> </CreateSimSwapOrderModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
OrderResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | globally unique identifier |
None. |
|
| Created | date |
None. |
|
| State | OrderState |
None. |
|
| OrderTimescale | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"OrderId": "adf96bdc-c6cf-46f2-807f-c8472454a157",
"Created": "2026-11-20T08:12:58.9173555+00:00",
"State": 0,
"OrderTimescale": "sample string 3"
}
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"> <OrderTimescale>sample string 3</OrderTimescale> </OrderResponseModel>