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

lineitem object

The lineitem object provides line itemThe primary unit of execution for an order, which represents a specific inventory purchase and the required conditions for ad delivery. details associated with orders, such as pricing, goals, and targeting. It has the following calls:

Call Description
DELETE /lineitem Delete the specified line items.
DELETE /lineitem/line_item_UID Delete the specified line item.
GET /lineitem List all line items.
GET /lineitem/available_fieldstype_full=lineitem.type List the available fields to create or update a line item of the specified type (such as lineitem.exchange).
GET /lineitem/get_passback_tag Return pass back tags for defaulting line items.
GET /lineitem/line_item_UID Read the specified line item.
GET /lineitem/line_item_UID/list_ads List ads for the specified line item.
GET /lineitem/lineitems_dashboard_widget List data for the UI line item report on the dashboard.
GET /lineitem/performance/line_item_UID Get the performance metrics for the specified line item within the (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 /lineitem/traffic_information List traffic data for the specified line items. Use POST to avoid any URL length issues.
POST /lineitem Create a line item.
POST /lineitem/line_item_UID/clone Clone the specified line item.
POST /lineitem/line_item_UID/recycle Restart the specified line item.
POST /lineitem/line_item_UID/stop Stop the specified line item and its ads.
POST /lineitem/traffic_information List traffic data for the specified line items.
PUT /lineitem Update the specified line items.
PUT /lineitem/line_item_UID Update the specified line item.

See also

Creating a line item.

Feedback form