Searching for Port Orders

You can search for the port orders associated with your account using a range of criteria to help you find the information you're looking for.

Method

Body Parameters

• numbers

  array

  Return all Port Orders that contain any of the numbers specified.

• completion_date

  string

  Return all Port Orders with the specified completion date.

• status

  string

  Return all Port Orders with the specified status.

• alias

  string

  Return all Port Orders whose alias matches the specified string.

• modified_after

  string

  Return all Port Orders that have been modified since the specified date.

• modified_before

  string

  Return all Port Orders that contain any of the numbers specified.

• created_after

  string

  Return all Port Orders that were modified before the date specified.

• created_before

  string

  Return all Port Orders that were created since the specified date.

• completed_after

  string

  Return all Port Orders that were completed since the specified date.

• completed_before

  string

  Return all Port Orders that were completed before the specified date.

• completed_before

  string

  You can order by one or more of the following fields: Status, group_status, completion_date, numbers, alias, and modified_date.

• limit

  integer

  Limits the number of items to retrieve. A maximum of 200 items can be retrieved with 10 being the default value if not specified.

• offset

  integer

  Offsets the list of requests by your specified value. For example, if you have 4 requests and you entered 1 as your offset value, then only 3 of your requests will be displayed in the response.

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 ID.

							200 OK

{
  "data": {
    "attributes": {
      "orders": {
        "data": [
          "attributes": {
            "alias": "My Order",
            "id": "42323",
            "status": "pending",
           ...
          },
       ],
   },
   "type": "portorder_list"
  }
}