View a Port Order Group Status

When a Port Order is created with multiple phone numbers, it may be split into multiple Orders due to type of phone number (local versus toll free, US versus Canadian), underlying operating carrier (SPIDs), and Flowroute’s phone number coverage footprint. A Port Order Group associates the Port Orders split on creation or during the porting process. The Port-In API can be utilized to obtain the status of a Port Order Group and associated Port Orders. Information returned includes:

  • Port Order Group Status Summary
    • Requires Action : any port order within the group is in status Pending or Rejected. This indicates that the customer needs to take action on a port order or port orders within the group before it can complete
    • Completed : all port orders within the group are in status Completed OR all port orders within a group are in status Canceled or Completed. No further action is required by the customer or will be taken by Flowroute.
    • Canceled : all port orders within the group are Canceled, whether status is Canceled, Processing Abandoned, Abandoned or Hard Canceled. No further action is required by the customer or will be taken by Flowroute.
    • In Progress : any port order within the group is in status Process, Submitted or Accepted and no port order within the group is in status Pending or Rejected. This indicates that no customer action is required on any order, and Flowroute's team is working on the port orders.
  • A list of all the Port Orders associated to a Port Order Group with respective Port Order Number and Status

Method

GET portorders/:group_id/status

Body Parameters

  • data
    object

    Data object for the port order status.

  • id
    integer

    Port order ID.

  • type
    string

    This will always be portorder.

  • attributes
    object

    Object composed of the following port order status attributes.

  • Attributes

  • status
    string
    • Pending

      Requires customer action to submit the port order to Flowroute; if port order is not updated or submitted within 45 days it will be automatically canceled.

    • Processing

      Requires Flowroute action to submit to the LSP

    • Submitted

      Submitted to LSP and awaiting a response

    • Accepted

      LSP accepted the port order request and a completion date has been set

    • Rejected

      Port order was Rejected and is awaiting customer action and re-submission. Note that resubmission of an in flight order does not incur additional fees

    • Review

      Customer has resubmitted after a rejection and the order is awaiting Flowroute action. Note that resubmission of an in flight does not incur additional fees

    • Completed

      The port order completed

    • Canceled

      Customer decided not to continue the process and canceled the port order from the Pending status. No fees are incurred.

    • Abandoned

      Customer canceled an order from the Rejected status or did not resubmit a Rejected order within 45 days. No fees are incurred.

    • Hard_canceled

      Canceled from the Submitted status or after a completion date was provided; cancellation fees may be assessed

  • status_updated_at
    datetime

    Date and time, to the second, on which the port order was last updated. Only displays a timestamp in the ISO 8601 format once the port order is past the pending status.


  • Response Format

    On success, the HTTP status code in the response header is 200 OK and the response body contains status information of the specified Port Order Group.

Example Request

							GET /v2/portorders?group_id=41351 HTTP/1.1
Content-Type: application/json
Accept: application/json
							
						

Example Request

                            
curl -X GET https://api.flowroute.com/v2/portorders?group_id=41351 -u accessKey:secretKey
                            
                        

Success

							
200 OK

{
  "data": {
    "attributes": {
      "orders": [
        "data": {
          "attributes": {
            "date_created": "2018-07-30T20:33:18Z",
            "group_id": "8223",
            "desired_completion_date": "2018-08-02T21:34:17Z",
            "status": "pending",
            "status_updated_at": "2018-07-31T21:34:17Z",
            "last_modified_at": "2018-07-31T21:34:17Z",
            "numbers": [
              "12331244563", "12331244564", "12331244565", "12331244567"
            ],
          }
          "id":"41352",
          "links": {
            "self": "https://api.flowroute.com/v2/portorders/41351"
          },
        },
        "data": {
          "attributes": {
            "date_created": "2018-07-30T20:33:18Z",
            "group_id": "8223",
            "desired_completion_date": "2018-08-02T21:34:17Z",
            "status": "submitted",
            "status_updated_at": "2018-07-31T21:34:17Z",
            "last_modified_at": "2018-07-31T21:34:17Z",
            "numbers": [
              "12131244563"
            ],
          }
          "id":"41353",
          "links": {
            "self": "https://api.flowroute.com/v2/portorders/41353"
          },
          "type":"portorder_summary_status",
        },
      ],
    },
    "id": "8223",
    "status":"In Progress",
    "type": "portorder_group_status_summary",
    "links": {
      "self": "https://api.flowroute.com/v2/portorders/8223"
    },
  }
}