FEfeverup
Order Items

Request order items report

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

post/reports/order-items/search

Request

Headers

user-id-to-impersonateinteger

User id from the user that you want to impersonate

Request body

order_idsinteger[]

List of ids of the orders to filter by.

plan_idsinteger[]

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_fromstring

Start date for the selected date field. If hour and minute are not specified, 00:00 is added by default

date_tostring

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'

Example request

{
  "date_field": "CREATED_DATE_UTC",
  "date_from": "2024-12-18 00:00",
  "date_to": "2024-12-19 00:00"
}

Response

Request was created successfully but is still running asynchronously.

messagestring required

Message about the search status

search_idstring uuid required

The search ID

Example response

{
  "message": "Asynchronous execution in progress. Use provided query id to perform query monitoring and management.",
  "search_id": "b59d4093-cbfc-4a1d-be5c-ba78d4ffbc64"
}

Changes

No recorded changes to this operation across all 1 revision of this API.