Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Product

Products.update

Modifies Product or Products with given id(s)

patch/entities/Products/{id}

Path parameters

idstring uuid required

ID of Product to update

Query parameters

validation-levelinteger

Specify validation level of Product on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

allowed_pipelines1 | 2

Whether this product can be added to all pipelines or only the explicitly linked subset (see product_pipeline_relations).

Integer enum value: 1 - All, 2 - Selected

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list applied to this product.

descriptionstring

Free-form description of the product.

namestring

Name of the product, shown in catalogues and pickers.

picture_idstring uuid

Id of the product picture document.

product_category_idstring uuid

Id of the product category.

product_type_idstring uuid

Id of the product type.

skustring

Stock-keeping unit (SKU) identifier of the product. Must be unique across products.

unit_symbolstring

Unit of measure shown next to product quantities (e.g. pcs, kg, hours).

revisioninteger

Revision when entity was lastly changed.

picture_source_urlstring

Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!!

Example request

{
  "allowed_pipelines": 1,
  "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
  "description": "string",
  "name": "string",
  "picture_id": "01234567-abcd-dcba-ffff-000000000000",
  "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
  "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "sku": "string",
  "unit_symbol": "string",
  "revision": 1,
  "product_pipelines": {
    "allowed_pipelines": 1
  },
  "picture_source_url": "string"
}

Response

Modification confirmation. Returns resulting Product

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "allowed_pipelines": 1,
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "description": "string",
    "name": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "sku": "string",
    "unit_symbol": "string",
    "revision": 1,
    "product_pipelines": {
      "allowed_pipelines": 1
    },
    "formatted_name": "string",
    "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}