GET /reports/orders/download

This report returns all the data for the internal orders that match the query criteria. It generates a JSON file that can be downloaded from the response url.

Parameters

All query parameters are optional.

• sender: id of area or division (location) that sent the order/return
• division: id of division (location) that received the order
• from: Timestamp representing the minimum age of the inspections queried. To fetch all inspections that have been created before today, from can be set to the timestamp of 00:00 of today. The server is set to UTC.
• to: Timestamp representing the maximum age of the inspections queried. To fetch all new inspections that have been created since yesterday, to can be set to the timestamp of 00:00 of today. The server is set to UTC.
• status: order status to filter for - no default, will load all if not specified
• type: order type to filter for - one of "ORDER" or "RETURN"
• group_by: Defines how the items in the report should be grouped. One of "category" or "account_code".
• lang: The language of the report excel. One of "en" or "de".
• timezone_offset: the local time zone offset for the client. In order to have the dates and times shown in the downloaded report correctly, this should be sent. Otherwise it defaults to 0 and represents all dates and times in UTC.

Status codes

• 200 on success

Response properties

The response is a download url for the generated xlsx report.

• url: The URL where the report can be accessed.

Example response:

{
  "url": "https://s3.eu-central-1.amazonaws.com/exports.yourbarmate.com/c6a61b00-178f-4604-a51b-927cb9b4e302/order-report-1730205514020.xlsx"
}

The report is generated fresh every time you request it.