Upsert Product

Production

https://api.b2b.retter.io/5p1hp1d2t

POST

/CALL/PIMAPI/upsertProduct/{PROJECT_ID}

Last modified:2025-07-08 10:37:29

You can access this API using an API key.

The upsertProduct API method is used to perform the addition or update operations for a product. This method can be used to update an existing product in the PIM or add a new product that is not yet present in the PIM. The method automatically detects updates and can update the product information stored in the PIM or add a new product if it doesn't already exist.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Example

{
    "dataType": "PRODUCT",
    "data": {
        "code": "code",
        "sku": "123456",
        "family": "testfamily",
        "status": "DRAFT",
        "groups": [
            "happy"
        ],
        "categories": [
            "drinks"
        ],
        "attributes": [
            {
                "code": "name",
                "data": [
                    {
                        "scope": "eCommerce",
                        "locale": "tr_TR",
                        "value": "awesome"
                    }
                ]
            }
        ]
    },
    "axesValues": [
        {
            "axe": "color",
            "value": "RED"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.b2b.retter.io/5p1hp1d2t/CALL/PIMAPI/upsertProduct/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "dataType": "PRODUCT",
    "data": {
        "code": "code",
        "sku": "123456",
        "family": "testfamily",
        "status": "DRAFT",
        "groups": [
            "happy"
        ],
        "categories": [
            "drinks"
        ],
        "attributes": [
            {
                "code": "name",
                "data": [
                    {
                        "scope": "eCommerce",
                        "locale": "tr_TR",
                        "value": "awesome"
                    }
                ]
            }
        ]
    },
    "axesValues": [
        {
            "axe": "color",
            "value": "RED"
        }
    ]
}'

Responses

🟢200OK

application/json

Successful response

Body

Example

{
    "meta": {
        "createdAt": "string",
        "updatedAt": "string",
        "updateToken": "string"
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:37:29

Get Catalog Settings

Upsert Category