Update/create several product models

PATCH

/api/rest/v1/product-models

This endpoint allows you to update and/or create several product models at once. Learn more about Update behavior. Note that if no product models exists for the given code, it creates it. In the Enterprise Edition, since the v2.3, permissions based on your user groups are applied to the product models you try to update. It may result in the creation of drafts if you only have edit rights through the product model's categories.

Request Example

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

curl --location --request PATCH '/api/rest/v1/product-models' \
--header 'Content-Type: application/json' \
--data-raw '{
    "associations": {
        "PACK": {
            "groups": [],
            "product_models": [],
            "products": [
                "sunglass"
            ]
        }
    },
    "categories": [
        "summer_collection"
    ],
    "code": "model-biker-jacket-leather",
    "created": "2023-08-15T05:53:50.712Z",
    "family": "clothing",
    "family_variant": "clothing_material_size",
    "parent": "model-biker-jacket",
    "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": [
                {
                    "code": "model-biker-jacket-leather",
                    "quantity": 2
                }
            ],
            "products": [
                {
                    "identifier": "top",
                    "quantity": 2
                },
                {
                    "identifier": "cap",
                    "quantity": 1
                }
            ]
        }
    },
    "updated": "2023-08-15T05:53:50.712Z",
    "values": {
        "collection": [
            {
                "data": [
                    "summer_2017"
                ],
                "locale": null,
                "scope": null
            }
        ],
        "color": [
            {
                "data": "antique_white",
                "locale": null,
                "scope": null
            }
        ],
        "description": [
            {
                "data": "Biker jacket",
                "locale": "en_US",
                "scope": "ecommerce"
            }
        ],
        "material": [
            {
                "data": "leather",
                "locale": null,
                "scope": null
            }
        ],
        "name": [
            {
                "data": "Biker jacket",
                "locale": "en_US",
                "scope": null
            }
        ],
        "variation_name": [
            {
                "data": "Biker jacket leather",
                "locale": "en_US",
                "scope": null
            }
        ]
    }
}'

Response Example

200 - Example 1

{
    "code": "string",
    "identifier": "string",
    "line": 0,
    "message": "string",
    "status_code": 0
}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠401Authentication required

🟠403Access forbidden

🟠413Request Entity Too Large

🟠415Unsupported Media type

Modified at almost 2 years ago

Get list of product models

Create a new product model