v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Product

List products V2

Returns a collection with all products.

get/api/v2/products

Query parameters

key'search' | 'id' | 'uuid' | 'category' | 'merchandiseGroup' | 'standardSupplier' | 'name' | 'number' | 'description' | 'project' | 'projectName' | 'purchasePriceNet' | 'purchasePriceGross' | 'salesChannel' | 'salesPriceNet' | 'salesPriceGross' | 'shopPriceDisplay' | 'purchasedCount' | 'availableCount' | 'inProductionCount' | 'ean' | 'manufacturerName' | 'manufacturerNumber' | 'customsTariffNumber' | 'freeField1' | 'freeField2' | 'freeField3' | 'freeField4' | 'freeField5' | 'freeField6' | 'freeField7' | 'freeField8' | 'freeField9' | 'freeField10' | 'freeField11' | 'freeField12' | 'freeField13' | 'freeField14' | 'freeField15' | 'freeField16' | 'freeField17' | 'freeField18' | 'freeField19' | 'freeField20' | 'freeField21' | 'freeField22' | 'freeField23' | 'freeField24' | 'freeField25' | 'freeField26' | 'freeField27' | 'freeField28' | 'freeField29' | 'freeField30' | 'freeField31' | 'freeField32' | 'freeField33' | 'freeField34' | 'freeField35' | 'freeField36' | 'freeField37' | 'freeField38' | 'freeField39' | 'freeField40' | 'onlyStockItems' | 'noStockItems' | 'onlyVariants' | 'noVariants' | 'onlyPartsList' | 'noPartsList' | 'onlyActive' | 'onlyLocked' | 'onlyInStock' | 'updatedAt' | 'isStockItem' | 'categoryId' | 'tagId' | 'isDiscountProduct' | 'isShippingCostsProduct' | 'isVariant' | 'variantOf' | 'externalReferenceNumber' | 'externalReferenceName' | 'externalReferenceTargetId'
op'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'id' | 'name' | 'number' | 'description' | 'project' | 'purchasePriceNet' | 'purchasePriceGross' | 'salesPriceNet' | 'salesPriceGross' | 'ean' | 'manufacturerName' | 'manufacturerNumber' | 'customsTariffNumber'
dir'asc' | 'desc'

Response

Operation completed successfully.

Example response

{
  "data": [
    {
      "id": "17",
      "uuid": "a00fd11e-3a67-433b-83c0-4e815fd4a0e1",
      "project": {
        "id": "1337",
        "name": "Diamond"
      },
      "merchandiseGroup": {
        "id": "1337",
        "name": "Diamond"
      },
      "name": "Example Product Name",
      "stockCount": 150,
      "number": "SKU-12345",
      "description": "This product is designed for everyday use and offers high durability.",
      "internalComment": "This product is on hold due to quality checks.",
      "shortDescription": "Compact and lightweight, perfect for travel.",
      "standardSupplier": {
        "id": "12345"
      },
      "thumbnailUrl": "https://example.com/images/product-thumbnail.jpg",
      "thumbnailId": "thumb-12345",
      "tags": [
        {
          "color": "ff0000"
        }
      ],
      "purchasePriceNet": {
        "amount": "13.37",
        "currency": "EUR"
      },
      "purchasePriceGross": {
        "amount": "13.37",
        "currency": "EUR"
      },
      "salesPriceNet": {
        "amount": "13.37",
        "currency": "EUR"
      },
      "salesPriceGross": {
        "amount": "13.37",
        "currency": "EUR"
      },
      "ean": "978-3-16-148410-0",
      "manufacturer": {
        "name": "Test Corp",
        "number": "AC12345",
        "link": "https://www.testcorp.com"
      },
      "customsTariffNumber": "1234.56.78",
      "discount": {
        "isDiscountProduct": false,
        "discountPercentage": 15.5
      },
      "stockStats": {
        "purchasedCount": "10.0",
        "totalCount": "50.0",
        "availableCount": "30.0",
        "inProductionCount": "10.0"
      },
      "minimumOrderQuantity": 5,
      "minimumStorageQuantity": 10,
      "allowPurchaseFromAllSuppliers": true,
      "hasBatches": true,
      "serialNumbersMode": "mandatory",
      "hasBestBeforeDate": true,
      "isAssembledJustInTime": true,
      "isExternallyProduced": true,
      "ageRating": "12+",
      "countryOfOrigin": "DE",
      "unit": {
        "name": "kilogram"
      },
      "textsAndDescriptions": {
        "inCatalog": true,
        "primaryLanguage": {
          "name": "Produkt eins",
          "shortDescription": "Kurze Beschreibung des Produkts.",
          "description": "Dies ist eine detaillierte Produktbeschreibung.",
          "shopDescription": "Verkaufsbeschreibung für den Shop.",
          "metaTitle": "Produkt SEO-Titel",
          "metaDescription": "Meta-Beschreibung für das Produkt.",
          "metaKeywords": "Produkt, SEO, Keywords",
          "catalogName": "Produktkatalogname",
          "catalogText": "Detaillierter Katalogtext für das Produkt."
        },
        "english": {
          "name": "Product One",
          "shortDescription": "Short description of the product.",
          "description": "This is a detailed product description.",
          "shopDescription": "Shop description for the product.",
          "metaTitle": "Product SEO Title",
          "metaDescription": "Meta description for the product.",
          "metaKeywords": "product, SEO, keywords",
          "catalogName": "Product Catalog Name",
          "catalogText": "Detailed catalog text for the product."
        }
      },
      "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"
        }
      },
      "isStockItem": true,
      "defaultStorageLocation": {
        "id": "17"
      },
      "isDisabled": true,
      "disabledReason": "Out of stock",
      "salesTax": "reduced",
      "regionOfOrigin": "04",
      "freeFields": [
        {
          "id": "17"
        }
      ],
      "stockTaking": {
        "hasStockTakingValue": true,
        "stockTakingValue": 150.75
      },
      "calculatedPurchasePrice": {
        "hasCalculatedPurchasePrice": false,
        "price": {
          "amount": "13.37",
          "currency": "EUR"
        }
      },
      "calculatoryPurchasePriceSettings": {
        "addPurchasePriceToCalculationTriggers": [
          "onPurchaseOrderCompletion"
        ],
        "calculatoryPurchasePriceRecalculationTriggers": [
          "onPurchaseOrderCompletion"
        ],
        "calculatoryPurchasePriceRecalculationMethod": "latestPurchaseOrdersWeightedAverage"
      },
      "salesChannel": {
        "description": "This is a product description.",
        "meta": {
          "title": "Product Title",
          "description": "Detailed product description.",
          "keywords": "keyword1, keyword2, keyword3"
        },
        "isStockNumberSyncActive": true,
        "isSoldOut": false,
        "isRemainingQuantity": true,
        "suggestedRetailPrice": "99.99",
        "isVisible": true
      },
      "options": [
        {
          "id": "17",
          "values": [
            {
              "id": "17"
            }
          ]
        }
      ],
      "selectedOptions": [
        {
          "id": "17",
          "values": [
            {
              "id": "17"
            }
          ]
        }
      ],
      "isVariant": true,
      "variantOf": {
        "id": "parent-product-98765"
      },
      "variants": [
        {
          "id": "17",
          "options": [
            {
              "id": "17"
            }
          ]
        }
      ],
      "mainVariant": {
        "id": "variant-12345"
      },
      "categories": [
        {
          "id": "17"
        }
      ],
      "updatedAt": "2024-09-23T14:30:00Z"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}