article
PUT /article/id/{id}
Changed onupdate article
Request
- Base URLhttps://www.weclapp.com/api/nullapi/v2
- AuthAPI key in header AuthenticationToken
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Query parameters
dryRunboolean
Request body
idstring
versionstring
accountIdstring
accountingCodeIdstring
activeboolean
applyCashDiscountboolean
articleCategoryIdstring
articleGrossWeightstring number
articleHeightstring number
articleLengthstring number
articleNetWeightstring number
articleNumberstring
articleType'BASIC' | 'LOADING_EQUIPMENT' | 'LOADING_EQUIPMENT_STORABLE' | 'PACKAGING_UNIT' | 'SALES_BILL_OF_MATERIAL' | 'SERVICE' | 'SERVICE_QUOTA' | 'SHIPPING_COST' | 'STORABLE'
articleWidthstring number
availableForSalesChannelsstring[]
availableInSaleboolean
averageDeliveryTimeinteger
barcodestring
batchNumberRequiredboolean
billOfMaterialPartDeliveryPossibleboolean
catalogCodestring
commissionRatestring number
contractBillingCycle'DAILY' | 'FIVE_YEARLY' | 'FOUR_YEARLY' | 'HALF_YEARLY' | 'MONTHLY' | 'NONE' | 'QUARTER' | 'THREE_YEARLY' | 'TWO_YEARLY' | 'WEEKLY' | 'YEARLY'
contractBillingMode'NON_RECURRENT' | 'RECURRENT'
countryOfOriginCode'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UNKNOWN' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'
createdDateinteger
customsDescriptionstring
customsTariffNumberIdstring
defaultLoadingEquipmentIdentifierIdstring
defaultPriceCalculationType'MARGIN_CALCULATION' | 'PURCHASE' | 'RECOMMENDED_RETAIL_PRICE' | 'SALES'
defineIndividualTaskTemplatesboolean
descriptionstring
eanstring
expenseAccountIdstring
expirationDaysinteger
fixedPurchaseQuantitystring number
internalNotestring
invoicingType'EFFORT' | 'FIXED_PRICE'
lastModifiedDateinteger
launchDateinteger
loadingEquipmentArticleIdstring
longTextstring
lowLevelCodeinteger
manufacturerIdstring
manufacturerPartNumberstring
marginCalculationPriceType'ARTICLE_CALCULATION_PRICE' | 'EMPLOYEE_COST' | 'MOVING_AVERAGE' | 'PURCHASE_PRICE_PRODUCTION_COST'
matchCodestring
minimumPurchaseQuantitystring number
minimumStockQuantitystring number
namestring required
packagingQuantityinteger
packagingUnitBaseArticleIdstring
packagingUnitParentArticleIdstring
plannedWorkingTimePerUnitinteger
primarySupplySourceIdstring
procurementLeadDaysinteger
producerTypestring
productionArticleboolean
productionConfigurationRule'ALL_COMPONENTS' | 'AT_LEAST_ONE_COMPONENT' | 'AT_LEAST_ONE_COMPONENT_WITH_VARIABLE_QUANTITY' | 'ONE_COMPONENT' | 'ONE_COMPONENT_WITH_VARIABLE_QUANTITY'
purchaseCostCenterIdstring
ratingIdstring
recordItemGroupNamestring
safetyStockDaysinteger
salesCostCenterIdstring
sellByDateinteger
sellFromDateinteger
serialNumberRequiredboolean
serviceArticleForServiceQuotaBookingIdstring
serviceQuotaQuantitystring number
shortDescription1string
shortDescription2string
showOnDeliveryNoteboolean
statusIdstring
supportUntilDateinteger
systemCodestring
tagsstring[]
targetStockQuantitystring number
taxRateType'REDUCED' | 'SLIGHTLY_REDUCED' | 'STANDARD' | 'SUPER_REDUCED' | 'ZERO'
unitIdstring
useAvailableForSalesChannelsboolean
useSalesBillOfMaterialItemPricesboolean
useSalesBillOfMaterialItemPricesForPurchaseboolean
useSalesBillOfMaterialSubitemCostsboolean
Response
article update response
idstring
versionstring
accountIdstring
accountingCodeIdstring
activeboolean
applyCashDiscountboolean
articleCategoryIdstring
articleGrossWeightstring number
articleHeightstring number
articleLengthstring number
articleNetWeightstring number
articleNumberstring
articleType'BASIC' | 'LOADING_EQUIPMENT' | 'LOADING_EQUIPMENT_STORABLE' | 'PACKAGING_UNIT' | 'SALES_BILL_OF_MATERIAL' | 'SERVICE' | 'SERVICE_QUOTA' | 'SHIPPING_COST' | 'STORABLE'
articleWidthstring number
availableForSalesChannelsstring[]
availableInSaleboolean
averageDeliveryTimeinteger
barcodestring
batchNumberRequiredboolean
billOfMaterialPartDeliveryPossibleboolean
catalogCodestring
commissionRatestring number
contractBillingCycle'DAILY' | 'FIVE_YEARLY' | 'FOUR_YEARLY' | 'HALF_YEARLY' | 'MONTHLY' | 'NONE' | 'QUARTER' | 'THREE_YEARLY' | 'TWO_YEARLY' | 'WEEKLY' | 'YEARLY'
contractBillingMode'NON_RECURRENT' | 'RECURRENT'
countryOfOriginCode'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UNKNOWN' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'
createdDateinteger
customsDescriptionstring
customsTariffNumberIdstring
defaultLoadingEquipmentIdentifierIdstring
defaultPriceCalculationType'MARGIN_CALCULATION' | 'PURCHASE' | 'RECOMMENDED_RETAIL_PRICE' | 'SALES'
defineIndividualTaskTemplatesboolean
descriptionstring
eanstring
expenseAccountIdstring
expirationDaysinteger
fixedPurchaseQuantitystring number
internalNotestring
invoicingType'EFFORT' | 'FIXED_PRICE'
lastModifiedDateinteger
launchDateinteger
loadingEquipmentArticleIdstring
longTextstring
lowLevelCodeinteger
manufacturerIdstring
manufacturerPartNumberstring
marginCalculationPriceType'ARTICLE_CALCULATION_PRICE' | 'EMPLOYEE_COST' | 'MOVING_AVERAGE' | 'PURCHASE_PRICE_PRODUCTION_COST'
matchCodestring
minimumPurchaseQuantitystring number
minimumStockQuantitystring number
namestring required
packagingQuantityinteger
packagingUnitBaseArticleIdstring
packagingUnitParentArticleIdstring
plannedWorkingTimePerUnitinteger
primarySupplySourceIdstring
procurementLeadDaysinteger
producerTypestring
productionArticleboolean
productionConfigurationRule'ALL_COMPONENTS' | 'AT_LEAST_ONE_COMPONENT' | 'AT_LEAST_ONE_COMPONENT_WITH_VARIABLE_QUANTITY' | 'ONE_COMPONENT' | 'ONE_COMPONENT_WITH_VARIABLE_QUANTITY'
purchaseCostCenterIdstring
ratingIdstring
recordItemGroupNamestring
safetyStockDaysinteger
salesCostCenterIdstring
sellByDateinteger
sellFromDateinteger
serialNumberRequiredboolean
serviceArticleForServiceQuotaBookingIdstring
serviceQuotaQuantitystring number
shortDescription1string
shortDescription2string
showOnDeliveryNoteboolean
statusIdstring
supportUntilDateinteger
systemCodestring
tagsstring[]
targetStockQuantitystring number
taxRateType'REDUCED' | 'SLIGHTLY_REDUCED' | 'STANDARD' | 'SUPER_REDUCED' | 'ZERO'
unitIdstring
useAvailableForSalesChannelsboolean
useSalesBillOfMaterialItemPricesboolean
useSalesBillOfMaterialItemPricesForPurchaseboolean
useSalesBillOfMaterialSubitemCostsboolean
Changes
- info
added the new optional
queryrequest parameterdryRun
- info