Post Product

Create a new product

POST/api/rest/v1/products

Use it in a workflow

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

Request

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).

Request body

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

uuidstring

Product UUID

identifierstringrequired

Product identifier, i.e. the value of the only `pim_catalog_identifier` attribute

enabledboolean

Whether the product is enabled

Default true

groupsarray<string>

Codes of the groups to which the product belong

Default []

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 []

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

json

{
  "identifier": "bl1850b",
  "uuid": "fc24e6c3-933c-4a93-8a81-e5c703d134d5",
  "enabled": true,
  "groups": [
    "summer_collection",
    "sale"
  ],
  "family": "smartphone",
  "categories": [
    "smartphones",
    "electronics"
  ],
  "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": [
        {
          "identifier": "product_1",
          "quantity": 2
        },
        {
          "identifier": "product_2",
          "quantity": 3
        }
      ],
      "product_models": [
        {
          "identifier": "product_model_1",
          "quantity": 1
        }
      ]
    }
  }
}

Response

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

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

Was this page helpful?