api/v1/orders/unbar

Method: POST https://simportal-api-staging.azurewebsites.net/api/v1/orders/unbar?simId={simId}

Summary

Create an unbar order to unsuspend a SIM. If you are unbarring a conditional bar, by sending an unbar request you agree to the conditions of the bar. BarRequireBolton bars will place the smallest available bolton to cover usage. BarRequireIMEILockInput bars will keep the currently locked IMEI the same.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
simId

The unique SIM id that's been requested to remove the BAR from

 globally unique identifier

Required

Body Parameters

This model contains all of the information required to create a Unbar order

CreateOrderModel
NameDescriptionTypeAdditional information
Reason

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Reason": "sample string 1"
}

application/xml, text/xml

Sample: 
<CreateOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders">
  <Reason>sample string 1</Reason>
</CreateOrderModel>

application/x-www-form-urlencoded

Sample: 
Reason=samplestring

Response Information

Resource Description

OrderResponseModel
NameDescriptionTypeAdditional information
OrderId

globally unique identifier

None.
Created

date

None.
State

OrderState

None.
OrderTimescale

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "OrderId": "bd004bd8-cbbb-4d50-b494-1eb663794cab",
  "Created": "2025-12-16T21:15:41.5709573+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>