You are here: Developers > OpenX Platform API > Platform API reference > order object

order object

The order object provides calls to manage direct demand for ad space. Depending on your OpenX configuration, use it to manage demand for third-party networks or exchanges. It has the following calls:

Call Description
DELETE /order Delete the specified order.
DELETE /order/order_UID Delete the specified order.
GET /order List all orders.
GET /order/available_fields List the available fields to create or update an order.
GET /order/order_UID Read the specified order.
GET /order/order_UID/list_conversion_tags List conversion tagsA small piece of code that tracks how users respond to the ads that serve for the orders they are associated with. for the specified order.
GET /order/order_UID/list_line_items List line items for the specified order.
GET /order/performance/order_UID Get the performance metrics for the specified order within an (optional) date range.

Parameters

  • start_date

    • A specific date in yyyy-mm-dd HH:MM:SS format

      OR

    • An integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

  • end_date

    • A specific date in yyyy-mm-dd HH:MM:SS format

      OR

    • A negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

GET /order/order_UID/traffic_information List traffic information for the specified order.
POST /order Create one or more orders.
POST /order/order_UID/clone Clone the specified order.
POST /order/order_UID/create_lineitem_from_package/package_UID Create a line itemThe primary unit of execution for an order, which represents a specific inventory purchase and the required conditions for ad delivery. from the specified packageA bundle of targeting criteria for similar inventory segments which you can offer at a predetermined price (typically to facilitate regular sales efforts) and automatically create line items from in OpenX. UID under the specified order UID.
POST /order/order_UID/recycle Restart the specified order.
POST /order/order_UID/stop Stop the specified order and its line items and ads.
PUT /order Update the specified orders.
PUT /order/order_UID Update the specified order.

See also

Creating an order.

Feedback form