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

      /v23.1/Products/{itemId}

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

      Get
      /v23.1/Products/{itemId}
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Path parameters
      itemId
      integer (int32) Required
      Responses
      200

      Success

      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
      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
      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
      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