---
title: "Request order items report"
method: POST
path: "/reports/order-items/search"
tags: ["Order Items"]
---

# Request order items report

`POST /reports/order-items/search`

## Request

- Base URL: `https://data-reporting-api.prod.feverup.com/v1`
- URL: `https://data-reporting-api.prod.feverup.com/v1/reports/order-items/search`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth/token`
- TypeScript: <https://skmtc.dev/feverup/apis/fever-reporting-api/docs/reports/order-items/search/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a request to get a new order items report within the given time range.The search will be processed asynchronously, being able to fetch the result from the provided search ID

## Headers

- `user-id-to-impersonate` integer: User id from the user that you want to impersonate

## Request body

- OrderItemParams
  - `order_ids` integer[]: List of ids of the orders to filter by.
  - `plan_ids` integer[]: List of ids of the plans to filter by.
  - `date_field` 'CREATED_DATE_UTC' | 'UPDATED_DATE_UTC' | 'EVENT_START_DATE_UTC': Date field to filter the search. `EVENT_START_DATE_UTC` filters on `order_items[].event_start_date_utc`, so a window on an activity's date also returns the shop products that inherit it
  - `date_from` string: Start date for the selected date field. If hour and minute are not specified, 00:00 is added by default
  - `date_to` string: End date for the selected date field. If hour and minute are not specified, 00:00 is added by default
  - `include_merch_sales` 'TRUE' | 'FALSE' | 'DEFAULT'

## Response `202`

Request was created successfully but is still running asynchronously.

- SearchStatus
  - `message` string, required: Message about the search status
  - `search_id` string, uuid, required: The search ID

## Other responses

- `408`: Request Timeout
- `422`: Validation Error
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/feverup/apis/fever-reporting-api.md) - [All operations](https://skmtc.dev/feverup/apis/fever-reporting-api/llms.txt) - [OpenAPI document](https://skmtc.dev/feverup/apis/fever-reporting-api/revisions/a2e1afe5c12d?raw)