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

      /v23.1/WebshopProducts

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

      Get
      /v23.1/WebshopProducts
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      StoreId
      integer (int32)
      CountryId
      integer (int32)
      WebshopId
      integer (int32)
      ProductId
      integer (int32)
      Note1
      string
      Note2
      string
      Note3
      string
      Note4
      string
      WebshopClassificationId
      integer (int32)
      DisplayDateFrom
      string (date-time)
      DisplayDateTo
      string (date-time)
      OnlyProductsWithImage
      boolean
      IsIncludeModifiedArticleImages
      boolean
      IsIncludeModifiedStoreProducts
      boolean
      IsIncludeModifiedProducts
      boolean
      IncludeModifiedFreeFieldValues
      boolean
      IsExpiredOnly
      string
      Valid values[ "All", "Yes", "No" ]
      IsDeletedOnly
      string
      Valid values[ "All", "Yes", "No" ]
      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)
      companyId
      integer (int32)
      webshopId
      integer (int32)
      productId
      integer (int32)
      parentWebshopProductId
      integer (int32)
      webshopClassificationId
      integer (int32)
      priceIncrementPercentage
      number (double)
      priceIncrementValue
      number (double)
      safetyStock
      number (double)
      displayDateFrom
      string (date-time)
      displayDateTo
      string (date-time)
      isDisplayOnly
      boolean
      Default"False"
      isDeleted
      boolean
      Default"False"
      purchaseStatusCode
      string
      defaultWebshopClassificationId
      integer (int32)
      purchaseDefaultDeliveryDays
      integer (int32)
      webshopDescription
      string
      formattedProductDescription
      string
      description
      string
      alternateDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      information
      string
      productNumber
      integer (int64)
      mainBarcode
      integer (int64)
      externalCode
      string
      searchText
      string
      plu
      integer (int32)
      productGrossPrice
      number (double)
      productAdvicePrice
      number (double)
      productInternetPrice
      number (double)
      brandId
      integer (int32)
      classification1Id
      integer (int32)
      classification2Id
      integer (int32)
      classification3Id
      integer (int32)
      classification4Id
      integer (int32)
      classification5Id
      integer (int32)
      productCategoryId
      integer (int32)
      sizeId
      integer (int32)
      sizeTypeId
      integer (int32)
      colorId
      integer (int32)
      grossWeight
      number (double)
      netWeight
      number (double)
      weightIsoDimensionCode
      string
      netContent
      number (double)
      contentUnitCode
      string
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      lengthPackage
      number (double)
      heightPackage
      number (double)
      widthPackage
      number (double)
      depthPackage
      number (double)
      packageUnitCode
      string
      lengthArticle
      number (double)
      heightArticle
      number (double)
      widthArticle
      number (double)
      depthArticle
      number (double)
      articleSizeUnitCode
      string
      defaultSaleAmount
      number (double)
      allowSavings
      boolean
      Default"False"
      allowDiscounts
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      saleUnitCode
      string
      cashRegisterGroupId
      integer (int32)
      orderCode
      string
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      purchasePricePerAmount
      number (double)
      brandDescription
      string
      webshopClassificationDescription
      string
      webshopClassificationSafetyStock
      number (double)
      parentWebshopProductNumber
      integer (int64)
      basketGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      preferredSupplierNumber
      integer (int64)
      webshopPriceIncrementPercentage
      number (double)
      webshopPriceIncrementValue
      number (double)
      freeStock
      number (double)
      stock
      integer (int32)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      webshopId
      integer (int32)
      productId
      integer (int32)
      parentWebshopProductId
      integer (int32)
      webshopClassificationId
      integer (int32)
      priceIncrementPercentage
      number (double)
      priceIncrementValue
      number (double)
      safetyStock
      number (double)
      displayDateFrom
      string (date-time)
      displayDateTo
      string (date-time)
      isDisplayOnly
      boolean
      Default"False"
      isDeleted
      boolean
      Default"False"
      purchaseStatusCode
      string
      defaultWebshopClassificationId
      integer (int32)
      purchaseDefaultDeliveryDays
      integer (int32)
      webshopDescription
      string
      formattedProductDescription
      string
      description
      string
      alternateDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      information
      string
      productNumber
      integer (int64)
      mainBarcode
      integer (int64)
      externalCode
      string
      searchText
      string
      plu
      integer (int32)
      productGrossPrice
      number (double)
      productAdvicePrice
      number (double)
      productInternetPrice
      number (double)
      brandId
      integer (int32)
      classification1Id
      integer (int32)
      classification2Id
      integer (int32)
      classification3Id
      integer (int32)
      classification4Id
      integer (int32)
      classification5Id
      integer (int32)
      productCategoryId
      integer (int32)
      sizeId
      integer (int32)
      sizeTypeId
      integer (int32)
      colorId
      integer (int32)
      grossWeight
      number (double)
      netWeight
      number (double)
      weightIsoDimensionCode
      string
      netContent
      number (double)
      contentUnitCode
      string
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      lengthPackage
      number (double)
      heightPackage
      number (double)
      widthPackage
      number (double)
      depthPackage
      number (double)
      packageUnitCode
      string
      lengthArticle
      number (double)
      heightArticle
      number (double)
      widthArticle
      number (double)
      depthArticle
      number (double)
      articleSizeUnitCode
      string
      defaultSaleAmount
      number (double)
      allowSavings
      boolean
      Default"False"
      allowDiscounts
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      saleUnitCode
      string
      cashRegisterGroupId
      integer (int32)
      orderCode
      string
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      purchasePricePerAmount
      number (double)
      brandDescription
      string
      webshopClassificationDescription
      string
      webshopClassificationSafetyStock
      number (double)
      parentWebshopProductNumber
      integer (int64)
      basketGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      preferredSupplierNumber
      integer (int64)
      webshopPriceIncrementPercentage
      number (double)
      webshopPriceIncrementValue
      number (double)
      freeStock
      number (double)
      stock
      integer (int32)
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      webshopId
      integer (int32)
      productId
      integer (int32)
      parentWebshopProductId
      integer (int32)
      webshopClassificationId
      integer (int32)
      priceIncrementPercentage
      number (double)
      priceIncrementValue
      number (double)
      safetyStock
      number (double)
      displayDateFrom
      string (date-time)
      displayDateTo
      string (date-time)
      isDisplayOnly
      boolean
      Default"False"
      isDeleted
      boolean
      Default"False"
      purchaseStatusCode
      string
      defaultWebshopClassificationId
      integer (int32)
      purchaseDefaultDeliveryDays
      integer (int32)
      webshopDescription
      string
      formattedProductDescription
      string
      description
      string
      alternateDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      information
      string
      productNumber
      integer (int64)
      mainBarcode
      integer (int64)
      externalCode
      string
      searchText
      string
      plu
      integer (int32)
      productGrossPrice
      number (double)
      productAdvicePrice
      number (double)
      productInternetPrice
      number (double)
      brandId
      integer (int32)
      classification1Id
      integer (int32)
      classification2Id
      integer (int32)
      classification3Id
      integer (int32)
      classification4Id
      integer (int32)
      classification5Id
      integer (int32)
      productCategoryId
      integer (int32)
      sizeId
      integer (int32)
      sizeTypeId
      integer (int32)
      colorId
      integer (int32)
      grossWeight
      number (double)
      netWeight
      number (double)
      weightIsoDimensionCode
      string
      netContent
      number (double)
      contentUnitCode
      string
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      lengthPackage
      number (double)
      heightPackage
      number (double)
      widthPackage
      number (double)
      depthPackage
      number (double)
      packageUnitCode
      string
      lengthArticle
      number (double)
      heightArticle
      number (double)
      widthArticle
      number (double)
      depthArticle
      number (double)
      articleSizeUnitCode
      string
      defaultSaleAmount
      number (double)
      allowSavings
      boolean
      Default"False"
      allowDiscounts
      boolean
      Default"False"
      cancelled
      boolean
      Default"False"
      saleUnitCode
      string
      cashRegisterGroupId
      integer (int32)
      orderCode
      string
      grossPurchasePrice
      number (double)
      purchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      purchasePricePerAmount
      number (double)
      brandDescription
      string
      webshopClassificationDescription
      string
      webshopClassificationSafetyStock
      number (double)
      parentWebshopProductNumber
      integer (int64)
      basketGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      relatedProductsType
      string
      Valid values[ "NoRelatedProducts", "SaleOnRelatedProducts", "AddRelatedProducts", "ArticleComposition" ]
      preferredSupplierNumber
      integer (int64)
      webshopPriceIncrementPercentage
      number (double)
      webshopPriceIncrementValue
      number (double)
      freeStock
      number (double)
      stock
      integer (int32)
      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