Export products

Exports the products matching the given filters and returns the Excel workbook directly in the response. The filters are the same ones listProducts accepts. For a large catalogue use exportProductsAsync instead, which emails the file rather than holding the request open.

get/v2/products/export

Request

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

Query parameters

idsstring

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

categoryIdsstring

Comma-separated category ids — only export products in these categories.

withVariantsboolean

Include each product's variants.

qstring

Free-text search across product names.

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

Filter by stock status.

isShippableboolean

Only export products that are shippable.

currencystring

Only export products priced in this currency.

sortBystring

Field to sort by, for example creationDate.

sortType1 | -1

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

Response

The export as an Excel workbook.

Changes

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