v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Product

Update product v2

Updates details of a single product

patch/api/v2/products/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Request body

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.

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

unitstring nullable

Name of the unit.

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

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

isShippingCostsProductboolean

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

isMatrixProductboolean

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

Example request

{
  "project": {
    "id": "1337"
  },
  "unit": "Pack",
  "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"
    }
  },
  "calculatedPurchasePrice": {
    "price": {
      "amount": "13.37",
      "currency": "EUR"
    }
  },
  "calculatoryPurchasePriceSettings": {
    "addPurchasePriceToCalculationTriggers": [
      "onPurchaseOrderCompletion"
    ],
    "calculatoryPurchasePriceRecalculationTriggers": [
      "onPurchaseOrderCompletion"
    ],
    "calculatoryPurchasePriceRecalculationMethod": "latestPurchaseOrdersWeightedAverage"
  },
  "salesChannel": {
    "description": "A high-quality product.",
    "meta": {
      "title": "Sample Product Title",
      "description": "This product is designed for everyday use.",
      "keywords": "product, products"
    },
    "isStockNumberSyncActive": true,
    "isSoldOut": true,
    "isRemainingQuantity": true,
    "isVisible": true,
    "suggestedRetailPrice": "25.99",
    "suggestedStockQuantity": "100",
    "deliveryTime": "1 week",
    "createNewProductDuringImport": true
  },
  "merchandiseGroup": {
    "id": "1337"
  },
  "categories": [
    {
      "id": "1"
    },
    {
      "id": "2"
    }
  ],
  "standardSupplier": {
    "id": "12345"
  },
  "freeFields": [
    {
      "id": "17",
      "value": "Sample Product"
    }
  ],
  "options": [
    {
      "id": "17",
      "values": [
        {
          "id": "17"
        }
      ]
    }
  ],
  "selectedOptions": [
    {
      "id": "17",
      "option": {
        "id": "17"
      }
    }
  ],
  "tags": [
    {
      "color": "ff0000"
    }
  ],
  "variantOf": {
    "id": "parent-product-98765"
  }
}

Response

Operation completed successfully, no response body