View Port Order Status

Private Beta Notice

The Port Orders API endpoints are currently in Private Beta. Some features may change as we receive and incorporate your feedback. To get invited and start testing the beta version, please send an email to support@flowroute.com.

Endpoint

GET /portorders/:id

Use this endpoint to gain the most detailed view of a specific Port Order. The response from this endpoint will show you a Port Order with all of its attributes and related objects (numbers and events).

Request Parameters

  • id
    string

    Unique identifier for the Port Order that you would like to view.

                    

Example Request

curl https://api.flowroute.com/v2/portorders/899011 \
    -u accessKey:secretKey

            

Example Response

{
  "data": {
    "links": {
      "self": "https://api.flowroute.com/v2/portorders/899011"
    },
    "type": "portorder",
    "id": "899011",
    "attributes": {
      "alias": "Smile Center",
      "number_cost": "7.50",
      "total_cost": "7.50",
      "created_at": "2016-10-20T10:15:24Z",
      "updated_at": "2016-10-21T18:21:40Z",
      "notifications_email": [
        "porting@dougspalace.com"
      ],
      "notifications_url": [
        "http://api.dougspalace.com/notifications"
      ],
      "desired_completion_date": "",
      "lsp_requested_completion_date": "",
      "firm_order_completion_date": "",
      "end_user_information": {}, "//...JSON condensed for readability...//"
      "service_address": {}, "//...JSON condensed for readability...//"
      "wireless_fields": {}, "//...JSON condensed for readability...//"
      "loa": {}, "//...JSON condensed for readability...//"
      "uploaded_files": [], "//...JSON condensed for readability...//"
      "recommendations": [], "//...JSON condensed for readability...//"
      "progress": {}, "//...JSON condensed for readability...//"
      "relationships": {
        "numbers": {} "//...JSON condensed for readability...//"
      },
      "included": [
        {
          "type": "number",
          "id": "12068843283",
          "links": {
            "self": "https://api.flowroute.com/v2/numbers/12068843283"
          },
          "attributes": {
            "value": "12068843283",
            "cnam_lookups": "enabled",
            "ratecenter": "seattle",
            "state": "wa"
          },
          "relationships": {} "//...JSON condensed for readability...//"
        }]}}}