KashierDevelopersKashier Developers
API reference and playgroundProducts

Export products asynchronously

curl -X GET "https://test-api.kashier.io/v2/products/export-async"
{  "data": {    "taskId": "string",    "status": "string",    "email": "string"  }}

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.

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.

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"
currency?string

Only export products priced in this currency.

email?string

Email address the finished export is sent to.

sortBy?string

Field to sort by, for example creationDate.

sortType?integer

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

Value in

  • 1
  • -1

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/products/export-async

Export products GET

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

Upload a product image POST

Uploads an image and returns the hosted URL for it. Upload the file first, then pass the returned URL as the product's image when you create or update it. Files must be under 5 MB.