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

      /v23.1/ExchangeProducts

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

      Get
      /v23.1/ExchangeProducts
      Security
      HTTP
      Type Bearer

      Please enter a valid token

      Query parameters
      ProductId
      integer (int32)
      ExternalCode
      string
      VatCode
      string
      ExchangeFilterId1
      integer (int32)
      ExchangeFilterId2
      integer (int32)
      ExchangeFilterId3
      integer (int32)
      ExchangeFilterId4
      integer (int32)
      ExchangeFilterId5
      integer (int32)
      ExchangeFilterId6
      integer (int32)
      ExchangeFilterId7
      integer (int32)
      ExchangeFilterId8
      integer (int32)
      ExchangeFilterId9
      integer (int32)
      ExchangeFilterId10
      integer (int32)
      PreferredSupplierId
      integer (int32)
      SupplierId
      integer (int32)
      ClassificationLevel1Id
      integer (int32)
      CashRegisterGroupId
      integer (int32)
      BookmarkId
      integer (int32)
      ProductListId
      integer (int32)
      StockStoreId
      integer (int32)
      DateFrom
      string (date-time)
      DateTo
      string (date-time)
      PriceModificationType
      string
      Valid values[ "NotSpecified", "All", "NoSalePriceChanged", "NoSaleAndPurchasePriceChanged" ]
      OnlyCalculatedPrices
      string
      Valid values[ "All", "Yes", "No" ]
      FieldsToReturn
      string
      Valid values[ "Full", "NoJoin", "ItemId" ]
      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)
      productId
      integer (int32)
      replacementProductId
      integer (int32)
      externalProductId
      integer (int32)
      externalCode
      string
      organizationLastModifiedDateTime
      string (date-time)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      plu
      integer (int32)
      followupNumber
      integer (int32)
      searchText
      string
      description
      string
      alternateDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      cbsCode
      string
      classificationLevel1Id
      integer (int32)
      classificationLevel2Id
      integer (int32)
      classificationLevel3Id
      integer (int32)
      classificationLevel4Id
      integer (int32)
      classificationLevel5Id
      integer (int32)
      productCategoryId
      integer (int32)
      cashRegisterGroupId
      integer (int32)
      brandId
      integer (int32)
      subBrandId
      integer (int32)
      productCombinationGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      assortmentId
      integer (int32)
      articleGroupId
      integer (int32)
      sizeTypeId
      integer (int32)
      sizeId
      integer (int32)
      colorId
      integer (int32)
      storageLocation
      string
      defaultSaleAmount
      number (double)
      saleUnitDimensionId
      integer (int32)
      saleUnitPackageId
      integer (int32)
      consumerUnitToSaleUnitFactor
      number (double)
      relatedProductsType
      integer (int32)
      isNoSavings
      boolean
      Default"False"
      isNoDiscounts
      boolean
      Default"False"
      isNoDiscountOnDiscount
      boolean
      Default"False"
      isNoMixedMatchDiscount
      boolean
      Default"False"
      isNoQuantityPriceBreakDiscount
      boolean
      Default"False"
      isNoDiscountAgreementDiscount
      boolean
      Default"False"
      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)
      allowanceCode
      string
      allowanceAmount
      number (double)
      markingCodeType
      integer (int32)
      isTrackAndTraceProduct
      boolean
      Default"False"
      isAskForDescriptionInPos
      boolean
      Default"False"
      isAskForPriceInPos
      boolean
      Default"False"
      isPriceZeroAllowed
      boolean
      Default"False"
      isAllowDiscountPercentageModification
      boolean
      Default"False"
      isAllowPriceModification
      boolean
      Default"False"
      isSerialAdministration
      boolean
      Default"False"
      isAllowMultiplePricing
      boolean
      Default"False"
      isProductGroup
      boolean
      Default"False"
      isIncludeInStockValue
      boolean
      Default"False"
      isSale
      boolean
      Default"False"
      isConsignmentProduct
      boolean
      Default"False"
      isScaleIntegration
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      isCollection
      boolean
      Default"False"
      excludeFromPriceCalculation
      boolean
      Default"False"
      information
      string
      exchangeRemarks
      string
      vatCode
      string
      bookmarkId
      integer (int32)
      flag
      integer (int32)
      isForcePriceChangeAndBlock
      boolean
      Default"False"
      saleLedgerId
      integer (int32)
      freeTableId
      integer (int32)
      grossPrice
      number (double)
      advicePrice
      number (double)
      companyProductId
      integer (int32)
      productNumber
      integer (int64)
      productDescription
      string
      isPriceBlocked
      boolean
      Default"False"
      brandCode
      string
      brandDescription
      string
      preferredSupplierNumber
      integer (int64)
      preferredSupplierName
      string
      assortmentCode
      string
      assortmentDescription
      string
      assortmentTypeDescription
      integer (int32)
      classificationLevel1Description
      string
      classificationLevel1Code
      string
      classificationLevel2Description
      string
      classificationLevel2Code
      string
      classificationLevel3Description
      string
      classificationLevel3Code
      string
      classificationLevel4Description
      string
      classificationLevel4Code
      string
      classificationLevel5Description
      string
      classificationLevel5Code
      string
      productCategoryDescription
      string
      productCategoryCode
      string
      externalProductDescription
      string
      originalGrossPrice
      number (double)
      preferredExchangePurchaseId
      integer (int32)
      orderCode
      string
      purchasePrice
      number (double)
      grossPurchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      mainBarcode
      integer (int64)
      bookmark
      integer (int32)
      originalPurchasePrice
      number (double)
      originalGrossPurchasePrice
      number (double)
      originalOwnPurchasePrice
      number (double)
      calculatedGrossPrice
      number (double)
      excludeFromPriceCalculation1
      boolean
      Default"False"
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      productId
      integer (int32)
      replacementProductId
      integer (int32)
      externalProductId
      integer (int32)
      externalCode
      string
      organizationLastModifiedDateTime
      string (date-time)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      plu
      integer (int32)
      followupNumber
      integer (int32)
      searchText
      string
      description
      string
      alternateDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      cbsCode
      string
      classificationLevel1Id
      integer (int32)
      classificationLevel2Id
      integer (int32)
      classificationLevel3Id
      integer (int32)
      classificationLevel4Id
      integer (int32)
      classificationLevel5Id
      integer (int32)
      productCategoryId
      integer (int32)
      cashRegisterGroupId
      integer (int32)
      brandId
      integer (int32)
      subBrandId
      integer (int32)
      productCombinationGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      assortmentId
      integer (int32)
      articleGroupId
      integer (int32)
      sizeTypeId
      integer (int32)
      sizeId
      integer (int32)
      colorId
      integer (int32)
      storageLocation
      string
      defaultSaleAmount
      number (double)
      saleUnitDimensionId
      integer (int32)
      saleUnitPackageId
      integer (int32)
      consumerUnitToSaleUnitFactor
      number (double)
      relatedProductsType
      integer (int32)
      isNoSavings
      boolean
      Default"False"
      isNoDiscounts
      boolean
      Default"False"
      isNoDiscountOnDiscount
      boolean
      Default"False"
      isNoMixedMatchDiscount
      boolean
      Default"False"
      isNoQuantityPriceBreakDiscount
      boolean
      Default"False"
      isNoDiscountAgreementDiscount
      boolean
      Default"False"
      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)
      allowanceCode
      string
      allowanceAmount
      number (double)
      markingCodeType
      integer (int32)
      isTrackAndTraceProduct
      boolean
      Default"False"
      isAskForDescriptionInPos
      boolean
      Default"False"
      isAskForPriceInPos
      boolean
      Default"False"
      isPriceZeroAllowed
      boolean
      Default"False"
      isAllowDiscountPercentageModification
      boolean
      Default"False"
      isAllowPriceModification
      boolean
      Default"False"
      isSerialAdministration
      boolean
      Default"False"
      isAllowMultiplePricing
      boolean
      Default"False"
      isProductGroup
      boolean
      Default"False"
      isIncludeInStockValue
      boolean
      Default"False"
      isSale
      boolean
      Default"False"
      isConsignmentProduct
      boolean
      Default"False"
      isScaleIntegration
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      isCollection
      boolean
      Default"False"
      excludeFromPriceCalculation
      boolean
      Default"False"
      information
      string
      exchangeRemarks
      string
      vatCode
      string
      bookmarkId
      integer (int32)
      flag
      integer (int32)
      isForcePriceChangeAndBlock
      boolean
      Default"False"
      saleLedgerId
      integer (int32)
      freeTableId
      integer (int32)
      grossPrice
      number (double)
      advicePrice
      number (double)
      companyProductId
      integer (int32)
      productNumber
      integer (int64)
      productDescription
      string
      isPriceBlocked
      boolean
      Default"False"
      brandCode
      string
      brandDescription
      string
      preferredSupplierNumber
      integer (int64)
      preferredSupplierName
      string
      assortmentCode
      string
      assortmentDescription
      string
      assortmentTypeDescription
      integer (int32)
      classificationLevel1Description
      string
      classificationLevel1Code
      string
      classificationLevel2Description
      string
      classificationLevel2Code
      string
      classificationLevel3Description
      string
      classificationLevel3Code
      string
      classificationLevel4Description
      string
      classificationLevel4Code
      string
      classificationLevel5Description
      string
      classificationLevel5Code
      string
      productCategoryDescription
      string
      productCategoryCode
      string
      externalProductDescription
      string
      originalGrossPrice
      number (double)
      preferredExchangePurchaseId
      integer (int32)
      orderCode
      string
      purchasePrice
      number (double)
      grossPurchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      mainBarcode
      integer (int64)
      bookmark
      integer (int32)
      originalPurchasePrice
      number (double)
      originalGrossPurchasePrice
      number (double)
      originalOwnPurchasePrice
      number (double)
      calculatedGrossPrice
      number (double)
      excludeFromPriceCalculation1
      boolean
      Default"False"
      Array of object
      object
      itemId
      integer (int32)
      createdByUserId
      integer (int32)
      createdDateTime
      string (date-time)
      lastModifiedByUserId
      integer (int32)
      lastModifiedDateTime
      string (date-time)
      companyId
      integer (int32)
      productId
      integer (int32)
      replacementProductId
      integer (int32)
      externalProductId
      integer (int32)
      externalCode
      string
      organizationLastModifiedDateTime
      string (date-time)
      productType
      string
      Valid values[ "NotSpecified", "Default", "Giftcard", "Kitchen", "ProductGroup", "Consignation", "FreeEntry", "Collection", "ShippingCosts", "CashOnDelivery" ]
      plu
      integer (int32)
      followupNumber
      integer (int32)
      searchText
      string
      description
      string
      alternateDescription
      string
      note1
      string
      note2
      string
      note3
      string
      note4
      string
      cbsCode
      string
      classificationLevel1Id
      integer (int32)
      classificationLevel2Id
      integer (int32)
      classificationLevel3Id
      integer (int32)
      classificationLevel4Id
      integer (int32)
      classificationLevel5Id
      integer (int32)
      productCategoryId
      integer (int32)
      cashRegisterGroupId
      integer (int32)
      brandId
      integer (int32)
      subBrandId
      integer (int32)
      productCombinationGroupId
      integer (int32)
      preferredSupplierId
      integer (int32)
      assortmentId
      integer (int32)
      articleGroupId
      integer (int32)
      sizeTypeId
      integer (int32)
      sizeId
      integer (int32)
      colorId
      integer (int32)
      storageLocation
      string
      defaultSaleAmount
      number (double)
      saleUnitDimensionId
      integer (int32)
      saleUnitPackageId
      integer (int32)
      consumerUnitToSaleUnitFactor
      number (double)
      relatedProductsType
      integer (int32)
      isNoSavings
      boolean
      Default"False"
      isNoDiscounts
      boolean
      Default"False"
      isNoDiscountOnDiscount
      boolean
      Default"False"
      isNoMixedMatchDiscount
      boolean
      Default"False"
      isNoQuantityPriceBreakDiscount
      boolean
      Default"False"
      isNoDiscountAgreementDiscount
      boolean
      Default"False"
      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)
      allowanceCode
      string
      allowanceAmount
      number (double)
      markingCodeType
      integer (int32)
      isTrackAndTraceProduct
      boolean
      Default"False"
      isAskForDescriptionInPos
      boolean
      Default"False"
      isAskForPriceInPos
      boolean
      Default"False"
      isPriceZeroAllowed
      boolean
      Default"False"
      isAllowDiscountPercentageModification
      boolean
      Default"False"
      isAllowPriceModification
      boolean
      Default"False"
      isSerialAdministration
      boolean
      Default"False"
      isAllowMultiplePricing
      boolean
      Default"False"
      isProductGroup
      boolean
      Default"False"
      isIncludeInStockValue
      boolean
      Default"False"
      isSale
      boolean
      Default"False"
      isConsignmentProduct
      boolean
      Default"False"
      isScaleIntegration
      boolean
      Default"False"
      isCancelled
      boolean
      Default"False"
      isCollection
      boolean
      Default"False"
      excludeFromPriceCalculation
      boolean
      Default"False"
      information
      string
      exchangeRemarks
      string
      vatCode
      string
      bookmarkId
      integer (int32)
      flag
      integer (int32)
      isForcePriceChangeAndBlock
      boolean
      Default"False"
      saleLedgerId
      integer (int32)
      freeTableId
      integer (int32)
      grossPrice
      number (double)
      advicePrice
      number (double)
      companyProductId
      integer (int32)
      productNumber
      integer (int64)
      productDescription
      string
      isPriceBlocked
      boolean
      Default"False"
      brandCode
      string
      brandDescription
      string
      preferredSupplierNumber
      integer (int64)
      preferredSupplierName
      string
      assortmentCode
      string
      assortmentDescription
      string
      assortmentTypeDescription
      integer (int32)
      classificationLevel1Description
      string
      classificationLevel1Code
      string
      classificationLevel2Description
      string
      classificationLevel2Code
      string
      classificationLevel3Description
      string
      classificationLevel3Code
      string
      classificationLevel4Description
      string
      classificationLevel4Code
      string
      classificationLevel5Description
      string
      classificationLevel5Code
      string
      productCategoryDescription
      string
      productCategoryCode
      string
      externalProductDescription
      string
      originalGrossPrice
      number (double)
      preferredExchangePurchaseId
      integer (int32)
      orderCode
      string
      purchasePrice
      number (double)
      grossPurchasePrice
      number (double)
      ownPurchasePrice
      number (double)
      minimumOrderQuantity
      number (double)
      purchaseUnitToPurchaseContentUnitFactor
      number (double)
      mainBarcode
      integer (int64)
      bookmark
      integer (int32)
      originalPurchasePrice
      number (double)
      originalGrossPurchasePrice
      number (double)
      originalOwnPurchasePrice
      number (double)
      calculatedGrossPrice
      number (double)
      excludeFromPriceCalculation1
      boolean
      Default"False"
      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