/v23.1/ExchangeProducts
  • 05 Jun 2024
  • 5 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/ExchangeProducts

  • Dark
    Light
  • PDF

Article summary

Post
/v23.1/ExchangeProducts
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
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)
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)
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)
Responses
200

Success

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

Bad Request

Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
string
Expand All
object
type
string
message
string
stackTrace
string
validationExceptions
Array of object (ValidationExceptionRow)
object
errorCode
string
errorMessage
string
severity
string
propertyName
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

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
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.