Product
Product:
Id
long
Identifier for the product.
BodyHtml
string
HTML content for the product's body.
Handle
string
Handle for the product, typically used in URLs.
BasePartNumber
string
The base part number of the product.
CategoryId
int?
Identifier for the product's category.
ProductCategoryName
string
Name of the product's category.
Title
string
The title of the product.
Options
List<Option>
List of product options.
ActiveFlag
bool
Flag indicating if the product is active.
CreateDttm
DateTime
Creation date and time of the product.
CreateSource
string
Source of the product's creation.
ModifyDttm
DateTime?
Modification date and time of the product.
ModifySource
string
Source of the product's modification.
Variants
List<ItemMaster>
List of product variants (items).
ItemMaster:
BasePartNumber
string
The base part number.
Title
string
The title of the item.
Option1Name
string
Name of option 1 for the item.
Option1Value
string
Value of option 1 for the item.
Option1ValueCode
string
Code related to option 1 value.
Option1Seq
int?
Sequence number for option 1.
Option2Name
string
Name of option 2 for the item.
Option2Value
string
Value of option 2 for the item.
Option2ValueCode
string
Code related to option 2 value.
Option2Seq
int?
Sequence number for option 2.
Option3Name
string
Name of option 3 for the item.
Option3Value
string
Value of option 3 for the item.
Option3ValueCode
string
Code related to option 3 value.
Option3Seq
int?
Sequence number for option 3.
UseImageForProductPreviewFlag
bool
Flag indicating if an image is used for preview.
Id
long
Identifier for the item.
ItemNumber
string
The item's unique number.
Description
string
Description of the item.
ItemBarcode
string
Barcode of the item.
ItemUpc
string
UPC (Universal Product Code) of the item.
ItemTypeName
string
Type name of the item.
ProductCategoryId
int?
Identifier for the product category.
ItemProductCategoryName
string
Name of the product category for the item.
StandardUnitPrice
double
Standard unit price of the item.
CustomPrice1
double?
Custom price 1 for the item.
CustomPrice2
double?
Custom price 2 for the item.
CustomPrice3
double?
Custom price 3 for the item.
CustomPrice4
double?
Custom price 4 for the item.
CustomPrice5
double?
Custom price 5 for the item.
CustomPrice6
double?
Custom price 6 for the item.
CustomPrice7
double?
Custom price 7 for the item.
CustomPrice8
double?
Custom price 8 for the item.
CustomPrice9
double?
Custom price 9 for the item.
CustomPrice10
double?
Custom price 10 for the item.
CustomPrice11
double?
Custom price 11 for the item.
CustomPrice12
double?
Custom price 12 for the item.
CustomPrice13
double?
Custom price 13 for the item.
CustomPrice14
double?
Custom price 14 for the item.
StandardUnitCost
double
Standard unit cost of the item.
SellUomCode
string
Sell unit of measure code.
ActiveFlag
bool
Flag indicating if the item is active.
ActiveFlagStr
string
String representation of active flag.
IsSellableFlag
bool
Flag indicating if the item is sellable.
IsSellableFlagStr
string
String representation of sellable flag.
IsPurchasableFlag
bool
Flag indicating if the item is purchasable.
IsPurchasableFlagStr
string
String representation of purchasable flag.
ReturnableFlag
bool
Flag indicating if the item is returnable.
ReturnableFlagStr
string
String representation of returnable flag.
ManufactureItemFlag
bool
Flag indicating if the item is a manufactured item.
IsBomItemFlag
bool
Flag indicating if the item is a BOM (Bill of Materials) item.
ManufactureItemFlagStr
string
String representation of manufacture item flag.
IsRawMaterialFlag
bool
Flag indicating if the item is a raw material.
IsRawMaterialFlagStr
string
String representation of raw material flag.
DefaultVendorName
string
Name of the default vendor for the item.
AssetAccountName
string
Name of the asset account associated with the item.
CogsAccountName
string
Name of the COGS (Cost of Goods Sold) account associated with the item.
LastLandedUnitCost
double?
Last landed unit cost of the item.
LastLandedUnitHomeCurrency
double?
Last landed unit cost in the home currency.
LastReceiptDate
DateTime?
Date of the last receipt for the item.
LastReceiptCurrencyCode
string
Currency code of the last receipt.
LastReceiptReconcileFlag
bool?
Flag indicating if the last receipt was reconciled.
OptionArray
List<OptionValue>
List of option values for the item.
ProductImages
List<EntityImage>
List of product images for the item.
SeasonIdList
List<int>
List of season IDs associated with the item.
IsProducibleFlag
bool
Flag indicating if the item is producible.
IsProducibleFlagStr
string
String representation of producible flag.
TaxCategoryCode
string
Tax category code for the item.
IsRestrictToPurchaseFlag
bool
Flag indicating if the item is restricted to purchase.
IsRestrictToPurchaseFlagStr
string
String representation of restricted to purchase flag.
BaseUomCode
string
Base unit of measure code.
PurchaseUomCode
string
Purchase unit of measure code.
UniqueId
string
Unique identifier for the item.
AllowedPurchaseUomIdList
List<int>
List of allowed purchase UOM IDs for the item.
AllowedSellUomIdList
List<int>
List of allowed sell UOM IDs for the item.
AllowedPurchaseUomNameList
List<string>
List of allowed purchase UOM names for the item.
AllowedSellUomNameList
List<string>
List of allowed sell UOM names for the item.
UpdateDefaultItemImage
bool
Flag indicating if the default item image should be updated.
ThirdPartySource
string
Source of the third party for the item.
ThirdPartyDisplayName
string
Display name of the third party for the item.
ThirdPartyIconUrl
string
URL of the icon for the third party item.
ShowItemPreviewSubForm
bool
Flag indicating if the item preview sub-form should be shown.
InventoryTabAccessPortalSubForm
bool
Flag indicating if the inventory tab access portal sub-form should be shown.
UomFactor
double?
Unit of measure factor for conversion.
CBM
double?
Cubic meter (CBM) value for the item.
SearchKeywords
string
Keywords for searching the item.
LastUnitCost
double?
Last unit cost of the item.
LastPurchasedQty
double?
Last purchased quantity of the item.
LastLandedUnitCost
double?
Last landed unit cost of the item.
LastLandedUnitHomeCurrency
double?
Last landed unit cost in home currency.
LastReceiptDate
DateTime?
Date of the last receipt for the item.
LastReceiptCurrencyCode
string
Currency code of the last receipt.
LastReceiptReconcileFlag
bool?
Flag indicating if the last receipt reconciled.
IsTransferableFlag
bool
Flag indicating if the item is transferable.
IsTransferableFlagStr
string
String representation of transferable flag.
ForceSalesTaxCode
bool
Flag indicating if a sales tax code is forced.
ForceSalesTaxCodeStr
string
String representation of forced sales tax code flag.
PriceNotAvailable
bool
Flag indicating if the price is not available.
ProjectClassId
int?
Identifier for the project class.
ProjectClassName
string
Name of the project class.
AlternativeItemNumber1
string
Alternative item number 1.
AlternativeItemNumber2
string
Alternative item number 2.
AlternativeItemNumber3
string
Alternative item number 3.
IsPreSellFlag
bool
Flag indicating if the item is for pre-selling.
IsPreSellFlagStr
string
String representation of pre-sell flag.
AverageUnitCost
double?
Average unit cost of the item.
DiscontinuedDate
DateTime?
Date when the item was discontinued.
TrackingBySerialNumberFlag
bool
Flag indicating if the item is tracked by serial number.
TrackingBySerialNumberFlagStr
string
String representation of tracking by serial number flag.
CustomFieldH1 - CustomFieldH50
string
Custom Fields (CustomFieldH1 - CustomFieldH50).
Option:
Id
int
Identifier for the option.
Name
string
The name of the option.
Position
int
The position of the option.
Values
List<OptionValue>
List of values associated with the option.
ValueArr
List<string>
List of string values associated with the option.
OptionValue:
Id
int
Identifier for the option value.
OptionId
int
Identifier for the parent option of the value.
Name
string
The name of the option value.
Code
string
The code associated with the option value.
Seq
int
The sequence number of the option value.
{
"BodyHtml": "Test Html",
"BasePartNumber": "Tshirt1",
"Handle": "Tshirt1",
"CategoryName": null,
"Title": "Tshirt1",
"Options": [
{
"Name": "Color",
"Position": 1,
"Values": [
{
"Name": "Pink",
"Code": "PNK",
"Seq": 1
},
{
"Name": "Blue",
"Code": "BL",
"Seq": 2
}
],
"ValueArr": []
},
{
"Name": "Size",
"Position": 2,
"Values": [
{
"Name": "Small",
"Code": "SM",
"Seq": 1
},
{
"Name": "Medium",
"Code": "MED",
"Seq": 2
}
],
"ValueArr": []
}
],
"ActiveFlag": true,
"Variants": [
{
"ItemNumber": "AA-105-1",
"Description": "AQUA ART: 16 X 16 X 7 SQUARE UNDERMOUNT CERAMIC SINK WHITE",
"ItemBarcode": "",
"HSCode": "",
"CooCodeIso2": "",
"ItemUpc": "",
"Tags": "",
"IsTaxableFlagStr": "Y",
"IsSellableFlagStr": "Y",
"IsPurchasableFlagStr": "Y",
"IsRawMaterialFlagStr": "Y",
"IsTransferableFlagStr": "N",
"ItemTypeName": "Inventory",
"IsBomItemFlagStr": "N",
"SellUomName": "Each",
"StandardUnitPrice": 140,
"AssetAccountName": "Inventory Asset",
"CogsAccountName": "Bathroom Sinks",
"AdjAccountName": "Inventory Adjustment Account",
"IncomeAccountName": "Bathroom Sinks [R]",
"ExpenseAccountName": "",
"WipAccountName": "",
"SizeUomName": "Each",
"WeightUomName": "Kilogram",
"StandardUnitCost": 35,
"ImagePath": "",
"Weight": null,
"Length": null,
"Width": null,
"Height": null,
"AlertNote": "",
"WebUrl": "",
"HazmatName": "",
"SellPkgQty": 1,
"ReOrderPointQty": 0,
"ReOrderQty": 0,
"ActiveFlagStr": "Y",
"SaleTaxCode": "E",
"PurchaseTaxCode": "S",
"BrandName": "Aqua Art",
"GroupName": "",
"CategoryName": "",
"ReturnableFlagStr": "Y",
"IsTaxableOnSaleStr": "Y",
"IsTaxableOnPurchaseStr": "N",
"SalesNotes": "",
"PurchaseNotes": "",
"Option1Value": "Pink",
"Option2Value": "Medium",
"CustomFieldH1": null,
"CustomFieldH10": null,
"CustomFieldH11": null,
"CustomFieldH12": null,
"CustomFieldH13": null,
"CustomFieldH14": null,
"CustomFieldH15": null,
"CustomFieldH16": null,
"CustomFieldH17": null,
"CustomFieldH18": null,
"CustomFieldH19": null,
"CustomFieldH2": null,
"CustomFieldH20": null,
"CustomFieldH21": null,
"CustomFieldH22": null,
"CustomFieldH23": null,
"CustomFieldH24": null,
"CustomFieldH25": null,
"CustomFieldH26": null,
"CustomFieldH27": null,
"CustomFieldH28": null,
"CustomFieldH29": null,
"CustomFieldH3": null,
"CustomFieldH30": null,
"CustomFieldH31": null,
"CustomFieldH32": null,
"CustomFieldH33": null,
"CustomFieldH34": null,
"CustomFieldH35": null,
"CustomFieldH36": null,
"CustomFieldH37": null,
"CustomFieldH38": null,
"CustomFieldH39": null,
"CustomFieldH4": null,
"CustomFieldH40": null,
"CustomFieldH41": null,
"CustomFieldH42": null,
"CustomFieldH43": null,
"CustomFieldH44": null,
"CustomFieldH45": null,
"CustomFieldH46": null,
"CustomFieldH47": null,
"CustomFieldH48": null,
"CustomFieldH49": null,
"CustomFieldH5": null,
"CustomFieldH50": null,
"CustomFieldH6": null,
"CustomFieldH7": null,
"CustomFieldH8": null,
"CustomFieldH9": null
}
]
}
Last updated