Create Product

This endpoint creates a new product in the company catalog.

Important Notes

  • name and price are required.
  • New products are created active, with stock 0 at every company location. Use the AgendaPro app to set initial stock.
  • Internal pricing and commission fields cannot be set through the public API; they take their upstream defaults.
  • product_category_id, product_brand_id and product_display_id must belong to the same company, otherwise the request fails.

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.
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…
Body Params

Fields accepted when creating a product. Internal pricing and commission fields cannot be set through the public API.

string
required

Product name.

string | null

Product description.

string | null

Stock keeping unit code.

string
required

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