Update a product

PATCH
/products/:product_id

Path parameters

product_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
descriptionstringOptional<=255 characters

Description of the product.

ledger_account_idstringOptional
measure_unit_idstringOptional

The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms).

namestringOptional>=1 character<=100 characters

Name of the product.

priceobjectOptional
smallest_amountdoubleOptional>=0<=2147483647

The smallest amount allowed for this product.

type"product" or "service"Optional
Allowed values: productservice

Specifies whether this offering is a product or service. This may affect the applicable tax rates.

Response

Successful Response

idstring

Unique ID of the product.

created_atdatetime

Time at which the product was created. Timestamps follow the ISO 8601 standard.

updated_atdatetime

Time at which the product was last updated. Timestamps follow the ISO 8601 standard.

entity_idstring
namestring

Name of the product.

descriptionstringOptional

Description of the product.

entity_user_idstringOptional
ledger_account_idstringOptional
measure_unit_idstringOptional

The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms).

priceobjectOptional
smallest_amountdoubleOptional>=0<=2147483647

The smallest amount allowed for this product.

type"product" or "service"Optional
Allowed values: productservice

Specifies whether this offering is a product or service. This may affect the applicable tax rates.

Errors

Get receivables