Please refer to the API documentation section for the most up-to-date information
https://developer.finaleinventory.com/reference/start
--
Fields for the product resource.
-
actionUrlActivate
Post to this URL to change the status from inactive to active. Read only.
-
actionUrlDeactivate
Post to this URL to change the status from active to inactive. Read-only.
-
caliberString
Caliber is encoded with the physical dimension as a floating point number of millimeters followed by a space followed by a human-readable representation. For example:
0.076 3"
or0.022 22mm
. Read and write. -
category
The internal label for the modern dynamic category on that product, the available categories can be found in the (http://www.finaleinventory.com/developer/resource/customization)[customization] service on the productTypeList.optionList field.
-
userCategory
The internal name for the legacy user-defined category selected from a list defined in the productUserCategoryList field of the (http://www.finaleinventory.com/developer/resource/customization)[customization] service. Read and write.
-
categoryEnum
The choreography tab field in the user interface. Must be one of the following values:
##shells
,##comets
,##mines
,##multishot
,##cakes
,##fountains
, or##nonChoreographed
. Read and write. -
ceNumber
CE Mark number. Read and write.
-
chainNumberOfDevices
If the firework is chain, then the number of shells in the firework. Null if the product is not a chain. Read and write.
-
containerId
Standard/default bin id.
-
contentList
-
cost
Item cost field specified as a floating point number. Read and write.
-
createdDate
Timestamp object was created. Set automatically by the server. Read only.
-
distanceUomId
Unit of measure for effectWidth, effectHeight, and safetyDistance fields. Must be one of the following values:
LEN_ft
,LEN_yd
, orLEN_m
. Read and write. -
duration
Duration for firework specified as a floating point number of seconds. Read and write.
-
effectHeight
Effect height field specified as a floating point number. Read and write.
-
effectWidth
Effect width field specified as a floating point number. Read and write.
-
exNumberList
EX Number(s) field represented as a list of strings. Example:
['2008040132', '2004110899']
. Read and write. -
glAccountList
Array of values for general ledger accounts for the product.
-
hazardousMatId
UN/NA number specified as UNXXXX where XXXX is the four digit numeric identifier (e.g.
UN0335
for Fireworks 1.3G). Read and write. -
internalName
Description field from the user interface. Read and write.
-
lastUpdatedDate
Timestamp object was last modified. Set automatically by the server. Read only.
-
longDescription
Notes field from the user interface. Read and write.
-
manufacturerCountryGeoId
Manufacture country identified with three letter code using ISO 3166-1 alpha-3. Read and write.
-
manufacturerMark
Manufacturer mark. Read and write.
-
manufacturerName
Manufacturer name. Read and write.
-
manufacturerProductId
Manufacturer product ID field. Read and write.
-
netExplosiveMass
Net explosive quantity per item expressed as a floating point number. Read and write.
-
normalizedPackingString
Std packing field represented as the count of items per packed container followed by a space followed by a human readable representation. For example
12 cs 12/1
or48 cs 8/6
. Read and write. -
prefire
Prefire time for firework specified as a floating point number of seconds. Read and write.
-
priceList
List of price records specified for the product. Each price record is a dictionary with keys price, currencyUomId, and productPriceTypeId. The price is a floating point number. The currencyUomId currently must always be
USD
. The productPriceTypeId must be eitherLIST_PRICE
for the per item price orLIST_CASE_PRICE
for the per case price. Example valid priceList:[{currencyUomId:'USD', productPriceTypeId:'LIST_PRICE', price:12.45}, {currencyUomId:'USD', productPriceTypeId:'LIST_CASE_PRICE', price:32.32}]
. Read and write -
productTypeId
The type of product as defined in the productTypeList field of the customization service. Currently always returns the value
GOOD
, but may contain other values in the future. Read only. -
productUrl
Primary key for the product resource. Read only
-
quantityUomId
The internal name for the unit of measure selected from list defined in the productUserUnitOfMeasureList field of the customization service. Read and write.
-
reorderGuidelineList
-
safetyDistance
Safety distance field specified as a floating point number. Read and write.
-
statusId
Status of the product. Must by one of the following values:
PRODUCT_ACTIVE
orPRODUCT_INACTIVE
. Read and write. -
supplierList
List of supplier records specified for the product. Each supplier record is a dictionary with keys price, currencyUomId, supplierPrefOrderId, supplierProductId, generalComments, leadTime, and supplierPartyUrl. The price and leadTime are floating point number. The currencyUomId currently must always be
USD
. The supplierPrefOrderId must be null which corresponds to the Std buy price field in the user interface or one of the string values10_MAIN_SUPPL
,90_ALT_SUPPL
, or91_ALT_SUPPL2
which corresponed to the supplier 1, supplier 2, and supplier 3 fields in the user interface. The supplierProductId is the supplier specific product identifier that can be up to 60 Unicode characters. The generalComments field can be up to 255 Unicode characters. The supplierPartyUrl must be a partyUrl of a supplier defined in the partygroup collection or can null. Example valid supplierList:[{currencyUomId:'USD', supplierPrefOrderId:null, supplierPartyUrl:null, price:12.45}, {currencyUomId:'USD', supplierPartyUrl:'/dev/api/partygroup/10000', price:32.32}]
. Read and write -
taxEnumId
-
userCategory - (repeated from above)
The internal name for the legacy user-defined category selected from a list defined in the productUserCategoryList field of the customization service. Read and write.
-
userFieldDataList
Array of values for user defined fields on the Product. Each value in the array is an object with the keys attrName and attrValue. The attrName is the internal name of a user defined field as listed in the customization service. Other systems integrating with Finale can store information in the userFieldDataList. Other systems should prefix their attrName with the string "integration_" to avoid conflicting with keys created by Finale. The attrValue is the string representation of the value for this Product for the user defined field. Both are limited to 255 Unicode characters. To make tracking and syncing changes to other systems, the field attrValueLastUpdatedDate be set instead of the field attrValue. When attrValue is not set and attrValueLastUpdatedDate is set to true, then the server sets the value to same value as the lastUpdatedDate. This allows easy searching for entities that have been updated since the last time they were synced to an external system.
Example:
userFieldDataList:[ {attrName:'user_10000', attrValue:'7/2/2010'}, {attrName:'integration_10004', attrValue:'3/12/2011'} ]
-
weight
Weight per item expressed as a floating point number. Read and write.
-
weightUomId
Unit of measure for weight and netExplosiveMass fields. Must be one of the following values:
WT_lb
,WT_oz
,WT_gr
,WT_kg
,WT_g
, orWT_mg
. Read and write.
Comments
0 comments
Article is closed for comments.