Products

Export products asynchronously

Exports the products matching the given filters without holding the request open. The workbook is generated in the background and emailed to email — or to the merchant account's own address when you leave it out — so the response only acknowledges the task.

get/v2/products/export-async

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/products/export-async
  • Auth: API key in header Authorization

Query parameters

idsstring

Comma-separated product record ids, to export a specific set of products.

withVariantsboolean

Include each product's variants.

qstring

Free-text search across product names.

status'outOfStock' | 'available' | 'all'

Filter by stock status.

currencystring

Only export products priced in this currency.

emailstring

Email address the finished export is sent to.

sortBystring

Field to sort by, for example creationDate.

sortType1 | -1

Sorting direction: 1 = ascending, -1 = descending.

Response

Export accepted for processing — an email with the export follows shortly.

Changes

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