api/v1/orders
Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/orders?search={search}&skip={skip}&take={take}&type={type}&state={state}&startDate={startDate}&endDate={endDate}
Summary
Get a list of orders
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
search |
The resource being looked up |
string |
None. |
skip |
The number of records to skip |
integer |
Default value is 0 |
take |
The number of records requested |
integer |
Default value is 10 |
type |
Click the button to display the type values |
OrderType |
None. |
state |
Click the button to display the state values |
OrderState |
None. |
startDate |
The earliest possible order create date |
date |
None. |
endDate |
The latest possible order that which was created |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of 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. |
Response Formats
application/json, text/json
Sample:
[ { "Bolton": "sample string 1", "BoltonId": "bd941c5a-ca72-4e7f-9e30-82cd09188e97", "Ceased": "2022-05-19T22:28:54.2202308+00:00", "Completed": "2022-05-19T22:28:54.2202308+00:00", "Created": "2022-05-19T22:28:54.2202308+00:00", "Customer": "sample string 3", "ICCID": "sample string 4", "Id": "3feee6a7-d585-42b7-bc1b-9273e191ba90", "MobileNumber": "sample string 6", "SimId": "cc947d75-af9a-4a8c-a57d-bffd92659313", "PlacedBy": "sample string 7", "Tariff": "sample string 8", "TariffId": "32fe0ad0-03e1-43c1-bab3-ae27c708f626", "Type": "sample string 9", "CustomerId": "395b276c-ab0d-4e69-b8b2-a212cc120607", "ResellerId": "93fa03a6-cd46-47d0-a1f0-7206f119c1de", "PreviousTariff": "sample string 11", "PreviousTariffId": "176c5663-ea20-458c-87aa-7d4adff1f48a", "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": "2022-05-19T22:28:54.2358628+00:00" } }, { "Bolton": "sample string 1", "BoltonId": "bd941c5a-ca72-4e7f-9e30-82cd09188e97", "Ceased": "2022-05-19T22:28:54.2202308+00:00", "Completed": "2022-05-19T22:28:54.2202308+00:00", "Created": "2022-05-19T22:28:54.2202308+00:00", "Customer": "sample string 3", "ICCID": "sample string 4", "Id": "3feee6a7-d585-42b7-bc1b-9273e191ba90", "MobileNumber": "sample string 6", "SimId": "cc947d75-af9a-4a8c-a57d-bffd92659313", "PlacedBy": "sample string 7", "Tariff": "sample string 8", "TariffId": "32fe0ad0-03e1-43c1-bab3-ae27c708f626", "Type": "sample string 9", "CustomerId": "395b276c-ab0d-4e69-b8b2-a212cc120607", "ResellerId": "93fa03a6-cd46-47d0-a1f0-7206f119c1de", "PreviousTariff": "sample string 11", "PreviousTariffId": "176c5663-ea20-458c-87aa-7d4adff1f48a", "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": "2022-05-19T22:28:54.2358628+00:00" } } ]
application/xml, text/xml
Sample:
<ArrayOfOrderResultsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SimPortalApi.Models.Orders"> <OrderResultsViewModel> <Bolton>sample string 1</Bolton> <BoltonId>bd941c5a-ca72-4e7f-9e30-82cd09188e97</BoltonId> <Ceased>2022-05-19T22:28:54.2202308+00:00</Ceased> <Completed>2022-05-19T22:28:54.2202308+00:00</Completed> <Created>2022-05-19T22:28:54.2202308+00:00</Created> <Customer>sample string 3</Customer> <ICCID>sample string 4</ICCID> <Id>3feee6a7-d585-42b7-bc1b-9273e191ba90</Id> <MobileNumber>sample string 6</MobileNumber> <PlacedBy>sample string 7</PlacedBy> <SimId>cc947d75-af9a-4a8c-a57d-bffd92659313</SimId> <Tariff>sample string 8</Tariff> <TariffId>32fe0ad0-03e1-43c1-bab3-ae27c708f626</TariffId> <Type>sample string 9</Type> </OrderResultsViewModel> <OrderResultsViewModel> <Bolton>sample string 1</Bolton> <BoltonId>bd941c5a-ca72-4e7f-9e30-82cd09188e97</BoltonId> <Ceased>2022-05-19T22:28:54.2202308+00:00</Ceased> <Completed>2022-05-19T22:28:54.2202308+00:00</Completed> <Created>2022-05-19T22:28:54.2202308+00:00</Created> <Customer>sample string 3</Customer> <ICCID>sample string 4</ICCID> <Id>3feee6a7-d585-42b7-bc1b-9273e191ba90</Id> <MobileNumber>sample string 6</MobileNumber> <PlacedBy>sample string 7</PlacedBy> <SimId>cc947d75-af9a-4a8c-a57d-bffd92659313</SimId> <Tariff>sample string 8</Tariff> <TariffId>32fe0ad0-03e1-43c1-bab3-ae27c708f626</TariffId> <Type>sample string 9</Type> </OrderResultsViewModel> </ArrayOfOrderResultsViewModel>