{
  "info": {
    "_postman_id": "apeiron-ordering___provisioning",
    "name": "Apeiron API - Ordering & Provisioning",
    "description": "Port ordering (single and bulk), order management, number and SIM disconnection, and trunk group provisioning.\n\nCollection Version: 1.0.0\nBase URL: https://api.apeiron.io/v2\nAuth: HTTP Basic (email + API token) or JWT Bearer token\nAPI Reference: https://api.apeiron.io/v2/",
    "version": "1.0.0",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "basic",
    "basic": [
      {
        "key": "username",
        "value": "{{username}}",
        "type": "string"
      },
      {
        "key": "password",
        "value": "{{api_token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.apeiron.io",
      "type": "string"
    },
    {
      "key": "username",
      "value": "",
      "type": "string"
    },
    {
      "key": "api_token",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Disconnect",
      "description": "Disconnect endpoints",
      "item": [
        {
          "name": "Disconnect number",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_number",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_number"
              ]
            },
            "description": "Disconnect one number",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "number",
                  "description": "Number to be disconnected",
                  "type": "text",
                  "value": "4442221345"
                }
              ]
            }
          }
        },
        {
          "name": "Disconnect numbers",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_number/many",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_number",
                "many"
              ]
            },
            "description": "Disconnect many numbers. Unlike the endpoint that accepts only one number, this endpoint performs validation of each number in the backend. An order will be created if at least one number is validated.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "numbers",
                  "description": "Numbers to be disconnected, in comma or whitespace separated format",
                  "type": "text",
                  "value": "4442221345, 9996781392 4431230987"
                }
              ]
            }
          }
        },
        {
          "name": "Get disconnect number requests",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_number/requests",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_number",
                "requests"
              ]
            },
            "description": "Get disconnect number requests"
          }
        },
        {
          "name": "Get disconnect number request detail",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_number/requests/{disconnect_request_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_number",
                "requests",
                "{disconnect_request_id}"
              ]
            },
            "description": "Get disconnect number request details, including accepted and rejected numbers"
          }
        },
        {
          "name": "Disconnect SIM",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_sim",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_sim"
              ]
            },
            "description": "Disconnect SIMs. Validation is performed on each ICCID in the backend. An order will be created if at least one ICCID is validated.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "iccids",
                  "description": "ICCIDs of SIMs to be disconnected, in comma or whitespace separated format",
                  "type": "text",
                  "value": "12345123451234512345, 89900123459876598765"
                },
                {
                  "key": "reuse_sims",
                  "description": "Use selected SIMs to create a new order after disconnection",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Get disconnect SIM requests",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_sim/requests",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_sim",
                "requests"
              ]
            },
            "description": "Get disconnect SIM requests"
          }
        },
        {
          "name": "Disconnect cellular",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_cellular",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_cellular"
              ]
            },
            "description": "Disconnect cellular numbers. Validation is performed on each number in the backend. An order will be created if at least one number is validated.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "numbers",
                  "description": "Cellular numbers to be disconnected, in comma or whitespace separated format",
                  "type": "text",
                  "value": "4442221345, 9996781392 4431230987"
                },
                {
                  "key": "reuse_sims",
                  "description": "Use cellular SIMs to create a new order after disconnection",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Get disconnect cellular requests",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_cellular/requests",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_cellular",
                "requests"
              ]
            },
            "description": "Get disconnect cellular requests"
          }
        },
        {
          "name": "Disconnect Trunk Group",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_trunk_group",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_trunk_group"
              ]
            },
            "description": "Disconnect Trunk Group. Validation is performed on each ID in the backend. An order will be created if at least one ID is validated.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "trunk_group_ids",
                  "description": "IDs of Trunk Groups to be disconnected, in comma or whitespace separated format",
                  "type": "text",
                  "value": "12345, 432167"
                }
              ]
            }
          }
        },
        {
          "name": "Get disconnect Trunk Group requests",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/disconnect_trunk_group/requests",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "disconnect_trunk_group",
                "requests"
              ]
            },
            "description": "Get disconnect Trunk Group requests"
          }
        }
      ]
    },
    {
      "name": "Ordering",
      "description": "Ordering endpoints",
      "item": [
        {
          "name": "Get order information",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/orders/{order_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "orders",
                "{order_id}"
              ]
            },
            "description": "Get order information."
          }
        },
        {
          "name": "Submit a new port order",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/ordering/trunk_groups/{trunk_group_id}/port_numbers",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "trunk_groups",
                "{trunk_group_id}",
                "port_numbers"
              ]
            },
            "description": "Submit DID numbers to port from a different carrier to Apeiron's network. These numbers will be added to an existing Apeiron trunk group on the account.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone_numbers\": [],\n  \"billing_number\": \"4442221345\",\n  \"current_provider\": \"Verizon Wireless\",\n  \"authorization_name\": \"John Smith\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Smith\",\n  \"business_name\": \"Only required if address is a Business a\",\n  \"full_port\": false,\n  \"housenumber\": 0,\n  \"features\": [],\n  \"room_type\": \"Room type if corresponding address a spe\",\n  \"room_number\": 0,\n  \"predirectional\": \"Predirectional for the streetname if ava\",\n  \"streetname\": \"Street name of the address\",\n  \"city\": \"Name of the city in the address\",\n  \"state\": \"Two letter state e.g. CA, TX, MN\",\n  \"postal_code\": \"5 digit postal code\",\n  \"plus_four\": 0,\n  \"account_number\": \"Account number for Verizon Wireless acco\",\n  \"pin\": \"PIN Number for Verizon Wireless accounts\",\n  \"due_date\": \"Requested due date on the order in an IS\",\n  \"loa_document_id\": \"ID provided from Apeiron document file u\",\n  \"ticket_id\": 0,\n  \"reference\": \"Any customer reference information for e\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Port orders list",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/orders/ports?order_type=&status=&number=&reference=&order_date=2024-03-01&last_updated=2024-04-12&foc_date=2023-01-01&completion_date=2024-02-15&support_ticket_number=&order_id=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "orders",
                "ports"
              ],
              "query": [
                {
                  "key": "order_type",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "number",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "reference",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "order_date",
                  "value": "2024-03-01",
                  "description": "Earliest order date to return",
                  "disabled": true
                },
                {
                  "key": "last_updated",
                  "value": "2024-04-12",
                  "description": "Earliest last updated date to return",
                  "disabled": true
                },
                {
                  "key": "foc_date",
                  "value": "2023-01-01",
                  "description": "Earliest FOC date to return",
                  "disabled": true
                },
                {
                  "key": "completion_date",
                  "value": "2024-02-15",
                  "description": "Earliest completion date to return, in YYYY-MM-DD format",
                  "disabled": true
                },
                {
                  "key": "support_ticket_number",
                  "value": "",
                  "description": "Support ticket number to filter orders by",
                  "disabled": true
                },
                {
                  "key": "order_id",
                  "value": "",
                  "description": "Order ID to filter orders by",
                  "disabled": true
                }
              ]
            },
            "description": "Retrieve list of submitted orders with number port-ins, optionally filtering by the query parameters below"
          }
        },
        {
          "name": "Submit a new bulk port order",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/ordering/trunk_groups/{trunk_group_id}/bulk_port_numbers",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "trunk_groups",
                "{trunk_group_id}",
                "bulk_port_numbers"
              ]
            },
            "description": "Submit bulk (400+) DID numbers to port from a different carrier to Apeiron's network. These numbers will be added to an existing Apeiron trunk group on the account.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone_numbers\": [],\n  \"billing_number\": \"4442221345\",\n  \"current_provider\": \"Verizon Wireless\",\n  \"authorization_name\": \"John Smith\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Smith\",\n  \"business_name\": \"Only required if address is a Business a\",\n  \"full_port\": false,\n  \"housenumber\": 0,\n  \"features\": [],\n  \"room_type\": \"Room type if corresponding address a spe\",\n  \"room_number\": 0,\n  \"predirectional\": \"Predirectional for the streetname if ava\",\n  \"streetname\": \"Street name of the address\",\n  \"city\": \"Name of the city in the address\",\n  \"state\": \"Two letter state e.g. CA, TX, MN\",\n  \"postal_code\": \"5 digit postal code\",\n  \"plus_four\": 0,\n  \"account_number\": \"Account number for Verizon Wireless acco\",\n  \"pin\": \"PIN Number for Verizon Wireless accounts\",\n  \"due_date\": \"Requested due date on the order in an IS\",\n  \"loa_document_id\": \"ID provided from Apeiron document file u\",\n  \"ticket_id\": 0,\n  \"reference\": \"Any customer reference information for e\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get bulk number port status",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/bulk_port_numbers/{job_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "bulk_port_numbers",
                "{job_id}"
              ]
            },
            "description": "Get bulk number port status."
          }
        },
        {
          "name": "Trigger a port order",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ordering/orders/ports/trigger/{order_id}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ordering",
                "orders",
                "ports",
                "trigger",
                "{order_id}"
              ]
            },
            "description": "Submit a trigger request on an existing port order",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "trigger_time",
                  "description": "Optional trigger time in PST on the estimated due date when the port shall be triggered",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          }
        },
        {
          "name": "Add new numbers to a trunk group",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{base_url}}/voice/trunk_groups/{trunk_id}/add_numbers?check_balance=",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "voice",
                "trunk_groups",
                "{trunk_id}",
                "add_numbers"
              ],
              "query": [
                {
                  "key": "check_balance",
                  "value": "",
                  "description": "Set to \"1\" to perform a real-time balance check. This option is only applicable to prepaid accounts. If this option is set to false (default) and your balance is too low to fulfill the order, the order will fail at a later stage.",
                  "disabled": true
                }
              ]
            },
            "description": "Add new numbers to a trunk group. The numbers being added must first be reserved.",
            "body": {
              "mode": "raw",
              "raw": "{}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        }
      ]
    }
  ]
}