SIM Card Orders V1

SIM Card Order operations

Get all 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

Response Schema: application/json
Array of objects (SIMCardOrder)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
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.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
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.

get/wireless/sim_card_orders
Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create a SIM card order
Creates a new order for SIM cards.


Request 
Request Body schema: application/json
required
SIM card order request


quantity
integer
The nunber of SIM card you wish to order.


 
object (Shipping address information) 
 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCardOrder) 
 
id
string
The id of the SIM card order


 
quantity
integer
The number of SIM cards ordered


 
object (Shipping address information) 
 
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
 Enum: "pending" "ready_to_ship" "shipped" "delivered"  
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
post/wireless/sim_card_orders
Request samples 
application/json
{
  • "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"
    }
}
Response samples 
application/json
{
  • "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"
    }
}
Get SIM card order
Returns the details regarding a specific SIM card.


Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the SIM card order


 
Responses 
200
Successful response


Response Schema: application/json
object (SIMCardOrder) 
 
id
string
The id of the SIM card order


 
quantity
integer
The number of SIM cards ordered


 
object (Shipping address information) 
 
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
 Enum: "pending" "ready_to_ship" "shipped" "delivered"  
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 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.


 
get/wireless/sim_card_orders/{id}
Request samples 
Response samples 
application/json
{
  • "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"
    }
}