Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Orders

View order

Find a single order by ID.

get/v1/Orders/{id}

Path parameters

idinteger required

Format - int32. ID of the order to view.

Response

OK

okboolean
order_idinteger

Primary identifier for this order.

ponstring

Purchase Order Number.

customer_idinteger

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_idinteger

Foreign identifier indicating the underlying provider of service.

assigned_tointeger

Foreign identifier indicating a user to which this order is assigned.

request_idinteger

Foreign identifier indicating origination from a request.

process_idinteger

Foriegn identifier indicating the process to follow for this order.

created_datestring date-time

Date and time this order was created.

created_byinteger

Foreign identifier indicating the user who created the order.

completed_datestring date-time

Date and time this order entered COMPLETE status.

due_datestring date-time

Date and time this order is due.

status_datestring date-time

Date and time this order updated status.

order_group_idinteger

Foriegn identifier indicating the group of orders this order is in.

hold_reason_idinteger

Foriegn identifier linking back to the hold reason.

retain_listingboolean

Indicates if this order will retain listing.

process_phase_idinteger

Foreign identifier indicating which phase of the current process this order is in.

flow_throughboolean

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_responsestring

The latest response of an attempt to send an order to the provider.