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": "1224d198-7d9e-4eb8-8a17-b7687d77e9a8", "Ceased": "2024-11-21T10:45:41.3586272+00:00", "Completed": "2024-11-21T10:45:41.3586272+00:00", "Created": "2024-11-21T10:45:41.3586272+00:00", "Customer": "sample string 3", "ICCID": "sample string 4", "Id": "13b2fa57-dd44-48be-b79d-9160df30de0c", "MobileNumber": "sample string 6", "SimId": "3bce5974-e54e-45e2-9510-cd00cb05fd69", "PlacedBy": "sample string 7", "Tariff": "sample string 8", "TariffId": "22136f7b-8e25-4f38-a95d-2f9de0c05b03", "Type": "sample string 9", "CustomerId": "1f52358b-3016-4efa-abe0-d83637f20ba0", "ResellerId": "fbf50fa3-1d4e-47b5-92d2-aa665d14ae44", "PreviousTariff": "sample string 11", "PreviousTariffId": "4852e468-161d-4d99-a9a3-005dab640cd8", "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-21T10:45:41.3586272+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>1224d198-7d9e-4eb8-8a17-b7687d77e9a8</BoltonId> <Ceased>2024-11-21T10:45:41.3586272+00:00</Ceased> <Completed>2024-11-21T10:45:41.3586272+00:00</Completed> <Created>2024-11-21T10:45:41.3586272+00:00</Created> <Customer>sample string 3</Customer> <ICCID>sample string 4</ICCID> <Id>13b2fa57-dd44-48be-b79d-9160df30de0c</Id> <MobileNumber>sample string 6</MobileNumber> <PlacedBy>sample string 7</PlacedBy> <SimId>3bce5974-e54e-45e2-9510-cd00cb05fd69</SimId> <SimTypeLabel>sample string 13</SimTypeLabel> <Tariff>sample string 8</Tariff> <TariffId>22136f7b-8e25-4f38-a95d-2f9de0c05b03</TariffId> <Type>sample string 9</Type> </OrderResultsViewModel>