Get all SIM card orders

GET 
/wireless/sim_card_orders

Returns a list of all your sim card orders

Request

Query Parameters

page[number] number

Current page based on pagination settings.

page[size] number

Number of results to return per page based on pagination settings.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id string

The id of the SIM card order

quantity integer

The number of SIM cards ordered

shipping_address

object

The address to which the SIM cards will be shipped to

street_line_1 string

street_line_2 string

locality string

administrative_area string

postal_code string

extended_address string

country_code string

The address to which the SIM cards will be shipped to

sim_group_id string

The id of the SIM card group that the SIM card belongs to

data_plan_id string

The id for the data plan of the SIM card

delivery_service string

The service used to deliver the shipment

tracking_number string

The tracking number for the order shipment

created_at string

Timestamp for when the order was created

updated_at string

Timestamp for when the order was last updated

order_status string

Possible values: [pending, ready_to_ship, shipped, delivered]

]

metadata

object

total_pages double

Total number of pages based on pagination settings

total_results double

Total number of results

page_number double

Current Page based on pagination settings (included when defaults are used.)

page_size double

Number of results to return per page based on pagination settings (included when defaults are used.)

{
  "data": [
    {
      "id": "string",
      "quantity": 0,
      "shipping_address": {
        "street_line_1": "string",
        "street_line_2": "string",
        "locality": "string",
        "administrative_area": "string",
        "postal_code": "string",
        "extended_address": "string",
        "country_code": "string"
      },
      "sim_group_id": "string",
      "data_plan_id": "string",
      "delivery_service": "string",
      "tracking_number": "string",
      "created_at": "string",
      "updated_at": "string",
      "order_status": "pending"
    }
  ],
  "metadata": {
    "total_pages": 13,
    "total_results": 13,
    "page_number": 3,
    "page_size": 1
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code string

an application-specific error code, expressed as a stringified integer.

title string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer string

JSON pointer to the field which is causing the error.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/wireless/sim_card_orders' \
-H 'Accept: application/json'

Response samples

• 200
• 401
• 403

---

{
  "data": [
    {
      "id": "string",
      "quantity": 0,
      "shipping_address": {
        "street_line_1": "string",
        "street_line_2": "string",
        "locality": "string",
        "administrative_area": "string",
        "postal_code": "string",
        "extended_address": "string",
        "country_code": "string"
      },
      "sim_group_id": "string",
      "data_plan_id": "string",
      "delivery_service": "string",
      "tracking_number": "string",
      "created_at": "string",
      "updated_at": "string",
      "order_status": "pending"
    }
  ],
  "metadata": {
    "total_pages": 13,
    "total_results": 13,
    "page_number": 3,
    "page_size": 1
  }
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}