Item SFO
Properties
Field | Type | Comment/Sample |
---|
Methods
Method | Signature | Comments/Sample | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| returns the definition list for the given key value | ||||||||||||||||||
|
| returns the simple list for the given key value | ||||||||||||||||||
|
| returns not only the parent group, but all the Product Groups (Group Pages) to which this item is assigned to | ||||||||||||||||||
|
|
| ||||||||||||||||||
getAttributeI18N | string getAttributeI18N(string attributeName) | returns the attribute, translated into the customer's desired language. | ||||||||||||||||||
getAttributeI18NHtmlLang | string getAttributeI18NHtmlLang(string attributeName) | returns the HTML lang attribute to be usd on the surround DOM element to tell search engines about how the content was translated. | ||||||||||||||||||
|
| type is optional. Calling this with no parameters returns all attributes | ||||||||||||||||||
|
| same as getAttribute except it returns an emtpy string instead of null if the attribute does not exist | ||||||||||||||||||
getAttributeValueI18N | string getAttributeValueI18N(string attributeName) | same as getAttributeValue, but translates the content into the customer's desired language. | ||||||||||||||||||
getAttributeValueI18NHtmlLang | string getAttributeValueI18NHtmlLang(string attributeName) | returns the HTML lang attribute to be usd on the surround DOM element to tell search engines about how the content was translated. | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| the canonical url of this item display page. see also getPath() | ||||||||||||||||||
getCanonicalURI | string getCanonicalURI() | this canonical URL of this item's display page. Recommend using this vs getCanonicalPath(). See also getURI(). | ||||||||||||||||||
|
| returns all the cases (large packs of this item) that are available for purchase. for example, a single can of coke might have two cases: a six pack, and a 20 pack. | ||||||||||||||||||
|
| returns the Cost of Goods Sold | ||||||||||||||||||
|
| quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
| quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
String getCostLocalized(int quantity, boolean totalCost) | returns cost in local currency. quantity is optional. If omitted, 1 is assumed returns cost multiplied by the quantity. Optional. If omitted, 1 is assumed | ||||||||||||||||||
|
| local currency code | ||||||||||||||||||
|
| returns the currency code of the item | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
getDescriptionHtmlLang | string getDescriptionHtmlLang() | returns the HTML lang attribute that should be used on the DOM element surrounding the description to tell search engines how the content was translated. | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns null if no auction for this item | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| if the item has an ETA, return it, else return null | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| parameters are optional. If you include any parameters, include them all. If you omit all parameters, the following defaults are used: layoutStyle="standard", width=450, sendButton=true, showFaces=true, verb="like", colorScheme="light" | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| parameters are optional. If you include any parameters, include them all. If you omit all parameters, the following defaults are used: annotationType="bubble", width=0, height=20, alignment="left" | ||||||||||||||||||
|
| returns the height and unit of measure | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns back a bracketed string of dc code: inventory for this item | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns the length and unit of measure | ||||||||||||||||||
getMadeToOrderLeadTime | integer getMadeToOrderLeadTime() | If the item is made to order, then this is the number of days that it takes to produce the product before it can ship. | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns the Minimum Advertised Price. If costIfNotSpecified is true, and this item has no MAP, then the cost is returned instead. costIfNotSpecified is optional and may be omitted altogether | ||||||||||||||||||
|
| same as getMAP, but returns back a formatted string in the localized currency | ||||||||||||||||||
|
| same as getMAP, but returns back a Currency object in the localized currency | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns the Manufacturer Suggested Retail Price. If costIfNotSpecified is true, and this item has no MSRP, then the cost is returned instead. costIfNotSpecified is optional and may be omitted altogether | ||||||||||||||||||
|
| returns the difference between MSRP and the item best price | ||||||||||||||||||
|
| type is the multimedia type: Image, Video. type is optional | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
getOptionMatrixJson | string getOptionMatrixJson() | returns back a complex json object for use with the catalog.js script. see Modifying Item Variations in a StoreFront | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| the relative url of this item display page | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| gets a list of all pricing tiers for this item | ||||||||||||||||||
|
| quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
| quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
| returns Regular cost in local currency. quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns the ItemReviewFilter | ||||||||||||||||||
|
| returns the ItemReviewFilter in json format | ||||||||||||||||||
getReviewCount | int getReviewCount() | returns the number of approved reviews for this item. | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| the snippets array should contain 5 snippets for the review: zero, quarter, half, three/fourths, and full. The overall review is compared and the appropriate snippet is returned | ||||||||||||||||||
|
| the images array should contain 5 imges. The appropriate one is returned. If the array is missing any or all values, defaults are used. | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns all product reviews | ||||||||||||||||||
|
| returns an array of ItemReview in json format | ||||||||||||||||||
|
| returns a summary of customer reviews | ||||||||||||||||||
|
| returns a summary of customer reviews in json format | ||||||||||||||||||
|
| relative url of the product review page | ||||||||||||||||||
|
| quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
| quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
| returns sale cost in local currency. quantity is optional. If omitted, 1 is assumed | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns remaining time of sale | ||||||||||||||||||
|
| DEPRECATED - use getSaleExpiration() instead. Format a string to show time remaining in sale. Returns null if there is no sale going on, or the sale hasn't started, or has expired. Use these tokens to specify which data to include in your string
Examples:
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| difference between MSRP and cost | ||||||||||||||||||
|
| difference between MSRP and cost as a percentage | ||||||||||||||||||
|
| difference between MSRP and cost as a percentage rounded up to nearest whole number | ||||||||||||||||||
|
| returns an array of schedules if the item isAutoOrderable() == true | ||||||||||||||||||
|
| all parameters are optional, default width and height is 80 pixels | ||||||||||||||||||
|
|
| ||||||||||||||||||
getTitleHtmlLang | string getTitleHtmlLang() | returns the HTML lang attribute that should be used on the DOM element surrounding the title to tell search engines how the content was translated. | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| parameters are optional. If you include any parameters, include them all. If you omit all parameters, the following defaults are used: tweetText=null, countBoxStyle="horizontal",buttonSize="medium",viaUser=null | ||||||||||||||||||
|
| returns all unapproved product reviews | ||||||||||||||||||
getURI | string getURI() | returns the URI of this item page. Recommend using this method instead of getPath(). See also getCanonicalURI(). | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns back a matrix of this item's variations. Used to display the select box of choices to the customer | ||||||||||||||||||
|
| type is the multimedia type: Image, Video. type is optional | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| returns the url for the catalog page of this item | ||||||||||||||||||
|
| returns all the applicable volume discounts | ||||||||||||||||||
|
| returns all the applicable volume discounts for items in the cart. If includeSingleUnit is true, then the cost for a single unit is returned as well | ||||||||||||||||||
|
| returns the weight as a string with unit of measure appended | ||||||||||||||||||
|
| returns the width and unit of measure | ||||||||||||||||||
|
|
| ||||||||||||||||||
hasOptions | boolean hasOptions() | returns true if this item has options, false otherwise | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
| true if the item is a recurring item and can be auto ordered | ||||||||||||||||||
isFreeShipping | boolean isFreeShipping() | true if the item is marked as qualify for free shipping | ||||||||||||||||||
isFreeShippingAutoOrder | boolean isFreeShippingAutoOrder() | true if the item is marked as qualify for free shipping if the customer choose the auto order option at checkout | ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
isMadeToOrder | boolean isMadeToOrder() | returns true if this item is marked made to order, false otherwise. | ||||||||||||||||||
isOnSale | boolean isOnSale() | returns true if the item is on sale, false otherwise. | ||||||||||||||||||
isOrderable | boolean isOrderable() | returns true if any one of these conditions is true:
| ||||||||||||||||||
|
|
| ||||||||||||||||||
|
|
| ||||||||||||||||||
isUnlimitedBackorder() | boolean isUnlimitedBackorder() | returns true if the item can be backordered an unlimited amount. |