Update Product

This endpoint updates an existing product. Only provided fields are updated (partial update).

Important Notes

  • Internal pricing and commission fields cannot be updated through the public API. Sending them is not an error; they are ignored.
  • Use the activate and deactivate endpoints to change active.

Errors Dictionary

StatusErrorDetailDescription
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks products:write scope.
404not_foundproductProduct not found, or it belongs to another company.
422cross_companyproduct_category_idCategory does not belong to the company.
422cross_companyproduct_brand_idBrand does not belong to the company.
422cross_companyproduct_display_idDisplay does not belong to the company.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Product unique identifier.

Body Params

Fields accepted when updating a product. Every field is optional; only the fields present in the request are changed. Internal pricing and commission fields cannot be updated through the public API.

string

Product name.

string | null

Product description.

string | null

Stock keeping unit code.

string

Sale price as a decimal string. Must not be negative.

int64 | null

Category ID. Must belong to the same company.

int64 | null

Brand ID. Must belong to the same company.

int64 | null

Display ID. Must belong to the same company.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json