Export Inventory Change Logs

Beta

GET/v1/operations/inventory-change-logs/actions/export

This endpoint is idempotent. Learn more

Exports inventory change logs matching the provided filters as an Excel file.

Unlike the list endpoint, results are not paginated — every matching change log is included in the download, newest first. The download is named for the date range you requested, using all in place of a bound you left open.

This endpoint is deprecated: the file is built inside the request, so a wide window on a busy account can outlast the request timeout. Use POST /v1/operations/inventory-change-logs/actions/export instead, which builds the same file in the background and returns a job to poll.

Permission requiredValues:inventory_logs:read

The role behind your API key or agent must grant this permission.

item_ids[]optional array

Restricts results to changes affecting these items.

action_types[]optional arrayenumValues:scanuser_actionsystem_action

Restricts results to these action types.

changed_by_user_ids[]optional array

Restricts results to changes made by these users.

Changes that were recorded without a responsible user are excluded whenever this filter is set.

starts_atoptional string (date-time)

Restricts results to change logs created on or after this timestamp.

ends_atoptional string (date-time)

Restricts results to change logs created on or before this timestamp.

Responses

200

Successful response for Export Inventory Change Logs

Export Inventory Change Logs

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const fileDownload = await client.operations.inventoryChangeLogs.actions.export();

console.log(fileDownload);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const fileDownload = await client.operations.inventoryChangeLogs.actions.export();

console.log(fileDownload);

200 example

{
  "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "filename": "export.xlsx"
}

{
  "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "filename": "export.xlsx"
}

Export Inventory Change Logs

Authorization

Query Parameters

Responses