API documentation

POST /number_orders

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/number_orders

Create Number Order.

Creates a Number Order to purchase numbers from the given provider configuration for an offer. Numbers are provisioned asynchronously after the order is created, and only proceed once the company is verified and can afford the numbers being purchased.

Params

Param name	Description
offer_id Optional Blank value allowed	The offer the ordered numbers will be assigned to. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank value allowed	The number pool the ordered numbers will be added to. Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank value allowed	The traffic source the ordered numbers will be assigned to. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank value allowed	The schedule the ordered numbers will be assigned to. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank value allowed	The name of the number order. Must be a String
description Optional Blank value allowed	A description of the number order. Must be a String
provider_configuration_id Optional Blank value allowed	The provider the numbers will be purchased from. Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations
paused Optional Blank value allowed	Pause the order so it stops purchasing numbers. Must be a boolean value: 1, true, yes, on, 0, false, no, off
fallback_to_any_number_in_state Optional Blank value allowed	When no number is available with the requested prefix, allow purchasing any available number in the same state. Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/number_orders/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Number Order",
  "offer_id": 10002,
  "provider_configuration_id": 10001
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "number_order": {
    "id": 10001,
    "type": "NumberOrder",
    "uuid": "a0d49c48-1b1e-4760-ac0d-da771aa599db",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/number_orders/10001",
    "routes_edit_path": "/number_orders/10001/edit",
    "external_record_id": null,
    "paused": true,
    "offer_id": 10002,
    "ring_pool_id": null,
    "traffic_source_id": null,
    "schedule_id": null,
    "name": "Example Number Order",
    "description": null,
    "provider_configuration_id": 10001,
    "numbers_count": null,
    "fallback_to_any_number_in_state": null,
    "number_order_prefix_ids": []
  },
  "metadata": {
    "root": "number_order"
  }
}