Update/create a product

PATCH

/api/rest/v1/products/{code}

Product

This endpoint allows you to update a given product. Learn more about Update behavior. Note that if no product exists for the given identifier, it creates it. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to update. It may result in the creation of a draft if you only have edit rights through the product's categories.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/rest/v1/products/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "associations": {
        "PACK": {
            "groups": [],
            "product_models": [],
            "products": [
                "sunglass"
            ]
        }
    },
    "categories": [
        "summer_collection"
    ],
    "completenesses": [
        {
            "data": 10,
            "locale": "en_US",
            "scope": "ecommerce"
        },
        {
            "data": 20,
            "locale": "fr_FR",
            "scope": "ecommerce"
        },
        {
            "data": 30,
            "locale": "en_US",
            "scope": "tablet"
        },
        {
            "data": 40,
            "locale": "fr_FR",
            "scope": "tablet"
        }
    ],
    "created": "2022-09-02T07:53:54.206Z",
    "enabled": true,
    "family": "tshirt",
    "groups": [],
    "identifier": "top",
    "parent": null,
    "quality_scores": [
        {
            "data": "A",
            "locale": "en_US",
            "scope": "ecommerce"
        },
        {
            "data": "B",
            "locale": "fr_FR",
            "scope": "ecommerce"
        },
        {
            "data": "D",
            "locale": "en_US",
            "scope": "tablet"
        },
        {
            "data": "E",
            "locale": "fr_FR",
            "scope": "tablet"
        }
    ],
    "quantified_associations": {
        "PRODUCT_SET": {
            "product_models": [
                {
                    "identifier": "model-biker-jacket-leather",
                    "quantity": 2
                }
            ],
            "products": [
                {
                    "identifier": "cap",
                    "quantity": 2
                },
                {
                    "identifier": "shoes",
                    "quantity": 1
                }
            ]
        }
    },
    "updated": "2022-09-02T07:53:54.206Z",
    "values": {
        "collection": [
            {
                "data": [
                    "winter_2016"
                ],
                "linked_data": {
                    "winter_2016": {
                        "attribute": "collection",
                        "code": "winter_2016",
                        "labels": {
                            "en_US": "Winter 2016",
                            "fr_FR": "Hiver 2016"
                        }
                    }
                },
                "locale": null,
                "scope": null
            }
        ],
        "color": [
            {
                "data": "black",
                "linked_data": {
                    "attribute": "color",
                    "code": "black",
                    "labels": {
                        "en_US": "Black",
                        "fr_FR": "Noir"
                    }
                },
                "locale": null,
                "scope": null
            }
        ],
        "description": [
            {
                "data": "Summer top",
                "locale": "en_US",
                "scope": "ecommerce"
            },
            {
                "data": "Top",
                "locale": "en_US",
                "scope": "tablet"
            },
            {
                "data": "Débardeur pour l'\''été",
                "locale": "fr_FR",
                "scope": "ecommerce"
            },
            {
                "data": "Débardeur",
                "locale": "fr_FR",
                "scope": "tablet"
            }
        ],
        "name": [
            {
                "data": "Top",
                "locale": "en_US",
                "scope": null
            },
            {
                "data": "Débardeur",
                "locale": "fr_FR",
                "scope": null
            }
        ],
        "price": [
            {
                "data": [
                    {
                        "amount": "15.5",
                        "currency": "EUR"
                    },
                    {
                        "amount": "15",
                        "currency": "USD"
                    }
                ],
                "locale": null,
                "scope": null
            }
        ],
        "size": [
            {
                "data": "m",
                "linked_data": {
                    "attribute": "size",
                    "code": "m",
                    "labels": {
                        "en_US": "M",
                        "fr_FR": "M"
                    }
                },
                "locale": null,
                "scope": null
            }
        ]
    }
}'

Response Example

201 - Example 1

{}

Request

Path Params

code

string

required

Code of the resource

Body Params application/json

associations

object

optional

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

associationTypeCode

object

optional

Responses

🟢201Created

application/json

Body

object {0}

🟢204No content to return

🟠401Authentication required

🟠403Access forbidden

🟠415Unsupported Media type

🟠422Unprocessable entity

Modified at 2022-09-02 07:53:57

Get a product

Get a draft