Skip to main content

Get all SIM card orders

GET 
/sim_card_orders

Get all SIM card orders according to filters.

Request ​

Query Parameters

    filter[created_at] date-time

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

    filter[updated_at] date-time

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

    filter[quantity] integer

    Filter orders by how many SIM cards were ordered.

    filter[cost.amount] string

    The total monetary amount of the order.

    filter[cost.currency] string

    Filter by ISO 4217 currency string.

    filter[address.id] string

    Uniquely identifies the address for the order.

    filter[address.street_address] string

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

    filter[address.extended_address] string

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

    filter[address.locality] string

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

    filter[address.administrative_area] string

    Filter by state or province where the address is located.

    filter[address.country_code] string

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

    filter[address.postal_code] string

    Filter by postal code for the address.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load.

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page.

Responses ​

200: Successful Response

Schema

    data

    object[]

  • Array [

    • id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    quantity integer

    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.

    amount string

    A string representing the cost amount.

    currency string

    Filter by ISO 4217 currency string.

    An object representing the total cost of the order.

    order_address

    object

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

    id string

    Uniquely identifies the address for the order.

    first_name string

    The first name of the shipping recipient.

    last_name string

    The last name of the shipping recipient.

    business_name string

    The name of the business where the address is located.

    street_address string

    The name of the street where the address is located.

    extended_address string

    Supplemental field for address information.

    locality string

    The name of the city where the address is located.

    administrative_area string

    State or province where the address is located.

    country_code string

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

    postal_code string

    Postal code for the address.

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

    tracking_url uri

    The URL used to get tracking information about the order.

    status string

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

    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.

    created_at string

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

    updated_at string

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

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

default: Unexpected error

Schema

    errors

    object[]

  • Array [

    • code stringrequired
    title stringrequired
    detail string

    source

    object

    pointer string

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    property name* any

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/sim_card_orders' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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": "600 Congress Avenue",
        "extended_address": "14th Floor",
        "locality": "Austin",
        "administrative_area": "TX",
        "country_code": "US",
        "postal_code": "78701"
      },
      "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
  }
}