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
CreateSimSwapOrderModelName | 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": "66de2381-15b7-4f86-bf02-a42ec39895c4", "NewSimId": "86c5638f-1c84-40ab-9fb9-c9298e807124", "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>86c5638f-1c84-40ab-9fb9-c9298e807124</NewSimId> <OriginalSimId>66de2381-15b7-4f86-bf02-a42ec39895c4</OriginalSimId> </CreateSimSwapOrderModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
OrderResponseModelName | 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": "76dbcd5d-7f4b-4061-922e-87f2fcab0104", "Created": "2025-10-14T03:06:54.1432933+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>