Create DID order

POST https://{{host}}/v3/orders

Request Body Scheme

{

data (object, required) {

type (string, required): orders

attributes (object, required) {

allowbackordering (boolean, optional)
Allowing back ordering.

items (Array[CreateOrderItem], required) [
Order items array.

{

type (string): didorderitems

attributes (object) {

sku_id (string, required)
Stock Keeping Unit Object ID. Should be used with one of optional parameters qty, available_did_id or did_reservation_id.

qty (integer, required)
Quantity if ordering items. Should NOT be used with optional parameters available_did_id or did_reservation_id.

didreservationid (string, optional)
Specific DID Reservation Object ID.

billingcyclescount (integer, optional)
The number of Billing Cycles that this DID Number will renew until expiration.

availabledidid (string, optional)
Specific Available DID Object ID.

}

}

]

}

}

}

Request Body

{"data"=>{"type"=>"orders", "attributes"=>{"allow_back_ordering"=>true, "items"=>[{"type"=>"did_order_items", "attributes"=>{"qty"=>1, "sku_id"=>"{{stock_keeping_unit.id}}"}}]}}}

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: Created

{"data":{"id":"9eeaab6c-b758-41b8-af86-8978a86603a2","type":"orders","attributes":{"reference":"FZH-374899","amount":"79.2","status":"Pending","created_at":"2017-06-25T14:56:31.513Z","description":"DID","items":[{"type":"did_order_items","attributes":{"qty":15,"nrc":"5.00","mrc":"5.00","prorated_mrc":true,"billed_from":"2018-08-15","billed_to":"2018-09-15","did_group_id":"d01704b0-6522-47d5-8865-3398c417ed1d"}}]}}}