« All modules

Products

Nomenclator produse — read, patch, delete, stocks, images.

Filters on list endpoints are URL path segments, not query strings — see Conventions. The Swagger tester works best for JSON body endpoints.
GET /product/list/ List products (product variants)

Returns a paginated list of product variants from the catalogue.

Filters:
- Standard filters (year, page, modifiedafter, ...).
- formatjson (default), xml, csv.
- code — product code or barcode (URL-encoded). Also codeb64:... (base64).
- manufacturer — filter by manufacturer name.
- visibilityall (default), partner, published.
- show_deleted0 or 1.
- magazia_id — workpoint ID for stock context.
- contsellable (default) or all (subgestiune scope).
- product_id — BOCP variant ID.
- fm_id — fișă de magazie ID.
- pricelist_id — filter to only products that have a rule in this pricelist, and return pricelist prices. Requires magazia_id. Price fields in the response depend on the workpoint type: en-gros workpoints return the pricelist price in pret_vanzare / pret_vanzare_cu_tva (discounted fields become null); en-detail workpoints return the normal retail price in pret_vanzare and the pricelist price in pret_vanzare_discounted / pret_vanzare_cu_tva_discounted. Use /pricelists/list/ to enumerate available pricelist IDs.

Include: images, properties, last_aquisition_price_ron, last_purchase_price_currency.

Exclude: deleted, archived.

Responses

StatusDescription
200 OK — response uses the shared envelope.
400 Request is malformed or a required field is missing / invalid.
GET /product/stocks/ List product stocks

Same filter set as /product/list/, but the response focus is on stock levels rather than catalogue metadata.

Include: last_purchase_price_currency, onstock, aquisition_value_ron.

Responses

StatusDescription
200 OK — response uses the shared envelope.
GET /product/{product_id}/ Get product variant details

Returns the full detail record for one product variant.

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Responses

StatusDescription
200 OK — response uses the shared envelope.
404 The requested resource does not exist.
PATCH /product/{product_id}/ Partial update on a product variant

Send only the fields you want to change. Field names match those returned by the GET call. Combined fields (e.g. price + currency) must be sent together.

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Request body (JSON)

See schema in the OpenAPI spec.

Responses

StatusDescription
200 OK — response uses the shared envelope.
400 Request is malformed or a required field is missing / invalid.
404 The requested resource does not exist.
PUT /product/{product_id}/ Replace product variant fields

PUT variant of the product update. Prefer PATCH for partial updates.

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Request body (JSON)

See schema in the OpenAPI spec.

Responses

StatusDescription
200 OK — response uses the shared envelope.
400 Request is malformed or a required field is missing / invalid.
404 The requested resource does not exist.
DELETE /product/{product_id}/ Delete a product variant

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Responses

StatusDescription
200 OK — response uses the shared envelope.
404 The requested resource does not exist.
GET /product/{product_id}/images/ List attached images for a product

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Responses

StatusDescription
200 OK — response uses the shared envelope.
404 The requested resource does not exist.
DELETE /product/{product_id}/images/ Delete ALL images from a product

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Responses

StatusDescription
200 OK — response uses the shared envelope.
404 The requested resource does not exist.
POST /product/{product_id}/image/ Attach an image from an uploaded file

Uploads and attaches a new image to the product. Multipart form-data body.

Fields: file (binary), title, description, alt_text.

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Responses

StatusDescription
200 OK — response uses the shared envelope.
400 Request is malformed or a required field is missing / invalid.
404 The requested resource does not exist.
PUT /product/{product_id}/image/ Attach an image from a URL

Attaches an image to the product from a remote URL. Depending on the catalog setting the URL is either stored as-is or downloaded to the local CDN.

Parameters

NameInTypeRequiredDescription
product_id path integer yes

Request body (JSON)

{
    "URL": "https://example.com/img.jpg",
    "title": "Hero",
    "alt_text": "Product front"
}

Responses

StatusDescription
200 OK — response uses the shared envelope.
400 Request is malformed or a required field is missing / invalid.
POST /product/add/ Create a new product (not implemented yet)

Reserved. This endpoint is documented for planning purposes; it is not implemented in the current release.

Responses

StatusDescription
501 Not implemented.

This page is generated from openapi.json.