---
title: "Search orders"
method: GET
path: "/v1/Orders"
tags: ["Orders"]
---

# Search orders

`GET /v1/Orders`

Search for one or more orders.

## Query parameters

- `search.order_id` integer[]
- `search.customer_id` integer[]
- `search.status` string[]
- `search.order_type` string[]
- `search.pon` string[]
- `search.assigned_to` integer[]
- `search.request_id` integer[]
- `search.created_by` integer[]
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.status_date_start` string, date-time
- `search.status_date_end` string, date-time
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsOrder
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsOrder[] — List of records returned.
    - `order_id` integer — Primary identifier for this order.
    - `pon` string — Purchase Order Number.
    - `customer_id` integer — Foreign identifier indicating the account this is for.
    - `order_type` 'NOT_SPECIFIED' | 'ADD_LINE' | 'CHANGE_FEATURE' | 'CHANGE_LISTING' | 'CHANGE_TN' | 'CONVERSION' | 'DENY' | 'DISCONNECT' | 'LD_BLOCK' | 'LD_RESTORE' | 'MIGRATION' | 'MIGRATION_UNEL' | 'NEW' | 'PORT' | 'REFRESH' | 'RESTORE' | 'SUSPEND' | 'TRANSFER' | 'CNAM' | 'E911' | 'FIBER_CONVERSION' — Indicates the kind of order this is.
    - `status` 'NOT_SPECIFIED' | 'NEW' | 'SENT' | 'ERROR' | 'CONFIRMED' | 'COMPLETE' | 'CANCELED' | 'HOLD' | 'FLOW_ERROR' | 'PAYMENT_HOLD' | 'LIFELINE_HOLD' | 'JEOPARDY' | 'PROVISIONED' — High level perspective of where the order is in work flow.
    - `provider_id` integer — Foreign identifier indicating the underlying provider of service.
    - `assigned_to` integer — Foreign identifier indicating a user to which this order is assigned.
    - `request_id` integer — Foreign identifier indicating origination from a request.
    - `process_id` integer — Foriegn identifier indicating the process to follow for this order.
    - `created_date` string, date-time — Date and time this order was created.
    - `created_by` integer — Foreign identifier indicating the user who created the order.
    - `completed_date` string, date-time — Date and time this order entered COMPLETE status.
    - `due_date` string, date-time — Date and time this order is due.
    - `status_date` string, date-time — Date and time this order updated status.
    - `order_group_id` integer — Foriegn identifier indicating the group of orders this order is in.
    - `hold_reason_id` integer — Foriegn identifier linking back to the hold reason.
    - `retain_listing` boolean — Indicates if this order will retain listing.
    - `process_phase_id` integer — Foreign identifier indicating which phase of the current process this order is in.
    - `flow_through` boolean — Indicates if this order is attempting to automatically send (flow-through) to the provider in a background process once all requirements are met (including, but not limited to, provider send support).
    - `latest_send_response` string — The latest response of an attempt to send an order to the provider.
    - `fields` RevAppModelsFieldValue[] — List of custom fields and their values.
      - `field_id` integer — Primary identifier for this custom field.
      - `label` string — User-defined identifier representing the custom field.
      - `value` string — Value of the custom field.
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)