v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Product

Update multiple products V1

Updates multiple products

patch/api/v1/products

Request body

idstring

Resource identifier.

namestring

Name of the product.

numberstring

Number / SKU of the product.

descriptionstring nullable

Description of the product.

internalCommentstring nullable

Text only for internal information.

shortDescriptionstring nullable

Short description of the product.

customsTariffNumberstring nullable

Customs tariff number of the product.

eanstring nullable

EAN of the product.

minimumOrderQuantitynumber

Numerical minimum order quantity of the product.

minimumStorageQuantitynumber

Numerical minimum storage quantity of the product.

serialNumbersMode'disabled' | 'user' | 'product' | 'productAndWarehouse'

4 different modes available if the product has serial numbers or not and how they are handled. For more information about the different modes have a look into our handbook.

disabledReasonstring nullable

Shows the reason why the product is locked when clicking into the product.

ageRating'' | '16' | '18' nullable

Sets an age rating for the product. Currently only used for the shipping service provider DHL.

countryOfOriginstring nullable

Two-digit ISO country code for country of origin of the product.

salesTax'standard' | 'reduced' | 'free'

Selection of three possible values for the sales tax of the product.

shopPriceDisplaystring float nullable

Only used by some online shops. For more information have a look into our handbook.

isShippingCostsProductboolean

Determines if a product is used as a shipping costs product. For more information have a look into our handbook.

regionOfOrigin'' | '01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | '11' | '12' | '13' | '14' | '15' | '16' | '99' nullable

01 - Schleswig-Holstein, 02 - Hamburg, 03 - Niedersachsen, 04 - Bremen, 05 - Nordhrein-Westfalen, 06 - Hessen, 07 - Rheinland-Pfalz, 08 - Baden-Württemberg, 09 - Bayern, 10 - Saarland, 11 - Berlin, 12 - Brandenburg, 13 - Mecklenburg-Vorpommern, 14 - Sachsen, 15 - Sachsen-Anhalt, 16 - Thüringen, 99 - foreign origin

isMatrixProductboolean

Determines if a product is a matrix product. For more information have a look into our handbook.

Example request

[
  {
    "id": "17",
    "name": "Eco-Friendly Water Bottle",
    "number": "SKU12345-ABC",
    "project": {
      "id": "1337"
    },
    "description": "This is a high-quality, durable backpack designed for outdoor adventures, featuring multiple compartments and waterproof fabric.",
    "internalComment": "Ensure to review this product's compliance before the next shipment.",
    "shortDescription": "Compact wireless mouse with ergonomic design.",
    "customsTariffNumber": "1234.56.78",
    "ean": "1234567890123",
    "minimumOrderQuantity": 1,
    "minimumStorageQuantity": 10,
    "serialNumbersMode": "user",
    "disabledReason": "Product is currently out of stock.",
    "ageRating": "18",
    "countryOfOrigin": "DE",
    "measurements": {
      "width": {
        "value": 20,
        "unit": "cm"
      },
      "height": {
        "value": 10,
        "unit": "cm"
      },
      "length": {
        "value": 30,
        "unit": "cm"
      },
      "weight": {
        "value": 2,
        "unit": "kg"
      },
      "netWeight": {
        "value": 1.5,
        "unit": "kg"
      }
    },
    "manufacturer": {
      "name": "Test Corp",
      "number": "AC12345",
      "link": "https://www.testcorp.com"
    },
    "salesTax": "standard",
    "shopPriceDisplay": "19.99",
    "category": {
      "id": "1337"
    },
    "standardSupplier": {
      "id": "12345"
    },
    "defaultStorageLocation": {
      "id": "1337"
    },
    "isShippingCostsProduct": true,
    "discount": {
      "isDiscountProduct": false,
      "discountPercentage": 15.5
    },
    "stockTaking": {
      "hasStockTakingValue": true,
      "stockTakingValue": 100.75
    },
    "calculatedPurchasePrice": {
      "hasCalculatedPurchasePrice": false,
      "price": {
        "amount": "100.00",
        "currency": "EUR"
      }
    },
    "regionOfOrigin": "05",
    "isMatrixProduct": true,
    "freeFields": [
      {
        "id": "17",
        "value": "Sample Product"
      }
    ],
    "tags": [
      {
        "id": "12345",
        "key": "productKey123",
        "name": "Sample Product",
        "color": "ff0000"
      }
    ],
    "variantOf": {
      "id": "parent-product-98765"
    }
  }
]

Response

Operation completed successfully, no response body