Patch Product Uuid By Uuid

Update/create a product

PATCH/api/rest/v1/products-uuid/{uuid}

Use it in a workflow

Add a step and choose the Akeneo connector.
Pick the Patch Product Uuid By Uuid action (under Product [uuid]).
Fill in the fields below, then reference the result from later steps as {{patchProductUuidByUuid.response.data}}.

Request

Path parameters

uuidstring (uuid)required

This path parameter is used to specify the unique identifier of the entity you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the UUID is correctly formatted and corresponds to an existing entity in the system.

Query parameters

create_missing_optionsstring

When present in the query string (regardless of value), automatically creates missing attribute options during product/product model creation or update. This only works for simple select and multi select attributes that have the `enable_option_creation_during_import` property set to `true` (configurable via the Attribute API).

update_parent_valuesboolean

When set to `true`, allows updating attribute values on the parent product models when patching a variant product. By default, only values owned by the variant product level can be updated.

Default false

Request body

Enter the body as JSON in the step's Body field.

uuidstring

Product UUID

enabledboolean

Whether the product is enabled

Default true

familystring | null

[Family](https://api.akeneo.com/api-reference.html#Family) code from which the product inherits its attributes and attributes requirements. In the case of variant product, the given family should be the same as the product model family.

Default "null only in the case of a non variant product"

categoriesarray<string>

Codes of the [categories](https://api.akeneo.com/api-reference.html#Category) in which the product is classified

Default []

add_categoriesarray<string>

Codes of the [categories](https://api.akeneo.com/api-reference.html#Category) to add to the product. Existing categories will be preserved.

Default []

remove_categoriesarray<string>

Codes of the [categories](https://api.akeneo.com/api-reference.html#Category) to remove from the product. Other categories will be preserved.d

Default []

groupsarray<string>

Codes of the groups to which the product belong

Default []

parentstring | null

Code of the parent [product model](https://api.akeneo.com/api-reference.html#Productmodel) when the product is a variant

Default null

valuesobject

Product attributes values. Each key is an attribute code, and the value is an array of value objects for that attribute. See [documentation](https://api.akeneo.com/concepts/products.html#focus-on-the-product-values) for details.

associationsobject

Several associations related to groups, product models and/or other products, grouped by association types

quantified_associationsobject

Several quantified associations related to products and/or product models, grouped by quantified association types

createdstring (date-time)

Date of creation

updatedstring (date-time)

Date of the last update

metadataobject

More information around the product

workflow_statusstring

Status of the product regarding the user permissions

One ofread_onlydraft_in_progressproposal_waiting_for_approvalworking_copy

quality_scoresarray<object>

Product quality scores for each channel/locale combination (only available when the `with_quality_scores` query parameter is set to `true`).

scopestring

Channel code for which the quality score is calculated

localestring

Locale code for which the quality score is calculated

datastring

Quality score value for the given channel/locale combination

One ofABCDE

completenessesarray<object>

Product completenesses for each channel/locale combination (only available when the `with_completenesses` query parameter is set to `true`).

scopestring

Channel code for which the completenesses score is calculated

localestring

Channel code for which the completenesses score is calculated

datainteger

Completenesses score value for the given channel/locale combination

workflow_execution_statusesarray<object>

Workflow execution statuses of the product (only available when the `with_workflow_execution_statuses` query parameter is set to `true`)

uuidstring

Workflow execution UUID

statusstring

Status of the workflow execution

One ofin_progresscompleted

started_atstring (date-time)

Date and time when the workflow execution was started

completed_atstring | null

Date and time when the workflow execution was completed, null if still in progress

workflowobject3 fields

Workflow associated with the workflow execution

tasksarray<object>4 fields

Tasks associated with the workflow execution

json

{
  "uuid": "fc24e6c3-933c-4a93-8a81-e5c703d134d5",
  "enabled": true,
  "family": "smartphone",
  "categories": [
    "smartphones",
    "electronics"
  ],
  "add_categories": [
    "clothing",
    "shoes"
  ],
  "remove_categories": [
    "shirts",
    "trousers"
  ],
  "groups": [
    "summer_collection",
    "sale"
  ],
  "parent": "my_super_battery",
  "values": {
    "description": [
      {
        "data": "T-shirt long sleeves Winter special, 100% wool",
        "locale": null,
        "scope": null
      }
    ]
  },
  "associations": {
    "X_SELL": {
      "groups": [],
      "products": [
        "product_1",
        "product_2"
      ],
      "product_models": [
        "product_model_1"
      ]
    },
    "UPSELL": {
      "groups": [
        "group_1"
      ],
      "products": [],
      "product_models": []
    }
  },
  "quantified_associations": {
    "PACK": {
      "products": [
        {
          "uuid": "fc24e6c3-933c-4a93-8a81-e5c703d134d5",
          "quantity": 2
        },
        {
          "uuid": "aaf518b2-f91e-40f1-a53a-78ce5e81a6f9",
          "quantity": 3
        }
      ],
      "product_models": [
        {
          "identifier": "product_model_1",
          "quantity": 1
        }
      ]
    }
  },
  "created": "2022-03-14T15:25:45+00:00"
}

Response

Returns 201 with a any. Read it in later steps with {{patchProductUuidByUuid.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.

Was this page helpful?