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 email@example.com.
Friendly name for the Port Order.
The cost to port each individual number associated with the Port Order.
The cost to port every number associated with the Port Order.
DateTime of when an object was first created.
DateTime of when the most recent change was applied to the Port Order.
Contains email addresses that will be emailed whenever a change is made to the Port Order.
Contains URLs that will be POSTed to whenever a change is made to the Port Order.
DateTime of when you would ideally like for the Port Order to complete.
Date that Flowroute is requesting the Losing Service Provider to allow the Port Order to complete on. If Flowroute's port request is successful, then this will become the firm_order_completion_date.
Date that Flowroute and the Losing Service Provider have agreed to complete the Port Order on. This is the date on which your number(s) will migrate to Flowroute.
Contains fields related to the Current Service Provider and your account with them.
The company from which you currently purchase telecom services.
The ID for your account with the Losing Service Provider.
First and last name of the person authorized to make changes on your account with the Losing Service Provider.
Main phone number that represents your account with the Losing Service Provider.
Name of the company that has the account with the Losing Service Provider.
Contains fields related to the address that the Losing Service Provider has on file for the porting numbers.
Street address where the Losing Service Provider services the porting numbers. This is often referred to as the "Service Address" and can be different from the "Billing Address".
Second line of the Address; often contains Unit, Floor, or Suite information.
City where the Losing Service Provider services the porting numbers.
State where the Losing Service Provider services the porting numbers.
Zip code where the Losing Service Provider services the porting numbers.
Country where the Losing Service Provider services the porting numbers.
Contains fields for additional information often required when porting numbers away from Wireless carriers.
The last four digits of the authorized_contact's social security number.
Pin that the Losing Service Provider requires in order to make changes to your account.
Contains fields related to the Letter of Agency that users must esign in order to authorize Flowroute to port their numbers.
URL where you can download a copy of a document associated with the Port Order.
Defines whether or not the user has esigned the LOA for the Port Order.
DateTime of when the user esigned the LOA for the Port Order.
uploaded_filesarray containing hashes
Contains fields relates to files that have been uploaded to the Port Order. These will often be Bills from the Losing Service Provider.
Unique identifier for a file that was uploaded to the Port Order.
Name of the file that was uploaded to the Port Order.
DateTime of when the file was uploaded to the Port Order.
The type of file that was uploaded to the Port Order.
Size of the uploaded file in kilobytes.
recommendationsarray containing hashes
Contains fields for tasks that Flowroute is recommending the user to complete in order to help ensure the Port Order completes in a timely fashion.
The Flowroute agent that created the recommendation.
High level explanation of what Flowroute is requesting.
More granular explanation of what Flowroute is requesting.
What benefit fulfilling this recommendation will have for the user.
Whether or not the recommendation has been acknowledged by the user.
The user that resolved the recommendation.
Contains fields related to the status of a Port Order and what tasks remain to be completed.
Whether or not the Port Order requires user involvement to move forward.
blockersarray containing hashes
Contains fields related to issues that are preventing the Port Order from moving forward. These require user intervention in order to resolve.
DateTime on which something first began.
High level explanation of what the blocker is.
More granular explanation of what the blocker is.
blocked_fieldsarray containing strings
Which fields or sections of the Port Order need to be updated in order to resolve the blocker.
Which state the Port Order is currently in.
statesarray of hashes
Contains fields related to the different states that the Port Order needs to go through in order to reach completion.
Defines the order in which each state must be completed.
Whether or not all tasks in the state have been completed.
tasksarray containing hashes
Contains fields related to tasks that must be completed in order to move onto the next state.
Defines the order in which each task must be completed.