A ProductAttribute is the attribute value defined for a product or product variant usually seen under the specifications tab in the product detail page.
DeleteProductAttribute
This service is used to delete a ProductAttribute object.
Request Parameters
Node |
Required |
Data Type |
Description |
productAttributeID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetProductAttribute
This service is used to query the ProductAttribute object.
Request Parameters
Node |
Required |
Data Type |
Description |
productAttributeID |
Yes |
Integer |
The object identifier. |
Return Data
Node |
Data Type |
Description |
productAttribute |
XML |
Container node. |
booleanValue |
Boolean |
Boolean type value. |
createDate |
DateTime |
Creation date. |
decimalValue |
Decimal |
Decimal type value. |
integerValue |
Integer |
Integer type value. |
productAttributeDefinitionID |
Integer |
The ProductAttributeDefinition object identifier.
|
productAttributeID |
Integer |
The object identifier. |
productID |
Integer |
The Product object identifier if attribute belongs to product. |
productVariantID |
Integer |
The ProductVariant object identifier if attribute belongs to product variant. |
selectionValue |
String |
Pipe delimited list of integer selection values. |
stringValue |
XML Locale |
Localized string type value. |
updateDate |
DateTime |
Update date. |
GetProductAttributesByProduct
This service is used to get all the ProductAttribute objects belonging to the product.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if the return data should include the total number of records found. |
productID |
Yes |
Integer |
The Product object identifier. |
skip |
No |
Integer |
The number of records to skip for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
productAttributes |
XML |
Container node |
productAttribute |
XML |
Zero or more productAttribute nodes with same data structure as GetProductAttribute service return data. |
GetProductAttributesByProductVariant
This service is used to get all the ProductAttribute objects belonging to the product variant.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if the return data should include the total number of records found. |
productVariantID |
Yes |
Integer |
The ProductVariant object identifier. |
skip |
No |
Integer |
The number of records to skip for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
productAttributes |
XML |
Container node |
productAttribute |
XML |
Zero or more productAttribute nodes with same data structure as GetProductAttribute service return data. |
InsertProductAttribute
This service is used to create a new ProductAttribute object.
Request Parameters
Node |
Required |
Data Type |
Description |
booleanValue |
No |
Boolean |
Boolean type value. If you specify a value here, you must not specify the decimalValue, integerValue, selectionValue or stringValue. |
decimalValue |
No |
Decimal |
Decimal type value. If you specify a value here, you must not specify the booleanValue, integerValue, selectionValue or stringValue. |
integerValue |
No |
Integer |
Integer type value. If you specify a value here, you must not specify the booleanValue, decimalValue, selectionValue or stringValue. |
productAttributeDefinitionID |
Yes |
Integer |
The ProductAttributeDefinition object identifier. |
productID |
No |
Integer |
The Product object identifier if attribute belongs to product. If you specify the productID, you must not specify the productVariantID. |
productVariantID |
No |
Integer |
The ProductVariant object identifier if attribute belongs to product variant. If you specify the productVariantID, you must not specify the productID. |
selectionValue |
No |
String |
Pipe delimited list of integer selection values. Value must correspond to the possible ProductAttributeDefinitionSelectionID values. If you specify a value here, you must not specify the booleanValue, decimalValue, integerValue or stringValue. |
stringValue |
No |
XML Locale |
Localized string type value. If you specify a value here, you must not specify the booleanValue, decimalValue, integerValue or selectionValue. |
Return Data
Same as GetProductAttribute service return data.