v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

Create product V2

Creates a new product.

post/api/v2/products

Request body

namestring required

Name of the product.

numberstring

Number / SKU of the product.

descriptionstring

Description of the product.

shortDescriptionstring

Short description of the product.

customsTariffNumberstring

Customs tariff number of the product.

eanstring

EAN of the product.

internalCommentstring

Text only for internal information.

minimumOrderQuantityinteger

Numerical minimum order quantity of the product.

minimumStorageQuantityinteger

Numerical minimum storage quantity of the product.

unitstring

Name of the unit.

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'

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'

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

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"
  },
  "tags": [
    {
      "color": "ff0000"
    }
  ],
  "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"
    }
  },
  "merchandiseGroup": {
    "id": "1337"
  },
  "standardSupplier": {
    "id": "12345"
  },
  "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
  },
  "freeFields": [
    {
      "id": "17",
      "value": "Sample Product"
    }
  ],
  "variantOf": {
    "id": "parent-product-98765"
  },
  "variants": [
    {
      "name": "OptionalName(overrides autogenerated)",
      "options": [
        {
          "name": "Cotton",
          "option": {
            "name": "Material"
          }
        },
        {
          "name": "M",
          "option": {
            "name": "Size"
          }
        },
        {
          "name": "NoLogo",
          "option": {
            "name": "Logo"
          }
        }
      ]
    }
  ],
  "categories": [
    {
      "id": "1"
    },
    {
      "id": "2"
    }
  ]
}

Response

Resource successfully created response