Search

Contents

Revindex Storefront

Export Print

RequiredProduct

RequiredProduct is the object relationship associating two required products together.

DeleteRequiredProduct

This service is used to delete a RequiredProduct object.

Request Parameters

Node Required Data Type Description
requiredProductID Yes Integer The object identifier.

Return Data

None


GetRequiredProduct

This service is used to query the RequiredProduct object.

Request Parameters

Node Required Data Type
Description
requiredProductID Yes Integer
The object identifier.

Return Data

Node Data Type Description
requiredProduct XML
Container node.
  createDate DateTime Creation date.
  deferDate
DateTime Defer the start of the required product until the date specified.
  deferInterval
Integer Defer the start of the required product by the amount of interval time. Enter zero to start immediately.
  deferIntervalType Integer The interval type for the deferral. Day = 1, Week = 2, Month = 3, Year = 4
  productVariantID
Integer The ProductVariant object identifier.

  published Boolean Determine if the required product is disclosed to the customer.

  quantity   A non-zero value will match the quantity ordered (e.g. if you set a value of 2 and the customers places an order for 2 items, the total required products will equal 4). Enter a value of 1 if you want to have a one to one match. If you want a single required product regardless of any number of items purchased, enter a value of 0.

  requiredProductID
Integer The object identifier.
  requiredProductVariantID
Integer The ProductVariant object identifier required by the productVariantID.
  updateDate DateTime


GetRequiredProductsByProductVariant

This service is used to get all the RequiredProduct objects belonging to the product.

Request Parameters

Node Required Data Type
Description
productVariantID Yes Integer
The ProductVariant object identifier.

Return Data

Node Data Type Description
requiredProducts XML Container node
  requiredProduct XML
Zero or more requiredProduct nodes with same data structure as GetRequiredProduct service return data.

 


InsertRequiredProduct

This service is used to create a new RequiredProduct object.

Request Parameters

Node Required Data Type Description
deferDate

No DateTime Defer the start of the required product until the date specified.
deferInterval
Yes Integer Defer the start of the required product by the amount of interval time. Enter zero to start immediately.
deferIntervalType
Yes Integer The interval type for the deferral. Day = 1, Week = 2, Month = 3, Year = 4
productVariantID
Yes Integer
The ProductVariant object identifier.
published

Yes Boolean Determine if the required product is disclosed to the customer.
quantity
Yes Integer A non-zero value will match the quantity ordered (e.g. if you set a value of 2 and the customers places an order for 2 items, the total required products will equal 4). Enter a value of 1 if you want to have a one to one match. If you want a single required product regardless of any number of items purchased, enter a value of 0.
requiredProductVariantID
Yes Integer The ProductVariant object identifier required by the ProductVariant.

Return Data

Same as GetRequiredProduct service return data.


 

Comments

Add comment