View All Port Orders

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.

This endpoint is designed to allow users to browse through all of their port orders. By default, the endpoint will return all of your port orders sorted by portorder_id in descending order (newest orders first). You may filter this collection based on current_state, alias, and whether or not the port order is blocked.

Endpoint

GET /portorders

Request Parameters

  • limit
    integer

    The number of Port Orders to retrieve per request. You can set as high of a number as you want, but the number must be greater than zero (0).

  • offset
    integer

    The number of Port Orders to skip when performing a query. The number must be greater than zero (0).

  • current_state
    string

    Filters returned Port Orders to those in the specified `state`(s). Multiple states may be specified so long as they are separated by commas. e.g. current_state=new_order,completed

  • alias
    string

    Filters results to Port Orders with the specified alias.

  • blocked
    boolean

    Filters results based on whether or not they are blocked


Example Request

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

            

Example Response

{
  "links": {
    "self": "https://api.flowroute.com/v2/portorders",
    "first": "https://api.flowroute.com/v2/portorders?limit=20&offset=0",
    "last": "https://api.flowroute.com/v2/portorders?limit=20&offset=400",
    "next": "https://api.flowroute.com/v2/portorders?limit=20&offset=20",
    "prev": null
  },
  "data": [
    {
      "links": {
        "self": "https://api.flowroute.com/v2/portorders/899012"
      },
      "type": "portorder",
      "portorder_id": "899012",
      "attributes": {}, "//...JSON condensed for readability...//"
      "relationships": {} "//...JSON condensed for readability...//"
    },
    {
      "links": {
        "self": "https://api.flowroute.com/v2/portorders/899013"
      },
      "type": "portorder",
      "portorder_id": "899013",
      "attributes": {}, "//...JSON condensed for readability...//"
      "relationships": {} "//...JSON condensed for readability...//"
    }
  ],
  "included": [
    {
      "type": "number",
      "portorder_id": "12068843281" "//...JSON condensed for readability...//"
    },
    {
      "type": "number",
      "portorder_id": "12068843283" "//...JSON condensed for readability...//"
    }
  ]
}