Skip to main content

requestInventoryExport

Requests an asynchronous inventory export for the current brand.

The export is processed in the background and generates a CSV file with the inventory items and their warehouse locations. Each inventory item produces one row per location, with aggregated quantities repeated. Items without locations are included with empty location fields.

Use the returned process_id to track the export progress.

Authentication​

Requires a logged-in user with access to the company.

Filters​

  • **stock_depth**: Filter by stock depth (FULL_STOCK, LOW_STOCK, OUT_OF_STOCK, OVERSOLD).
  • **include_archived**: Include archived inventory items in the export.

Possible Errors​

  • **You must be logged in**: Authentication is required.
  • **Company is required**: Company context must be provided (use X-Company-Id header).
requestInventoryExport(
  input: RequestInventoryExportInput!
): AsynchronousActionResponse!

Arguments​

requestInventoryExport.input ● RequestInventoryExportInput! non-null input common​

Parameters for RequestInventoryExport

Type​

AsynchronousActionResponse object common​

Asynchronous action response type