KashierDevelopersKashier Developers
API reference and playgroundProducts

Export products

curl -X GET "https://test-api.kashier.io/v2/products/export"
"string"

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.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Query Parameters

ids?string

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

categoryIds?string

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

withVariants?boolean

Include each product's variants.

q?string

Free-text search across product names.

status?string

Filter by stock status.

Value in

  • "outOfStock"
  • "available"
  • "all"
isShippable?boolean

Only export products that are shippable.

currency?string

Only export products priced in this currency.

sortBy?string

Field to sort by, for example creationDate.

sortType?integer

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

Value in

  • 1
  • -1

Response Body

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

application/json

application/json

application/json

application/json

GET
/v2/products/export

Replace the categories on products PUT

Replaces the full category set on the given products with categoryIds, rather than adding to it. Use this when your ERP is the source of truth and you want Kashier to match it exactly.

Export products asynchronously GET

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 yo…