Upsert articles

Import or update full article information(including prices) in bulk. Usually performed via direct integration with Data Import service.

POST /v2/articles/import

cURL

Single Product

curl --request POST \
  --url https://{host}/product-catalog/v2/articles/import \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "name": "Coca-Cola Classic 1.5L",
    "externalId": "EXT-1001",
    "hierarchyId": "2001",
    "imageLink": "https://example.com/images/cocacola-1-5l.jpg",
    "brand": {
      "id": "Coca-Cola",
      "name": "BR-COCA"
    },
    "eans": [
      "5449000131805"
    ],
    "suppliers": [
      {
        "id": "Metro Cash & Carry",
        "name": "SUP-201"
      },
      {
        "id": "Retail Partners",
        "name": "SUP-202"
      }
    ],
    "saleUnit": "bottle",
    "units": null,
    "unitOfMeasure": "liter",
    "unitsPerPiece": 1,
    "isWeightable": false,
    "restrictions": [],
    "metadata": {
      "isSugarFree": false,
      "volume": "1.5L"
    },
    "depositItemExternalId": null,
    "hamperItemExternalIds": [],
    "prices": [
      {
        "storeId": "-1",
        "salePrice": 19.99,
        "pricePerUnit": null,
        "pricePerPiece": null,
        "isWithoutBarcode": null,
        "taxCode": "VAT20"
      },
      {
        "storeId": "STORE-002",
        "salePrice": 19.99,
        "pricePerUnit": null,
        "pricePerPiece": null,
        "isWithoutBarcode": true,
        "taxCode": "VAT10"
      }
    ]
  }
]
'

200

{}

Body

application/jsontext/jsonapplication/*+json

name · string

Name of the product.

externalId · string

Identifier of the product in external system.

hierarchyId · string

Identifier of the hierarchy node the product belongs to.

imageLink · string | null

URL of the image associated with the entity.

brand · object

Represents product's brand.

Show child attributes

eans · string[]

List of EANs associated with the product.

suppliers · object[] | null

List of suppliers associated with the product.

Show child attributes

saleUnit · string | null

The unit in which the product is sold (e.g., piece, pack, box).

units · number<double> | null

Total weight of the product.

unitOfMeasure · string | null

The measurement unit used to quantify the product (e.g., kg, liter, meter, piece).

unitsPerPiece · number<double> | null

The number of units contained in a single piece of the product.

isWeightable · boolean | null

Indicates if the product is sold by weight.

restrictions · string[] | null

List of restrictions (e.g., Age16, Age18, etc.) associated with the product.

metadata · object | null

Additional metadata associated with the product.

Show child attributes

depositItemExternalId · string | null

Deposit item's externa id (from external system) associated with the product.

hamperItemExternalIds · string[] | null

Hamper item's external ids (from external system) associated with the product.

prices · object[]

Artices prices per store.

Show child attributes

Response

200

text/plain

OK

The response is of type object.