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": "cfb860f2-ef64-48b3-b9b9-2c5b44d0bfb7", "Ceased": "2024-11-14T20:51:22.573228+00:00", "Completed": "2024-11-14T20:51:22.573228+00:00", "Created": "2024-11-14T20:51:22.573228+00:00", "Customer": "sample string 3", "ICCID": "sample string 4", "Id": "c93e1220-5881-43bd-a2dc-bff8e43e2d47", "MobileNumber": "sample string 6", "SimId": "2ca877cb-0d1a-4e81-a589-56c883f70fb9", "PlacedBy": "sample string 7", "Tariff": "sample string 8", "TariffId": "2fcda560-3bb0-41cb-9211-2015683a3a27", "Type": "sample string 9", "CustomerId": "d103b945-0968-40cb-892b-3c5098c37567", "ResellerId": "212aa20a-05b8-4d20-8d06-f1a1e1dc30a2", "PreviousTariff": "sample string 11", "PreviousTariffId": "42617206-0ebe-49d6-af2b-9e1e328fa751", "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": "2024-11-14T20:51:22.573228+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>cfb860f2-ef64-48b3-b9b9-2c5b44d0bfb7</BoltonId> <Ceased>2024-11-14T20:51:22.573228+00:00</Ceased> <Completed>2024-11-14T20:51:22.573228+00:00</Completed> <Created>2024-11-14T20:51:22.573228+00:00</Created> <Customer>sample string 3</Customer> <ICCID>sample string 4</ICCID> <Id>c93e1220-5881-43bd-a2dc-bff8e43e2d47</Id> <MobileNumber>sample string 6</MobileNumber> <PlacedBy>sample string 7</PlacedBy> <SimId>2ca877cb-0d1a-4e81-a589-56c883f70fb9</SimId> <SimTypeLabel>sample string 13</SimTypeLabel> <Tariff>sample string 8</Tariff> <TariffId>2fcda560-3bb0-41cb-9211-2015683a3a27</TariffId> <Type>sample string 9</Type> </OrderResultsViewModel>