CrosssellProduct is the object relationship associating cross-sell products together.
DeleteCrosssellProduct
This service is used to delete a CrosssellProduct object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| crosssellProductID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetCrosssellProduct
This service is used to query the CrosssellProduct object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| crosssellProductID |
Yes |
Integer |
The object identifier. |
Return Data
| Node |
Data Type |
Description |
| crosssellProduct |
XML |
Container node. |
| active |
Boolean |
|
| availabilityRule |
XML Rule |
The rule to describe the conditions when the offer can be purchased. |
| createDate |
DateTime |
Creation date. |
| crosssellProductID |
Integer |
The object identifier. |
| description |
XML Locale |
The description to provide an explanation for the offer. |
| displayOrder |
Integer |
Sort order for display. |
| offerProductID |
Integer |
The Product object identifier offered. |
| portalID |
Integer |
|
| productID |
Integer |
Product object identifier in this relation. If null, the cross-sell product is offered for any purchase. |
| startDate |
DateTime |
The start date when the offer is available for purchase. |
| stopDate |
DateTime |
The stop date when the offer is no longer available for purchase. |
| title |
XML Locale |
The offer title to grab the customer's attention. |
| updateDate |
DateTime |
Update date. |
GetCrosssellProductsByProduct
This service is used to get all the CrosssellProduct objects belonging to the product.
Request Parameters
| Node |
Required |
Data Type |
Description |
| count |
No |
Boolean |
Specify if return data should include total number of records found. |
| productID |
No |
Integer |
The Product object identifier. If null, the cross-sell product is offered for any purchase. |
| 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 |
| totalCount |
Integer |
Number of records found. |
| crosssellProducts |
XML |
Container node |
| crosssellProduct |
XML |
Zero or more crosssellProduct nodes with same data structure as GetCrosssellProduct service return data. |
InsertCrosssellProduct
This service is used to create a new CrosssellProduct object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| active |
Yes |
Boolean |
|
| availabilityRule |
No |
XML Rule |
The rule to describe the conditions when the offer can be purchased. |
| description |
No |
XML Locale |
The description to provide an explanation for the offer. |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| offerProductID |
Yes |
Integer |
The Product object identifier offered. |
| productID |
No |
Integer |
The Product object identifier. If null, the cross-sell product is offered for any purchase. |
| startDate |
No |
DateTime |
The start date when the offer is available for purchase. |
| stopDate |
No |
DateTime |
The stop date when the offer is no longer available for purchase. |
| title |
No |
XML Locale |
The offer title to grab the customer's attention. |
Return Data
Same as GetCrosssellProduct service return data.
UpdateCrosssellProduct
This service is used to update the CrosssellProduct object.
Request Parameters
| Node |
Required |
Data Type |
Description |
| active |
Yes |
Boolean |
|
| availabilityRule |
No |
XML Rule |
The rule to describe the conditions when the offer can be purchased. |
| crosssellProductID |
Yes |
Integer |
The object identifier. |
| description |
No |
XML Locale |
The description to provide an explanation for the offer. |
| displayOrder |
Yes |
Integer |
Sort order for display. |
| offerProductID |
Yes |
Integer |
The Product object identifier offered. |
| productID |
No |
Integer |
The Product object identifier. If null, the cross-sell product is offered for any purchase. |
| startDate |
No |
DateTime |
The start date when the offer is available for purchase. |
| stopDate |
No |
DateTime |
The stop date when the offer is no longer available for purchase. |
| title |
No |
XML Locale |
The offer title to grab the customer's attention. |
Return Data
Same as GetCrosssellProduct service return data.