v1

latestOpenAPI 3.1.02026-07-241210356.3 KB
Products

Update

update Product

post/Products/Update/{uid}

Path parameters

uidstring required

Product unique identifier.

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, no changes will be made.

namestring required

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

validboolean
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.

Response

200

object required