Sign in

v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Orders

Replace order

Replace an existing order.

put/v1/Orders/{id}

Path parameters

idinteger required

Format - int32. ID of the order to replace.

Request body

order_idinteger

Primary identifier for this order.

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.

process_idinteger

Foreign identifier indicating the process to follow for this order.

due_datestring date-time

Date the order is due.

effective_datestring date-time

Effective date of the order status change (if changing).

hold_reason_idinteger

Foreign identifier linking back to the hold reason.

retain_listingboolean

Indicates if this order will retain listing.

flow_throughboolean

Indicates if this order will attempt 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).

assigned_tointeger

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

ponstring

Purchase Order Number.

Response

OK

okboolean