Line Items settings
- A line item holds promoted products to advertise on any single retailer
- Line items have basic settings such as start & end dates, optional budget settings & associated retailers on which ads are served
- Budgets may additionally be controlled at the campaign level
- Several reports are available to measure line item performance
- Campaigns are limited to 10,000 non-archived line items
- Line items are archived automatically 90 days after its end date
Endpoints
GET /accounts/{accountId}/line-items
Get All Line ItemsGET /line-items/{lineItemId}
Get a Specific Line Item
Line Item Attributes
Attribute | Description | Values | Required | Default | Write | Nullable |
---|---|---|---|---|---|---|
| Line item ID | int64 | ||||
| Campaign type |
| Required | |||
| Campaign ID | int64 | R | |||
| Line item name; must be unique within a campaign | 255 char limit | R | Write | ||
| ID of the retailer the line item serves on | int64 | R | |||
| Line item start date in the account | YYYY-MM-DD | R | W | ||
| Line item end date in the account | YYYY-MM-DD | Optional |
| W | Yes |
| Line item lifetime spend cap; uncapped if omitted or set to | at least 0 | O | |||
| Amount the line item has already spent | at least 0 |
| |||
| Amount the line item has remaining until cap is hit; | between 0 and |
| Yes | ||
| Line item status; can only be updated by a user to |
| W | |||
| Timestamp in UTC of line item creation | ISO-8601 | ||||
| Timestamp in UTC of last line item update | ISO-8601 |
Get All Line Items
This endpoint lists all line items in the specified campaign. Results are paginated.

https://api.criteo.com/2022-04/retail-media/accounts/{accountId}/line-items
Sample Request
curl -X GET "https://api.criteo.com/2022-04/retail-media/accounts/123456/line-items" \
-H "Authorization: Bearer myaccesstoken"
Sample Response
{
"data": [
{
"type": "RetailMediaLineItem",
"id": "9979917896105882144",
"attributes": {
"campaignId": "8343086999167541140",
"name": "Line Item 123",
"targetRetailerId": "3239117063738827231",
"startDate": "2020-04-06",
"endDate": null,
"budget": null,
"budgetSpent": 2383.87,
"budgetRemaining": null,
"status": "active",
"createdAt": "2020-04-06T17:29:11+00:00",
"updatedAt": "2020-04-06T17:29:11+00:00"
}
},
// ...
{
"type": "RetailMediaLineItem",
"id": "6854840188706902009",
"attributes": {
"campaignId": "8343086999167541140",
"name": "Line Item 789",
"targetRetailerId": "18159942378514859684",
"startDate": "2020-04-08",
"endDate": null,
"budget": 8000.00,
"budgetSpent": 1921.23,
"budgetRemaining": 6078.77,
"status": "paused",
"createdAt": "2020-04-06T23:42:47+00:00",
"updatedAt": "2020-06-03T03:01:52+00:00"
}
}
],
"metadata": {
"totalItemsAcrossAllPages": 105,
"currentPageSize": 25,
"currentPageIndex": 0,
"totalPages": 5,
"nextPage": "https://api.criteo.com/2022-04/retail-media/accounts/123456/line-items?pageIndex=1&pageSize=25",
"previousPage": null
}
}
Get a Specific Line Item
This endpoint retrieves the specified line item

https://api.criteo.com/2022-04/retail-media/line-items/{lineItemId}
Sample Request
curl -X GET "https://api.criteo.com/2022-04/retail-media/line-item/2465695028166499188" \
-H "Authorization: Bearer myaccesstoken"
Sample Response
{
"data": {
"type": "RetailMediaLineItem",
"id": "2465695028166499188",
"attributes": {
"campaignId": "8343086999167541140",
"name": "My New Line Item",
"targetRetailerId": "18159942378514859684",
"startDate": "2020-04-06",
"endDate": null,
"budget": null,
"budgetSpent": 0.00,
"budgetRemaining": null,
"status": "draft",
"createdAt": "2020-04-06T06:11:23+00:00",
"updatedAt": "2020-04-06T06:11:23+00:00"
}
}
}
Updated about 1 month ago