Login
      Contents x
      /v23.1/Products
      • 05 Jun 2024
      • 7 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Contents

      /v23.1/Products

      • Updated on 05 Jun 2024
      • 7 Minutes to read
      • Contributors
      • Print
      • Dark
        Light
      • PDF
      Article summary

      The content provides detailed specifications for retrieving product information using HTTP security with a Bearer token. It includes query parameters for various product attributes such as product type, description, classification, brand, size, color, barcode, stock details, pricing, and more. The content also outlines valid values for different parameters and response codes for unauthorized, forbidden, and not found requests.

      Get
      /v23.1/Products
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      IsHeadOfficeRequest
      boolean
      ExternalProductId
      integer (int32)
      ParentProductId
      integer (int32)
      StoreId
      integer (int32)
      AlternateStockStoreId
      integer (int32)
      StoreTypeId
      integer (int32)
      ProductNumber
      integer (int64)
      ExternalCode
      string
      ProductType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      Plu
      integer (int32)
      SearchText
      string
      Description
      string
      Note1
      string
      ClassificationLevel1Id
      integer (int32)
      ClassificationLevel2Id
      integer (int32)
      ClassificationLevel3Id
      integer (int32)
      ClassificationLevel4Id
      integer (int32)
      ClassificationLevel5Id
      integer (int32)
      ClassificationGroupId
      integer (int32)
      ProductCategoryId
      integer (int32)
      BrandId
      integer (int32)
      SubBrandId
      integer (int32)
      BasketGroupId
      integer (int32)
      DisposalFeeId
      integer (int32)
      ReplacementProductId
      integer (int32)
      OrderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      FashionProduct
      string
      Valid values[ "All", "Yes", "No" ]
      SaleArticle
      string
      Valid values[ "All", "Yes", "No" ]
      PriceBlocked
      string
      Valid values[ "All", "Yes", "No" ]
      ReplacedProducts
      string
      Valid values[ "All", "Yes", "No" ]
      AreReplacedProducts
      string
      Valid values[ "All", "Yes", "No" ]
      CollectionProducts
      string
      Valid values[ "All", "Yes", "No" ]
      AtLeast1NotCancelledPurchase
      string
      Valid values[ "All", "Yes", "No" ]
      AtLeast1AvailableForOrderingPurchase
      string
      Valid values[ "All", "Yes", "No" ]
      PreferredSupplierId
      integer (int32)
      AssortmentIds
      string
      ArticleGroupId
      integer (int32)
      SizeTypeId
      integer (int32)
      SizeId
      integer (int32)
      ColorId
      integer (int32)
      Barcode
      integer (int64)
      BarcodeText
      string
      PassiveBarcodeOnly
      string
      Valid values[ "All", "Yes", "No" ]
      CountryId
      integer (int32)
      LanguageId
      integer (int32)
      SupplierId
      integer (int32)
      IsIgnoreSupplierIdForProductsWithNoSupplier
      boolean
      OrderCode
      string
      OrderCodeIgnoreSpecialCharacters
      boolean
      PurchaseUnitBarcode
      integer (int64)
      CollectionIdentifier
      integer (int64)
      CollectionBarcode
      integer (int64)
      StandbyProductExternalCode
      string
      CashRegisterGroupId
      integer (int32)
      VatId
      integer (int32)
      DiscountFilter
      string
      Valid values[ "All", "AllDiscounts", "NoDiscounts", "QuantityPriceBreaks", "MixedMatches" ]
      LastModifiedSinceDateTime
      string (date-time)
      LastModifiedUntilDateTime
      string (date-time)
      IsStockModification
      string
      Valid values[ "All", "Yes", "No" ]
      StockModificationDateFrom
      string (date-time)
      StockModificationDateTo
      string (date-time)
      IsIncludeInStockValue
      string
      Valid values[ "All", "Yes", "No" ]
      IsAllowMultiplePricing
      string
      Valid values[ "All", "Yes", "No" ]
      IsProductGroup
      string
      Valid values[ "All", "Yes", "No" ]
      IsConsignmentProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      ProductState
      string
      Valid values[ "NotSpecified", "OrganizationOnly", "DerivedOnly", "LocalOnly", "LocalAndDerivedOnly" ]
      IsParentProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsIncludeParentProducts
      string
      Valid values[ "All", "Yes", "No" ]
      IsColorProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsSmartSearch
      boolean
      IsWebshopProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsIgnoreCancelledProducts
      string
      Valid values[ "All", "Yes", "No" ]
      IsHasNote1Only
      string
      Valid values[ "All", "Yes", "No" ]
      WithImageOnly
      string
      Valid values[ "All", "Yes", "No" ]
      Stock
      number (double)
      StockFilter
      string
      Valid values[ "NotSpecified", "Unequal", "Greater", "GreaterEqual", "Equal", "LowerEqual", "Lower" ]
      FreeStock
      number (double)
      FreeStockFilter
      string
      Valid values[ "NotSpecified", "Unequal", "Greater", "GreaterEqual", "Equal", "LowerEqual", "Lower" ]
      IsAutoOrderOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsGiftCardOnly
      string
      Valid values[ "All", "Yes", "No" ]
      GiftCardTypeId
      integer (int32)
      PurchaseIsActiveOnly
      string
      Valid values[ "All", "Yes", "No" ]
      PurchaseSeasonProfileId
      integer (int32)
      PurchaseStoreTypeDifferentationId
      integer (int32)
      PurchaseAssortmentId
      integer (int32)
      GetArticlesOfCancelledSuppliers
      string
      Valid values[ "All", "Yes", "No" ]
      ShelfProductsAndLocalOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IncludedInActiveShelfDisplay
      string
      Valid values[ "All", "Yes", "No" ]
      ShelfDisplayId
      integer (int32)
      RelatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      EslProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      EslBarcode
      string
      StandbyProductsOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsActiveOnly
      string
      Valid values[ "All", "Yes", "No" ]
      DeletedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      FieldsToReturn
      string
      Offset
      integer (int32)
      RecordCount
      integer (int32)
      ItemId
      integer (int32)
      IncludeItemId
      integer (int32)
      ExcludeItemId
      integer (int32)
      ModifiedSinceDateTime
      string (date-time)
      Responses
      200

      Success

      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      externalProductId
      integer (int32)
      parentProductId
      integer (int32)
      productNumber
      integer (int64)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      mainBarcode
      integer (int64)
      barcodeTypeId
      integer (int32)
      replacementProductId
      integer (int32)
      externalCode
      string
      plu
      integer (int32)
      followupNumber
      integer (int32)
      searchText
      string
      description
      string
      alternateDescription
      string
      posDescription
      string
      formattedDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      cbsCode
      string
      countryOfOriginId
      integer (int32)
      classificationLevel1Id
      integer (int32)
      classificationLevel2Id
      integer (int32)
      classificationLevel3Id
      integer (int32)
      classificationLevel4Id
      integer (int32)
      classificationLevel5Id
      integer (int32)
      productCategoryId
      integer (int32)
      freeTableId
      integer (int32)
      brandId
      integer (int32)
      subBrandId
      integer (int32)
      basketGroupId
      integer (int32)
      posMessageId
      integer (int32)
      disposalFeeId
      integer (int32)
      productCombinationGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      assortmentId
      integer (int32)
      articleGroupId
      integer (int32)
      saleLedgerId
      integer (int32)
      sizeTypeId
      integer (int32)
      sizeId
      integer (int32)
      colorId
      integer (int32)
      warrantyId
      integer (int32)
      transportClassId
      integer (int32)
      labelClassId
      integer (int32)
      locationClassId
      integer (int32)
      storageLocation
      string
      grossPrice
      number (double)
      grossPriceSource
      string
      Valid values[ "NotSpecified", "Crawler" ]
      advicePrice
      number (double)
      advicePriceDate
      string (date-time)
      internetPrice
      number (double)
      defaultSaleAmount
      number (double)
      saleUnitDimensionId
      integer (int32)
      saleUnitPackageId
      integer (int32)
      consumerUnitToSaleUnitFactor
      number (double)
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      isNoSavings
      boolean
      Default"False"
      isNoDiscounts
      boolean
      Default"False"
      isNoDiscountOnDiscount
      boolean
      Default"False"
      isNoMixedMatchDiscount
      boolean
      Default"False"
      isNoQuantityPriceBreakDiscount
      boolean
      Default"False"
      isNoDiscountAgreementDiscount
      boolean
      Default"False"
      giftCardTypeId
      integer (int32)
      sizeIsoDimensionIdArticle
      integer (int32)
      lengthArticle
      number (double)
      heightArticle
      number (double)
      widthArticle
      number (double)
      depthArticle
      number (double)
      sizeIsoDimensionIdPackage
      integer (int32)
      lengthPackage
      number (double)
      heightPackage
      number (double)
      widthPackage
      number (double)
      depthPackage
      number (double)
      contentIsoDimensionId
      integer (int32)
      contentIsoPackageId
      integer (int32)
      netContent
      number (double)
      weightIsoDimensionId
      integer (int32)
      netWeight
      number (double)
      grossWeight
      number (double)
      hsCode
      string
      allowanceCode
      string
      allowanceAmount
      number (double)
      markingCodeType
      string
      Valid values[ "NotSpecified", "EanAndPrice", "EanNoPrice", "NoEanPrice", "NoEanNoPrice" ]
      isTrackAndTraceProduct
      boolean
      Default"False"
      isAskForDescriptionInPos
      boolean
      Default"False"
      isAskForPriceInPos
      boolean
      Default"False"
      isAskForAmountInPos
      boolean
      Default"False"
      isPriceZeroAllowed
      boolean
      Default"False"
      isAllowDiscountPercentageModification
      boolean
      Default"False"
      isAllowPriceModification
      boolean
      Default"False"
      isSerialAdministration
      boolean
      Default"False"
      isAllowMultiplePricing
      boolean
      Default"False"
      isPriceBlocked
      boolean
      Default"False"
      isIncludeInStockValue
      boolean
      Default"False"
      isSale
      boolean
      Default"False"
      isScaleIntegration
      boolean
      Default"False"
      isDropshipment
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      printLabel
      boolean
      Default"False"
      excludeFromPriceCalculation
      boolean
      Default"False"
      information
      string
      lastExchangeDateTime
      string (date-time)
      exchangeRemarks
      string
      isDerived
      boolean
      Default"False"
      productState
      string
      Valid values[ "NotSpecified", "OrganizationOnly", "DerivedOnly", "LocalOnly", "LocalAndDerivedOnly" ]
      isProductGroup
      boolean
      Default"False"
      standbyProductCode
      string
      standbyProductExternalCode
      string
      standbyProductDescription
      string
      standbyProductNote1
      string
      classificationLevel1Code
      string
      classificationLevel1Description
      string
      classificationLevel2Code
      string
      classificationLevel2Description
      string
      classificationLevel3Code
      string
      classificationLevel3Description
      string
      classificationLevel4Code
      string
      classificationLevel4Description
      string
      classificationLevel5Code
      string
      classificationLevel5Description
      string
      brandCode
      string
      brandDescription
      string
      subBrandCode
      string
      subBrandDescription
      string
      productCategoryCode
      string
      productCategoryDescription
      string
      defaultWebshopClassificationId
      integer (int32)
      grossProfitPercentage
      integer (int32)
      vatRequired
      boolean
      Default"False"
      cashRegisterGroupId
      integer (int32)
      cashRegisterGroupCode
      string
      cashRegisterGroupShortDescription
      string
      cashRegisterGroupDescription
      string
      preferredSupplierNumber
      integer (int32)
      preferredSupplierName
      string
      defaultDeliveryDays
      integer (int32)
      assortmentCode
      string
      assortmentDescription
      string
      saleUnitDimensionShortDescription
      string
      saleUnitDimensionDescription
      string
      saleUnitPackageShortDescription
      string
      saleUnitPackageDescription
      string
      isPurchaseAvailable
      boolean
      Default"False"
      organizationProductNumber
      integer (int32)
      colorDescription
      string
      sizeDescription
      string
      sizeFollowupNumber
      integer (int32)
      sizeTypeDescription
      string
      contentIsoCode
      string
      contentIsoDescription
      string
      orderCode
      string
      orderMultiplier
      number (double)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      purchasePricePerAmount
      integer (int32)
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      minimumOrderQuantity
      number (double)
      ownPurchasePriceNote
      string
      grossPurchasePriceReductionPercentage
      number (double)
      purchaseStatusRowDescription
      string
      purchaseStatusRowCode
      string
      productPosMessage
      string
      sizeIsoDimensionPackageDescription
      string
      weightIsoDescription
      string
      webshopProductItemId
      integer (int32)
      isActive
      boolean
      Default"False"
      countryOfOriginDescription
      string
      isMaintainStock
      boolean
      Default"False"
      stock
      number (double)
      shopStock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      openPurchaseOrders
      number (double)
      openSaleOrders
      number (double)
      minimumStock
      number (double)
      maximumStock
      number (double)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      storeGrossPrice
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      manualMinMaxStock
      number (double)
      alternateStock
      number (double)
      alternateFreeStock
      number (double)
      alternateFutureStock
      number (double)
      storeTypeGrossPrice
      number (double)
      calculatedGrossPrice
      number (double)
      deleted
      boolean
      Default"False"
      appliedGrossPrice
      number (double)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      externalProductId
      integer (int32)
      parentProductId
      integer (int32)
      productNumber
      integer (int64)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      mainBarcode
      integer (int64)
      barcodeTypeId
      integer (int32)
      replacementProductId
      integer (int32)
      externalCode
      string
      plu
      integer (int32)
      followupNumber
      integer (int32)
      searchText
      string
      description
      string
      alternateDescription
      string
      posDescription
      string
      formattedDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      cbsCode
      string
      countryOfOriginId
      integer (int32)
      classificationLevel1Id
      integer (int32)
      classificationLevel2Id
      integer (int32)
      classificationLevel3Id
      integer (int32)
      classificationLevel4Id
      integer (int32)
      classificationLevel5Id
      integer (int32)
      productCategoryId
      integer (int32)
      freeTableId
      integer (int32)
      brandId
      integer (int32)
      subBrandId
      integer (int32)
      basketGroupId
      integer (int32)
      posMessageId
      integer (int32)
      disposalFeeId
      integer (int32)
      productCombinationGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      assortmentId
      integer (int32)
      articleGroupId
      integer (int32)
      saleLedgerId
      integer (int32)
      sizeTypeId
      integer (int32)
      sizeId
      integer (int32)
      colorId
      integer (int32)
      warrantyId
      integer (int32)
      transportClassId
      integer (int32)
      labelClassId
      integer (int32)
      locationClassId
      integer (int32)
      storageLocation
      string
      grossPrice
      number (double)
      grossPriceSource
      string
      Valid values[ "NotSpecified", "Crawler" ]
      advicePrice
      number (double)
      advicePriceDate
      string (date-time)
      internetPrice
      number (double)
      defaultSaleAmount
      number (double)
      saleUnitDimensionId
      integer (int32)
      saleUnitPackageId
      integer (int32)
      consumerUnitToSaleUnitFactor
      number (double)
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      isNoSavings
      boolean
      Default"False"
      isNoDiscounts
      boolean
      Default"False"
      isNoDiscountOnDiscount
      boolean
      Default"False"
      isNoMixedMatchDiscount
      boolean
      Default"False"
      isNoQuantityPriceBreakDiscount
      boolean
      Default"False"
      isNoDiscountAgreementDiscount
      boolean
      Default"False"
      giftCardTypeId
      integer (int32)
      sizeIsoDimensionIdArticle
      integer (int32)
      lengthArticle
      number (double)
      heightArticle
      number (double)
      widthArticle
      number (double)
      depthArticle
      number (double)
      sizeIsoDimensionIdPackage
      integer (int32)
      lengthPackage
      number (double)
      heightPackage
      number (double)
      widthPackage
      number (double)
      depthPackage
      number (double)
      contentIsoDimensionId
      integer (int32)
      contentIsoPackageId
      integer (int32)
      netContent
      number (double)
      weightIsoDimensionId
      integer (int32)
      netWeight
      number (double)
      grossWeight
      number (double)
      hsCode
      string
      allowanceCode
      string
      allowanceAmount
      number (double)
      markingCodeType
      string
      Valid values[ "NotSpecified", "EanAndPrice", "EanNoPrice", "NoEanPrice", "NoEanNoPrice" ]
      isTrackAndTraceProduct
      boolean
      Default"False"
      isAskForDescriptionInPos
      boolean
      Default"False"
      isAskForPriceInPos
      boolean
      Default"False"
      isAskForAmountInPos
      boolean
      Default"False"
      isPriceZeroAllowed
      boolean
      Default"False"
      isAllowDiscountPercentageModification
      boolean
      Default"False"
      isAllowPriceModification
      boolean
      Default"False"
      isSerialAdministration
      boolean
      Default"False"
      isAllowMultiplePricing
      boolean
      Default"False"
      isPriceBlocked
      boolean
      Default"False"
      isIncludeInStockValue
      boolean
      Default"False"
      isSale
      boolean
      Default"False"
      isScaleIntegration
      boolean
      Default"False"
      isDropshipment
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      printLabel
      boolean
      Default"False"
      excludeFromPriceCalculation
      boolean
      Default"False"
      information
      string
      lastExchangeDateTime
      string (date-time)
      exchangeRemarks
      string
      isDerived
      boolean
      Default"False"
      productState
      string
      Valid values[ "NotSpecified", "OrganizationOnly", "DerivedOnly", "LocalOnly", "LocalAndDerivedOnly" ]
      isProductGroup
      boolean
      Default"False"
      standbyProductCode
      string
      standbyProductExternalCode
      string
      standbyProductDescription
      string
      standbyProductNote1
      string
      classificationLevel1Code
      string
      classificationLevel1Description
      string
      classificationLevel2Code
      string
      classificationLevel2Description
      string
      classificationLevel3Code
      string
      classificationLevel3Description
      string
      classificationLevel4Code
      string
      classificationLevel4Description
      string
      classificationLevel5Code
      string
      classificationLevel5Description
      string
      brandCode
      string
      brandDescription
      string
      subBrandCode
      string
      subBrandDescription
      string
      productCategoryCode
      string
      productCategoryDescription
      string
      defaultWebshopClassificationId
      integer (int32)
      grossProfitPercentage
      integer (int32)
      vatRequired
      boolean
      Default"False"
      cashRegisterGroupId
      integer (int32)
      cashRegisterGroupCode
      string
      cashRegisterGroupShortDescription
      string
      cashRegisterGroupDescription
      string
      preferredSupplierNumber
      integer (int32)
      preferredSupplierName
      string
      defaultDeliveryDays
      integer (int32)
      assortmentCode
      string
      assortmentDescription
      string
      saleUnitDimensionShortDescription
      string
      saleUnitDimensionDescription
      string
      saleUnitPackageShortDescription
      string
      saleUnitPackageDescription
      string
      isPurchaseAvailable
      boolean
      Default"False"
      organizationProductNumber
      integer (int32)
      colorDescription
      string
      sizeDescription
      string
      sizeFollowupNumber
      integer (int32)
      sizeTypeDescription
      string
      contentIsoCode
      string
      contentIsoDescription
      string
      orderCode
      string
      orderMultiplier
      number (double)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      purchasePricePerAmount
      integer (int32)
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      minimumOrderQuantity
      number (double)
      ownPurchasePriceNote
      string
      grossPurchasePriceReductionPercentage
      number (double)
      purchaseStatusRowDescription
      string
      purchaseStatusRowCode
      string
      productPosMessage
      string
      sizeIsoDimensionPackageDescription
      string
      weightIsoDescription
      string
      webshopProductItemId
      integer (int32)
      isActive
      boolean
      Default"False"
      countryOfOriginDescription
      string
      isMaintainStock
      boolean
      Default"False"
      stock
      number (double)
      shopStock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      openPurchaseOrders
      number (double)
      openSaleOrders
      number (double)
      minimumStock
      number (double)
      maximumStock
      number (double)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      storeGrossPrice
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      manualMinMaxStock
      number (double)
      alternateStock
      number (double)
      alternateFreeStock
      number (double)
      alternateFutureStock
      number (double)
      storeTypeGrossPrice
      number (double)
      calculatedGrossPrice
      number (double)
      deleted
      boolean
      Default"False"
      appliedGrossPrice
      number (double)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      organizationId
      integer (int32)
      companyId
      integer (int32)
      externalProductId
      integer (int32)
      parentProductId
      integer (int32)
      productNumber
      integer (int64)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      mainBarcode
      integer (int64)
      barcodeTypeId
      integer (int32)
      replacementProductId
      integer (int32)
      externalCode
      string
      plu
      integer (int32)
      followupNumber
      integer (int32)
      searchText
      string
      description
      string
      alternateDescription
      string
      posDescription
      string
      formattedDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      cbsCode
      string
      countryOfOriginId
      integer (int32)
      classificationLevel1Id
      integer (int32)
      classificationLevel2Id
      integer (int32)
      classificationLevel3Id
      integer (int32)
      classificationLevel4Id
      integer (int32)
      classificationLevel5Id
      integer (int32)
      productCategoryId
      integer (int32)
      freeTableId
      integer (int32)
      brandId
      integer (int32)
      subBrandId
      integer (int32)
      basketGroupId
      integer (int32)
      posMessageId
      integer (int32)
      disposalFeeId
      integer (int32)
      productCombinationGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      assortmentId
      integer (int32)
      articleGroupId
      integer (int32)
      saleLedgerId
      integer (int32)
      sizeTypeId
      integer (int32)
      sizeId
      integer (int32)
      colorId
      integer (int32)
      warrantyId
      integer (int32)
      transportClassId
      integer (int32)
      labelClassId
      integer (int32)
      locationClassId
      integer (int32)
      storageLocation
      string
      grossPrice
      number (double)
      grossPriceSource
      string
      Valid values[ "NotSpecified", "Crawler" ]
      advicePrice
      number (double)
      advicePriceDate
      string (date-time)
      internetPrice
      number (double)
      defaultSaleAmount
      number (double)
      saleUnitDimensionId
      integer (int32)
      saleUnitPackageId
      integer (int32)
      consumerUnitToSaleUnitFactor
      number (double)
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      isNoSavings
      boolean
      Default"False"
      isNoDiscounts
      boolean
      Default"False"
      isNoDiscountOnDiscount
      boolean
      Default"False"
      isNoMixedMatchDiscount
      boolean
      Default"False"
      isNoQuantityPriceBreakDiscount
      boolean
      Default"False"
      isNoDiscountAgreementDiscount
      boolean
      Default"False"
      giftCardTypeId
      integer (int32)
      sizeIsoDimensionIdArticle
      integer (int32)
      lengthArticle
      number (double)
      heightArticle
      number (double)
      widthArticle
      number (double)
      depthArticle
      number (double)
      sizeIsoDimensionIdPackage
      integer (int32)
      lengthPackage
      number (double)
      heightPackage
      number (double)
      widthPackage
      number (double)
      depthPackage
      number (double)
      contentIsoDimensionId
      integer (int32)
      contentIsoPackageId
      integer (int32)
      netContent
      number (double)
      weightIsoDimensionId
      integer (int32)
      netWeight
      number (double)
      grossWeight
      number (double)
      hsCode
      string
      allowanceCode
      string
      allowanceAmount
      number (double)
      markingCodeType
      string
      Valid values[ "NotSpecified", "EanAndPrice", "EanNoPrice", "NoEanPrice", "NoEanNoPrice" ]
      isTrackAndTraceProduct
      boolean
      Default"False"
      isAskForDescriptionInPos
      boolean
      Default"False"
      isAskForPriceInPos
      boolean
      Default"False"
      isAskForAmountInPos
      boolean
      Default"False"
      isPriceZeroAllowed
      boolean
      Default"False"
      isAllowDiscountPercentageModification
      boolean
      Default"False"
      isAllowPriceModification
      boolean
      Default"False"
      isSerialAdministration
      boolean
      Default"False"
      isAllowMultiplePricing
      boolean
      Default"False"
      isPriceBlocked
      boolean
      Default"False"
      isIncludeInStockValue
      boolean
      Default"False"
      isSale
      boolean
      Default"False"
      isScaleIntegration
      boolean
      Default"False"
      isDropshipment
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      printLabel
      boolean
      Default"False"
      excludeFromPriceCalculation
      boolean
      Default"False"
      information
      string
      lastExchangeDateTime
      string (date-time)
      exchangeRemarks
      string
      isDerived
      boolean
      Default"False"
      productState
      string
      Valid values[ "NotSpecified", "OrganizationOnly", "DerivedOnly", "LocalOnly", "LocalAndDerivedOnly" ]
      isProductGroup
      boolean
      Default"False"
      standbyProductCode
      string
      standbyProductExternalCode
      string
      standbyProductDescription
      string
      standbyProductNote1
      string
      classificationLevel1Code
      string
      classificationLevel1Description
      string
      classificationLevel2Code
      string
      classificationLevel2Description
      string
      classificationLevel3Code
      string
      classificationLevel3Description
      string
      classificationLevel4Code
      string
      classificationLevel4Description
      string
      classificationLevel5Code
      string
      classificationLevel5Description
      string
      brandCode
      string
      brandDescription
      string
      subBrandCode
      string
      subBrandDescription
      string
      productCategoryCode
      string
      productCategoryDescription
      string
      defaultWebshopClassificationId
      integer (int32)
      grossProfitPercentage
      integer (int32)
      vatRequired
      boolean
      Default"False"
      cashRegisterGroupId
      integer (int32)
      cashRegisterGroupCode
      string
      cashRegisterGroupShortDescription
      string
      cashRegisterGroupDescription
      string
      preferredSupplierNumber
      integer (int32)
      preferredSupplierName
      string
      defaultDeliveryDays
      integer (int32)
      assortmentCode
      string
      assortmentDescription
      string
      saleUnitDimensionShortDescription
      string
      saleUnitDimensionDescription
      string
      saleUnitPackageShortDescription
      string
      saleUnitPackageDescription
      string
      isPurchaseAvailable
      boolean
      Default"False"
      organizationProductNumber
      integer (int32)
      colorDescription
      string
      sizeDescription
      string
      sizeFollowupNumber
      integer (int32)
      sizeTypeDescription
      string
      contentIsoCode
      string
      contentIsoDescription
      string
      orderCode
      string
      orderMultiplier
      number (double)
      purchaseContentUnitToConsumerUnitFactor
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      purchasePricePerAmount
      integer (int32)
      purchasePriceType
      string
      Valid values[ "NotSpecified", "PurchaseUnit", "PurchaseContentUnit", "ConsumerUnit" ]
      minimumOrderQuantity
      number (double)
      ownPurchasePriceNote
      string
      grossPurchasePriceReductionPercentage
      number (double)
      purchaseStatusRowDescription
      string
      purchaseStatusRowCode
      string
      productPosMessage
      string
      sizeIsoDimensionPackageDescription
      string
      weightIsoDescription
      string
      webshopProductItemId
      integer (int32)
      isActive
      boolean
      Default"False"
      countryOfOriginDescription
      string
      isMaintainStock
      boolean
      Default"False"
      stock
      number (double)
      shopStock
      number (double)
      freeStock
      number (double)
      futureStock
      number (double)
      openPurchaseOrders
      number (double)
      openSaleOrders
      number (double)
      minimumStock
      number (double)
      maximumStock
      number (double)
      orderMethod
      string
      Valid values[ "NotSpecified", "ByStock", "ByPeriodSale", "NoAutoOrder" ]
      storeGrossPrice
      number (double)
      calculatedMinStock
      number (double)
      calculatedMaxStock
      number (double)
      manualMinMaxStock
      number (double)
      alternateStock
      number (double)
      alternateFreeStock
      number (double)
      alternateFutureStock
      number (double)
      storeTypeGrossPrice
      number (double)
      calculatedGrossPrice
      number (double)
      deleted
      boolean
      Default"False"
      appliedGrossPrice
      number (double)
      401

      Unauthorized

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      403

      Forbidden

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      404

      Not Found

      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      object
      type
      string
      message
      string
      stackTrace
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout