Telnyx Developers

Get all SIM card orders

gethttps://api.telnyx.com/v2/sim_card_orders

Get all SIM card orders according to filters.

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/sim_card_orders?filter[created_at]=2018-02-02T22:25:27.521Z&filter[updated_at]=2018-02-02T22:25:27.521Z"

Parameters

In Query

filter[created_at]

string

(datetime)

optional

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

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

filter[updated_at]

string

(datetime)

optional

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

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

filter[quantity]

integer

optional

Filter orders by how many SIM cards were ordered.

Example: 21

filter[cost.amount]

string

optional

The total monetary amount of the order.

Example: "2.53"

filter[cost.currency]

string

optional

Filter by ISO 4217 currency string.

Example: "USD"

filter[address.id]

string

(int64)

optional

Uniquely identifies the address for the order.

Example: "1293384261075731499"

filter[address.street_address]

string

optional

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

Example: "311 W Superior St"

filter[address.extended_address]

string

optional

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

Example: "Suite 504"

filter[address.locality]

string

optional

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

Example: "Chicago"

filter[address.administrative_area]

string

optional

Filter by state or province where the address is located.

Example: "IL"

filter[address.country_code]

string

optional

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

Example: "US"

filter[address.postal_code]

string

optional

Filter by postal code for the address.

Example: "60654"

page[number]

integer

(1)

optional

The page number to load

Default:

page[size]

integer

(1 - 250)

optional

The size of the page

Default:

Responses

200

Successful response

default

Unexpected error

Success Response

{
  "data": [
    {
      "cost": {
        "amount": "2.52",
        "currency": "USD"
      },
      "created_at": "2018-02-02T22:25:27.521Z",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "order_address": {
        "administrative_area": "IL",
        "country_code": "US",
        "extended_address": "Suite 504",
        "id": "1293384261075731499",
        "locality": "Chicago",
        "postal_code": "60654",
        "street_address": "311 W Superior St"
      },
      "quantity": 21,
      "record_type": "sim_card_order",
      "status": "pending",
      "tracking_url": "http://www.example.com/",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/sim_card_orders

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/sim_card_orders/{id}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/sim_card_order_preview

...

...

Parameters

Responses

Success Response

SIM Card Group Actions

SIM Cards

Was this page helpful?