Create a SIM card order
Creates a new order for SIM cards.
POST
/
sim_card_orders
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const simCardOrder = await client.simCardOrders.create({
address_id: '1293384261075731499',
quantity: 23,
});
console.log(simCardOrder.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
sim_card_order = client.sim_card_orders.create(
address_id="1293384261075731499",
quantity=23,
)
print(sim_card_order.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
simCardOrder, err := client.SimCardOrders.New(context.TODO(), telnyx.SimCardOrderNewParams{
AddressID: "1293384261075731499",
Quantity: 23,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", simCardOrder.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.simcardorders.SimCardOrderCreateParams;
import com.telnyx.sdk.models.simcardorders.SimCardOrderCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SimCardOrderCreateParams params = SimCardOrderCreateParams.builder()
.addressId("1293384261075731499")
.quantity(23L)
.build();
SimCardOrderCreateResponse simCardOrder = client.simCardOrders().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
sim_card_order = telnyx.sim_card_orders.create(address_id: "1293384261075731499", quantity: 23)
puts(sim_card_order)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$simCardOrder = $client->simCardOrders->create(
addressID: '1293384261075731499', quantity: 23
);
var_dump($simCardOrder);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx sim-card-orders create \
--api-key 'My API Key' \
--address-id 1293384261075731499 \
--quantity 23curl --request POST \
--url https://api.telnyx.com/v2/sim_card_orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address_id": "1293384261075731499",
"quantity": 23
}
'{
"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"
}
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const simCardOrder = await client.simCardOrders.create({
address_id: '1293384261075731499',
quantity: 23,
});
console.log(simCardOrder.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
sim_card_order = client.sim_card_orders.create(
address_id="1293384261075731499",
quantity=23,
)
print(sim_card_order.data)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
simCardOrder, err := client.SimCardOrders.New(context.TODO(), telnyx.SimCardOrderNewParams{
AddressID: "1293384261075731499",
Quantity: 23,
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", simCardOrder.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.simcardorders.SimCardOrderCreateParams;
import com.telnyx.sdk.models.simcardorders.SimCardOrderCreateResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SimCardOrderCreateParams params = SimCardOrderCreateParams.builder()
.addressId("1293384261075731499")
.quantity(23L)
.build();
SimCardOrderCreateResponse simCardOrder = client.simCardOrders().create(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
sim_card_order = telnyx.sim_card_orders.create(address_id: "1293384261075731499", quantity: 23)
puts(sim_card_order)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$simCardOrder = $client->simCardOrders->create(
addressID: '1293384261075731499', quantity: 23
);
var_dump($simCardOrder);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx sim-card-orders create \
--api-key 'My API Key' \
--address-id 1293384261075731499 \
--quantity 23curl --request POST \
--url https://api.telnyx.com/v2/sim_card_orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address_id": "1293384261075731499",
"quantity": 23
}
'{
"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"
}
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}