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	Type	Additional information
OriginalSimId	globally unique identifier	None.
NewSimId	globally unique identifier	None.
Reason	string	None.

Request Formats

application/json, text/json

Sample:

{
  "OriginalSimId": "5e4cf61b-2b4d-4167-921a-85f0d87b8dce",
  "NewSimId": "138fe86e-1ab2-4748-ae9d-6ec5e4de41f2",
  "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>138fe86e-1ab2-4748-ae9d-6ec5e4de41f2</NewSimId>
  <OriginalSimId>5e4cf61b-2b4d-4167-921a-85f0d87b8dce</OriginalSimId>
</CreateSimSwapOrderModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateSimSwapOrderModel'.

Response Information

Resource Description

OrderResponseModel

Name	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": "5009e963-9aab-4ee2-8153-2cfe2a0e873d",
  "Created": "2025-10-24T13:48:46.4862887+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>