Products.batch_create_or_update

POST

/entities/Products/batch-modify

Create or update an batch of Products

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Products on change. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

rollback-method

integer <int32>

optional

Specify rollback method for Products. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

picture

object

optional

Relation to CloudObject, see: 'updateCloudObjectInput' object for properties.

string <uri>

optional

allowed_pipelines

enum<integer>

optional

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

name

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

picture_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_category_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sku

string

optional

Simple text input field.

Example:

string

unit_symbol

string

optional

Simple text input field.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

product_pipeline_relations

array [object {1}]

optional

Relations to Pipelines.

string <uri>

optional

product_pipelines

object

optional

Configuration of Pipelines where the Product can be used.

pipelines

array[string <uuid>]

required

allowed_pipelines

enum<integer>

required

Integer enum value: 1 - All, 2 - Selected

Allowed values:

Example:

picture_source_url

string

optional

Source url of picture. If filled url is loaded and checked content. Currently supports only pictures!!

Example:

string

string <uuid>

optional

ID of object to update.

Example

[
    {
        "picture": {
            "id": "http://example.com"
        },
        "allowed_pipelines": 1,
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "name": "string",
        "picture_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "sku": "string",
        "unit_symbol": "string",
        "revision": 1,
        "product_pipeline_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "product_pipelines": {
            "pipelines": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "allowed_pipelines": 1
        },
        "picture_source_url": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/Products/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "picture": {
            "id": "http://example.com"
        },
        "allowed_pipelines": 1,
        "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
        "description": "string",
        "name": "string",
        "picture_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_category_id": "01234567-abcd-dcba-ffff-000000000000",
        "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "sku": "string",
        "unit_symbol": "string",
        "revision": 1,
        "product_pipeline_relations": [
            {
                "id": "http://example.com"
            }
        ],
        "product_pipelines": {
            "pipelines": [
                "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ],
            "allowed_pipelines": 1
        },
        "picture_source_url": "string",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated Products

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array [oneOf]

optional

string <uuid>

optional

And ID of created / updated entity.

object (Error)

optional

Example

{
    "success": true,
    "data": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

🔴500Server Error

Modified at 2025-06-26 12:37:59

Products.batch_delete

Products.batch_restore