Telnyx

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

object

Consolidated filter parameter for SIM card orders (deepObject style). Originally: filter[created_at], filter[updated_at], filter[quantity], filter[cost.amount], filter[cost.currency], filter[address.id], filter[address.street_address], filter[address.extended_address], filter[address.locality], filter[address.administrative_area], filter[address.country_code], filter[address.postal_code]

Show child attributes

filter[created_at]

string<date-time>

Filter by ISO 8601 formatted date-time string matching resource creation date-time.

Example:

"2018-02-02T22:25:27.521Z"

filter[updated_at]

string<date-time>

Filter by ISO 8601 formatted date-time string matching resource last update date-time.

Example:

"2018-02-02T22:25:27.521Z"

filter[quantity]

integer

Filter orders by how many SIM cards were ordered.

Example:

21

filter[cost.amount]

string

The total monetary amount of the order.

Example:

"2.53"

filter[cost.currency]

string

Filter by ISO 4217 currency string.

Example:

"USD"

filter[address.id]

string

Uniquely identifies the address for the order.

Example:

"1293384261075731499"

filter[address.street_address]

string

Returns entries with matching name of the street where the address is located.

Example:

"600 Congress Avenue"

filter[address.extended_address]

string

Returns entries with matching name of the supplemental field for address information.

Example:

"14th Floor"

filter[address.locality]

string

Filter by the name of the city where the address is located.

Example:

"Austin"

filter[address.administrative_area]

string

Filter by state or province where the address is located.

Example:

"TX"

filter[address.country_code]

string

Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code.

Example:

"US"

filter[address.postal_code]

string

Filter by postal code for the address.

Example:

"78701"

page

object

Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

page[number]

integer

default:1

The page number to load.

Required range: x >= 1

page[size]

integer

default:20

The size of the page.

Required range: 1 <= x <= 250

Response

Successful Response

data

SIMCardOrder · object[]

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Identifies the type of the resource.

Example:

"sim_card_order"

data.quantity

integer

The amount of SIM cards requested in the SIM card order.

Required range: x >= 1

Example:

21

data.cost

object

An object representing the total cost of the order.

Show child attributes

data.cost.amount

string

A string representing the cost amount.

Example:

"2.32"

data.cost.currency

string

Filter by ISO 4217 currency string.

Example:

"USD"

Example:

{ "amount": "2.52", "currency": "USD" }

data.order_address

object

An object representing the address information from when the order was submitted.

Show child attributes

data.order_address.id

string

Uniquely identifies the address for the order.

Example:

"1293384261075731499"

data.order_address.first_name

string

The first name of the shipping recipient.

Example:

"John"

data.order_address.last_name

string

The last name of the shipping recipient.

Example:

"Smith"

data.order_address.business_name

string

The name of the business where the address is located.

Example:

"Telnyx LLC"

data.order_address.street_address

string

The name of the street where the address is located.

Example:

"600 Congress Avenue"

data.order_address.extended_address

string

Supplemental field for address information.

Example:

"14th Floor"

data.order_address.locality

string

The name of the city where the address is located.

Example:

"Austin"

data.order_address.administrative_area

string

State or province where the address is located.

Example:

"TX"

data.order_address.country_code

string

The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.

Example:

"US"

data.order_address.postal_code

string

Postal code for the address.

Example:

"78701"

Example:

{
  "id": "1293384261075731499",
  "street_address": "600 Congress Avenue",
  "extended_address": "14th Floor",
  "locality": "Austin",
  "administrative_area": "TX",
  "country_code": "US",
  "postal_code": "78701"
}

data.tracking_url

string<uri>

The URL used to get tracking information about the order.

Example:

"http://www.example.com/"

data.status

enum<string>

The current status of the SIM Card order.

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.

Available options:

pending,

processing,

ready_to_ship,

shipped,

delivered,

canceled

Example:

"pending"

data.created_at

string

ISO 8601 formatted date-time indicating when the resource was last created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date-time indicating when the resource was last updated.

Example:

"2018-02-02T22:25:27.521Z"

IoT

Networking

Get all SIM card orders

Authorizations

Query Parameters

Response