Products

List products

Retrieves the merchant's products. Every filter is optional — call it with no query at all to page through the whole catalogue, or narrow it down by category, stock status, currency, or a free-text search. This is the read an ERP uses to reconcile its own catalogue against Kashier's.

get/v2/products

Request

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

Query parameters

idsstring

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

categoryIdsstring

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

withVariantsboolean

Include each product's variants in the response. Defaults to false.

quantityboolean

Only return products that track a stock quantity.

qstring

Free-text search across product names.

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

Filter by stock status. Defaults to all.

isShippableboolean

Only return products that are shippable.

isVariantboolean

Only return products that are variants of another product.

currency'EGP' | 'USD' | 'EUR' | 'GBP'

Only return products priced in this currency. Defaults to EGP.

pageinteger

Current page number. Defaults to 1.

limitinteger

Number of records per page. Defaults to 20.

sortBystring

Field to sort by, for example creationDate.

sortType1 | -1

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

Response

The products matching the filters, with pagination info.

Changes

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