api/v1/orders/{id}
Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/orders/{id}
Summary
Get a single order
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The unique order id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
OrderResultsViewModelName | Description | Type | Additional information |
---|---|---|---|
Bolton | string |
None. |
|
BoltonId | globally unique identifier |
None. |
|
Ceased | date |
None. |
|
Completed | date |
None. |
|
Created | date |
None. |
|
Customer | string |
None. |
|
ICCID | string |
None. |
|
Id | globally unique identifier |
None. |
|
MobileNumber | string |
None. |
|
SimId | globally unique identifier |
None. |
|
PlacedBy | string |
None. |
|
Tariff | string |
None. |
|
TariffId | globally unique identifier |
None. |
|
Type | string |
None. |
|
CustomerId | globally unique identifier |
None. |
|
ResellerId | globally unique identifier |
None. |
|
PreviousTariff | string |
None. |
|
PreviousTariffId | globally unique identifier |
None. |
|
State | OrderState |
None. |
|
BillingSiteId | string |
None. |
|
Delivery | OrderDeliveryModel |
None. |
|
SimTypeLabel | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Bolton": "sample string 1", "BoltonId": "02f54c96-2d65-4352-8e59-cdf303513a71", "Ceased": "2025-09-13T20:38:43.285361+00:00", "Completed": "2025-09-13T20:38:43.285361+00:00", "Created": "2025-09-13T20:38:43.285361+00:00", "Customer": "sample string 3", "ICCID": "sample string 4", "Id": "7ea607fb-346b-40ad-8803-06e508e84327", "MobileNumber": "sample string 6", "SimId": "c5a33538-6652-481d-809d-d48a0613e320", "PlacedBy": "sample string 7", "Tariff": "sample string 8", "TariffId": "9f97f0d1-a00e-4456-9919-52eb5fe25972", "Type": "sample string 9", "CustomerId": "d92cd7a6-e7c1-472a-ac87-b399c5f2004a", "ResellerId": "4f84c077-70b4-4dd4-84e8-8b8c278bd18a", "PreviousTariff": "sample string 11", "PreviousTariffId": "adcb0443-0e1a-4bfa-8f8e-cfb1bc847977", "State": 0, "BillingSiteId": "sample string 12", "Delivery": { "TrackingReference": "sample string 1", "TrackingUrl": "sample string 2", "EstimatedDelivery": "sample string 3", "State": 0, "Courier": "sample string 4", "SignedForBy": "sample string 5", "DeliveredDate": "2025-09-13T20:38:43.285361+00:00" }, "SimTypeLabel": "sample string 13" }
application/xml, text/xml
Sample:
<OrderResultsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <Bolton>sample string 1</Bolton> <BoltonId>02f54c96-2d65-4352-8e59-cdf303513a71</BoltonId> <Ceased>2025-09-13T20:38:43.285361+00:00</Ceased> <Completed>2025-09-13T20:38:43.285361+00:00</Completed> <Created>2025-09-13T20:38:43.285361+00:00</Created> <Customer>sample string 3</Customer> <ICCID>sample string 4</ICCID> <Id>7ea607fb-346b-40ad-8803-06e508e84327</Id> <MobileNumber>sample string 6</MobileNumber> <PlacedBy>sample string 7</PlacedBy> <SimId>c5a33538-6652-481d-809d-d48a0613e320</SimId> <SimTypeLabel>sample string 13</SimTypeLabel> <Tariff>sample string 8</Tariff> <TariffId>9f97f0d1-a00e-4456-9919-52eb5fe25972</TariffId> <Type>sample string 9</Type> </OrderResultsViewModel>