Get all SIM card orders
GET/sim_card_orders
Get all SIM card orders according to filters.
Request
Query Parameters
Filter by ISO 8601 formatted date-time string matching resource creation date-time.
Filter by ISO 8601 formatted date-time string matching resource last update date-time.
Filter orders by how many SIM cards were ordered.
The total monetary amount of the order.
Filter by ISO 4217 currency string.
Uniquely identifies the address for the order.
Returns entries with matching name of the street where the address is located.
Returns entries with matching name of the supplemental field for address information.
Filter by the name of the city where the address is located.
Filter by state or province where the address is located.
Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code.
Filter by postal code for the address.
Possible values: >= 1
Default value: 1
The page number to load.
Possible values: >= 1
and <= 250
Default value: 20
The size of the page.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
pending
- the order is waiting to be processed.processing
- the order is currently being processed.ready_to_ship
- the order is ready to be shipped to the specified address.shipped
- the order was shipped and is on its way to be delivered to the specified address.delivered
- the order was delivered to the specified address.canceled
- the order was canceled.]
data
object[]
Identifies the resource.
Identifies the type of the resource.
Possible values: >= 1
The amount of SIM cards requested in the SIM card order.
cost
object
An object representing the total cost of the order.
A string representing the cost amount.
Filter by ISO 4217 currency string.
order_address
object
An object representing the address information from when the order was submitted.
Uniquely identifies the address for the order.
The first name of the shipping recipient.
The last name of the shipping recipient.
The name of the business where the address is located.
The name of the street where the address is located.
Supplemental field for address information.
The name of the city where the address is located.
State or province where the address is located.
The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.
Postal code for the address.
The URL used to get tracking information about the order.
Possible values: [pending
, processing
, ready_to_ship
, shipped
, delivered
, canceled
]
The current status of the SIM Card order.
ISO 8601 formatted date-time indicating when the resource was last created.
ISO 8601 formatted date-time indicating when the resource was last updated.
meta
object
{
"data": [
{
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_order",
"quantity": 21,
"cost": {
"amount": "2.52",
"currency": "USD"
},
"order_address": {
"id": "1293384261075731499",
"street_address": "311 W Superior St",
"extended_address": "Suite 504",
"locality": "Chicago",
"administrative_area": "IL",
"country_code": "US",
"postal_code": "60654"
},
"tracking_url": "http://www.example.com/",
"status": "pending",
"created_at": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}