KashierDevelopersKashier Developers
API reference and playgroundProducts

List products

curl -X GET "https://test-api.kashier.io/v2/products"
{  "data": [    {      "_id": "string",      "merchantId": "string",      "name": "string",      "sku": "string",      "price": 0,      "currency": "string",      "description": "string",      "image": "string",      "status": "string",      "createdAt": "string",      "updatedAt": "string"    }  ],  "pagination": {    "total": 0,    "page": 0,    "limit": 0,    "pages": 0  }}

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.

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 fetch a specific set of products.

categoryIds?string

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

withVariants?boolean

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

quantity?boolean

Only return products that track a stock quantity.

q?string

Free-text search across product names.

status?string

Filter by stock status. Defaults to all.

Value in

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

Only return products that are shippable.

isVariant?boolean

Only return products that are variants of another product.

currency?string

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

Value in

  • "EGP"
  • "USD"
  • "EUR"
  • "GBP"
page?integer

Current page number. Defaults to 1.

limit?integer

Number of records per page. Defaults to 20.

sortBy?string

Field to sort by, for example creationDate.

sortType?integer

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

Value in

  • 1
  • -1

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/products

Get terminal details GET

Retrieves one terminal on your merchant account, including its branch, status, mode, and card-acceptance limits.

Create a product POST

Adds a single product to the catalogue. Only the name, currency, and unit price are required; set isVariant when the product is a variation of another item, and quantity when you want Kashier to tr…