Product catalog

Kashier keeps a per-merchant product catalog — products and the categories that organize them — under /v2/products and /v2/category. It's the same catalog used when a payment page or payment link is built from line items instead of a single flat amount, and every stock-affecting change to a product is recorded on an append-only timeline you can inspect after the fact.

Product fields

These fields come from the verified products-and-services-management data model. The exact wire format for a given response isn't independently confirmed on every route below — where that matters, the "Try it" panel is the fastest way to check.

Category fields

List merchant products

Returns the merchant's products.

curl --location 'https://test-api.kashier.io/v2/products/' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 with the merchant's products — individual items follow the Product fields shape above. Query parameters (pagination, search, filters) and the exact list envelope aren't confirmed here — use the "Try it" panel above against a test account to inspect a live response.

Create product

Creates a new product in the merchant's catalog.

Body parameters

See Product fields for the full settable set. productName, currency and isVariant are required by the create schema; unitPrice is required for a non-variant product. A minimal example:

curl --location 'https://test-api.kashier.io/v2/products/' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "productName": "Wireless Mouse",
    "productReference": "SKU-1001",
    "currency": "EGP",
    "unitPrice": 350,
    "quantity": 100,
    "isVariant": false
  }'

Headers

Response

Returns a 201 with the created product, in the Product fields shape — including the system-managed fields (productStatus, merchantId, timestamps, and so on).

Get product details

Fetch a single product by ID.

curl --location 'https://test-api.kashier.io/v2/products/:id' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 with the product in the Product fields shape.

Update product

Update fields on an existing product.

Body parameters

Same settable fields as Create product — see Product fields.

curl --location --request PUT 'https://test-api.kashier.io/v2/products/:id' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "unitPrice": 375,
    "quantity": 80
  }'

Headers

Response

Returns the updated product in the same shape as Get product details.

Get product timeline

Returns the append-only audit/inventory timeline for a single product — every stock created / added / reduced / reserved / purchased / updated event, in order.

curl --location 'https://test-api.kashier.io/v2/products/:id/timeline' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 with a list of timeline entries. Per the underlying schema, each entry carries operation (created | reduced | added | purchased | updated | reserved), numOfUnit (the quantity delta), actionDate, actionBy (userId, email, fullName of who made the change), and — when the event came from a sale — customPurchasedAttributes linking back to the transactionId, orderId, and payment page (ppId) that consumed the stock. The exact envelope (pagination, wrapper key) isn't confirmed here — use the "Try it" panel above against a test account.

Assign categories to product

Adds or removes categories on one or more products, in bulk.

Body parameters

curl --location --request PUT 'https://test-api.kashier.io/v2/products/assign/categories' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "categoryIds": ["507f1f77bcf86cd799439011"],
    "productIds": ["507f1f77bcf86cd799439012"],
    "operation": "assign"
  }'

Headers

Response

Returns a 200. Invalid IDs are rejected with 400 {"message":"Invalid category IDs"}.

Change product categories

A second, related route for managing a product's categories, alongside Assign categories to product.

Body parameters

The same categoryIds and productIds arrays as Assign categories to product, both required — but no operation, which is the one structural difference between the two routes.

curl --location --request PUT 'https://test-api.kashier.io/v2/products/categories/change' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "categoryIds": ["507f1f77bcf86cd799439011"],
    "productIds": ["507f1f77bcf86cd799439012"]
  }'

Headers

Export merchant products

Downloads the merchant's product catalog as a file.

curl --location 'https://test-api.kashier.io/v2/products/export' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --output products.xlsx

Headers

Export merchant products asynchronously

Same export, run as a background job instead of a synchronous download — useful for large catalogs. Rather than returning the file directly, it queues the export and is intended to email a download link once the file is ready.

curl --location 'https://test-api.kashier.io/v2/products/export-async' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 acknowledging the export job was queued. The exact acknowledgment body and delivery mechanism for the finished file aren't confirmed here — use the "Try it" panel above against a test account.

Upload product file

Uploads a file associated with the merchant's catalog (for example, a product image — productImage is stored as an object key and served back via productImageUrl).

curl --location 'https://test-api.kashier.io/v2/products/upload/' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --form 'file=@"/path/to/file"'

Headers

Get all categories

Returns the merchant's product categories.

Query parameters

sortBy is required. It is validated before authentication, so calling the route without it returns 400 {"message":"\"sortBy\" is required"} even with a valid secret key.

curl --location 'https://test-api.kashier.io/v2/category/?sortBy=createdAt&sortType=-1&page=1&limit=20' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 with the merchant's categories — individual items follow the Category fields shape above, alongside pagination. Use the "Try it" panel above against a test account to see the exact list envelope.

Create product category

Creates a new category.

Body parameters

curl --location 'https://test-api.kashier.io/v2/category/' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Electronics"
  }'

Headers

Response

Returns a 201 with the created category, in the Category fields shape — including the system-managed slug (derived from name) and numberOfProducts (starts at 0).

Get category details

Fetch a single category by ID.

curl --location 'https://test-api.kashier.io/v2/category/:id' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 with the category in the Category fields shape.

Update product category

Update a category's name.

Body parameters

curl --location --request PUT 'https://test-api.kashier.io/v2/category/:id' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Electronics & Accessories"
  }'

Headers

Response

Returns the updated category in the same shape as Get category details.

Delete product category

Delete a category.

curl --location --request DELETE 'https://test-api.kashier.io/v2/category/:id' \
  --header 'Authorization: YOUR_TEST_SECRET_KEY'

Headers

Response

Returns a 200 confirming deletion. The exact response body isn't confirmed here — use the "Try it" panel above against a test account.