The ProductComponent is used to group the product parts in a bundled product.
DeleteProductComponent
This service is used to delete a ProductComponent object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| productComponentID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetActiveProductComponent
This service is used to query the ProductComponent object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| productComponentID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| productComponent |
XML |
Container node. |
| createDate |
DateTime |
Creation date. |
| displayOrder |
Integer |
Sort order for display. |
| componentType |
Integer |
The type of component. Implicit = 1, Explicit = 2, Multiple = 3, Single = 4 |
| name |
XML Locale |
Localized name. |
| productComponentID |
Integer |
The object identifier. |
| productComponentKey |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| productVariantID |
Integer |
The product variant object identifier associated to this component. |
| updateDate |
DateTime |
Update date. |
GetActiveProductComponentsByProductVariant
This service is used to get all the ProductComponent objects belonging to the ProductVariant.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| productVariantID |
Yes |
Integer |
The ProductVariant object identifier. |
| skip |
No |
Integer |
The number of records to skip over for paging purposes. |
| take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
| Node |
Data Type |
Description |
| productComponents |
XML |
Container node |
| productComponent |
XML |
Zero or more productComponent nodes with same data structure as GetActiveProductComponent service return data. |
InsertProductComponent
This service is used to create a new ProductComponent object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| componentType |
Yes |
Integer |
The type of component. Implicit = 1, Explicit = 2, Multiple = 3, Single = 4 |
| name |
Yes |
XML Locale |
Localized name. |
| productComponentKey |
Yes |
String |
A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID. |
| productVariantID |
|
|
The reference ProductVariant identifier this ProductComponent belongs to. |
Return Data
Same as GetActiveProductComponent service return data.