v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Products

Add

This endpoint allows you to create products. You can specify details such as category, name, price, currency, VAT type, and additional product information. The product will be added to your catalog and can be used in transactions, recurring payments, Invoice+, etc.

post/Products/Add

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Request body

category_uidsstring[]

Array of strings, each string is a different category_uid. This allows you to assign your product to multiple categories. If not set, the product will be assigned to system's default category.

namestring required

Product name. This is a required field and should be unique for each product for better identification.

validboolean

Sets if the product is valid or not. If set to false, the product will not be available accross the system.

priceinteger required

Sell price

currency_code'ILS' | 'USD' | 'EUR' | 'GPB' required

vat_type0 | 1 | 2 required

0 - VAT Included 1 - VAT Not Included 2 - VAT Exempt

barcodestring

Barcode of the product. This is an optional field, but it can be used to identify the product in a more convenient way.

valuestring

Cost price

descriptionstring

Product description, can be used for additional information about the product.

fixed_amount_discountinteger

Fixed amount discount for the product. This is a discount that will be applied to the product price.

percentage_discountinteger

Percentage discount for the product. This is a discount that will be applied to the product price as a percentage.

guide_document_urlstring

Mostly used for invoies to send manual docmentation of a product when customer buying product

Response

200

object required