Create Order

Description

Creates a DID Order.

Request

HTTP Method: POST

URI Path: /v3/orders

Body:

Name	Type	Is Required?	Description
allow_back_ordering	boolean	Optional	Allowing back ordering.
items	Array<CreateOrderItem>	Yes	Order items array.
callback_url	string	Optional	The HTTP or HTTPS endpoint to where events related to order will be delivered.
callback_method	string	Optional	The HTTP Method used for order events. POST, GET are supported methods.

See Callback details for information about callback_url and callback_method.

Order Item:

Name	Type	Is Required?	Description
type	string	Optional	Item object type: did_order_items for DIDs and capacity_order_items for Channels.
attributes	One of DID Order Item Attributes, Capacity Order Item Attributes	br		Optional	Order Item Attributes object.

Order Item Attributes:

DIDCapacity

Name	Type	Is Required?	Description
sku_id	string	Yes	Stock Keeping Unit ID. Should be used with one of optional parameters qty, available_did_id or did_reservation_id.
qty	integer	Yes	Quantity of DIDs.
did_reservation_id	string	Optional	Specific DID Reservation ID.
billing_cycles_count	integer	Optional	The number of Billing Cycles that this DID Number will renew until expiration.
available_did_id	string	Optional	Specific Available DID ID.
prorate_days_qty	integer	Optional	Amount of service time (days).

Attention

Please note that “prorate_days_qty” attribute will be ignored if Prorate billing is not enabled per your DIDWW account. To enabled this billing option please contact Sales department via email sales@didww.com

Examples

allow_back_ordering = trueallow_back_ordering = falseAvailable DID IDDID Reservation IDCallback ExamplePurchasing Capacity

http

POST /v3/orders HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "orders",
    "attributes": {
      "allow_back_ordering": true,
      "items": [
        {
          "type": "did_order_items",
          "attributes": {
            "qty": 15,
            "sku_id": "a78bb6d8-b05e-4e12-afe6-ad84ac979088"
          }
        }
      ]
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/orders -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"allow_back_ordering": true, "items": [{"type": "did_order_items", "attributes": {"qty": 15, "sku_id": "a78bb6d8-b05e-4e12-afe6-ad84ac979088"}}]}, "type": "orders"}}'

response

POST /v3/orders HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "orders",
    "attributes": {
      "allow_back_ordering": true,
      "items": [
        {
          "type": "did_order_items",
          "attributes": {
            "qty": 15,
            "sku_id": "a78bb6d8-b05e-4e12-afe6-ad84ac979088"
          }
        }
      ]
    }
  }
}

Available DID with prorate_days_qty

http

POST /v3/orders HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "orders",
    "attributes": {
      "allow_back_ordering": false,
      "items": [
        {
          "type": "did_order_items",
          "attributes": {
            "available_did_id": "6c82282c-8193-43ca-9876-8ddef1ade253",
            "sku_id": "644c2449-0e23-4a67-9f81-565ad5137bb6",
            "prorate_days_qty": 10
          }
        }
      ]
    }
  }
}

curl

curl -i -X POST https://api.didww.com/v3/orders -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"allow_back_ordering": false, "items": [{"type": "did_order_items", "attributes": {"available_did_id": "6c82282c-8193-43ca-9876-8ddef1ade253", "sku_id": "644c2449-0e23-4a67-9f81-565ad5137bb6", "prorate_days_qty": 10}}]}, "type": "orders"}}'

response

POST /v3/orders HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "type": "orders",
    "attributes": {
      "allow_back_ordering": false,
      "items": [
        {
          "type": "did_order_items",
          "attributes": {
            "available_did_id": "6c82282c-8193-43ca-9876-8ddef1ade253",
            "sku_id": "644c2449-0e23-4a67-9f81-565ad5137bb6",
            "prorate_days_qty": 10
          }
        }
      ]
    }
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized