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": "a11a19ae-d172-4d68-84b4-9f0bec9b2c33", "Ceased": "2025-01-18T05:15:44.9852531+00:00", "Completed": "2025-01-18T05:15:44.9852531+00:00", "Created": "2025-01-18T05:15:44.9852531+00:00", "Customer": "sample string 3", "ICCID": "sample string 4", "Id": "5ec2c558-4987-4b9f-94d9-8b9eb09add61", "MobileNumber": "sample string 6", "SimId": "bba273fd-83cf-4bf5-a872-9f0abad4d7bf", "PlacedBy": "sample string 7", "Tariff": "sample string 8", "TariffId": "ed76a07a-6a7e-4673-973b-f53105f7c40b", "Type": "sample string 9", "CustomerId": "c6ea4d9d-1dce-499a-9245-f628474084fe", "ResellerId": "d8168838-e2cb-4f12-bc7a-4624c57c3e90", "PreviousTariff": "sample string 11", "PreviousTariffId": "8653aba3-1cd6-4052-9593-aa26f8525e4e", "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-01-18T05:15:44.9852531+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>a11a19ae-d172-4d68-84b4-9f0bec9b2c33</BoltonId> <Ceased>2025-01-18T05:15:44.9852531+00:00</Ceased> <Completed>2025-01-18T05:15:44.9852531+00:00</Completed> <Created>2025-01-18T05:15:44.9852531+00:00</Created> <Customer>sample string 3</Customer> <ICCID>sample string 4</ICCID> <Id>5ec2c558-4987-4b9f-94d9-8b9eb09add61</Id> <MobileNumber>sample string 6</MobileNumber> <PlacedBy>sample string 7</PlacedBy> <SimId>bba273fd-83cf-4bf5-a872-9f0abad4d7bf</SimId> <SimTypeLabel>sample string 13</SimTypeLabel> <Tariff>sample string 8</Tariff> <TariffId>ed76a07a-6a7e-4673-973b-f53105f7c40b</TariffId> <Type>sample string 9</Type> </OrderResultsViewModel>