Item SFO

attrDefinitionList

DefinitionList attrDefinitionList(string key)

returns the definition list for the given key value

attrSimpleList

SimpleList attrSimpleList(string key)

returns the simple list for the given key value

getAssignedGroups

ProductGroup[ ] getAssignedGroups()

returns not only the parent group, but all the Product Groups (Group Pages) to which this item is assigned to

getAttribute

string getAttribute(string attributeName)

getAttributes

ItemAttribute[ ] getAttributes(string type)

type is optional. Calling this with no parameters returns all attributes

getAttributeValue

string getAttributeValue(string attributeName)

same as getAttribute except it returns an emtpy string instead of null if the attribute does not exist

getAvailableQuantity

integer getAvailableQuantity()

getAvailableQuantityString

string getAvailableQuantityString()

getBarcode

string getBarcode()

getCanonicalPath

string getCanonicalPath()

the canonical url of this item display page. see also getPath()

getCaseItems

ItemCase[ ] getCaseItems()

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.

getCOGS

string getCOGS()

returns the Cost of Goods Sold

getCost

string getCost(integer quantity)

quantity is optional. If omitted, 1 is assumed

getCostAsBigDecimal

BigDecimal getCostAsBigDecimal(integer quantity)

quantity is optional. If omitted, 1 is assumed

getCostLocalized

string getCostLocalized(integer quantity)

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

getCostLocalizedAsBigDecimal

BigDecimal getCostLocalizedAsBigDecimal()

local currency code

getCostLocalizedCurrencyCode

string getCostLocalizedCurrencyCode

returns the currency code of the item

getCurrencyCode

string getCurrencyCode()

getDefaultMultimedia

ItemMultimedia getDefaultMultimedia(string code)

getDescription

string getDescription()

getDescriptionNoEscape

string getDescriptionNoEscape()

getEbayAuctionId

string getEbayAuctionId()

returns null if no auction for this item

getEbayAuctionURL

string getEbayAuctionURL()

getEbayListingPrice

string getEbayListingPrice()

getEta

string getEta()

if the item has an ETA, return it, else return null

getExtendedDescription

string getExtendedDescription()

getExtendedDescriptionNoEscape

string getExtendedDescriptionNoEscape()

getFacebookLikeButton

string getFacebookLikeButton(string layoutStyle, integer width, boolean sendButton, boolean showFaces, string verb, string colorScheme)

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"

getFacebookShareButton

string getFacebookShareButton()

getFreightClass

string getFreightClass()

getGooglePlusButton

string getGooglePlusButton(string annotationType, integer width, integer height, string alignment)

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"

getHeight

string getHeight()

returns the height and unit of measure

getImageURL

string getImageUrl()

getInternalInventoryByDistributionCenter

string getInternalInventoryByDistributionCenter

returns back a bracketed string of dc code: inventory for this item

getKitComponents

ItemKitComponent[ ] getKitComponents()

getLength

string getLength()

returns the length and unit of measure

getManufacturerName

string getManufacturerName()

getManufacturerSKU

string getManufacturerSKU()

getManufacturerSuggestedRetailPriceLocalized

string getManufacturerSuggestedRetailPriceLocalized()

getManufacturerSuggestedRetailPriceLocalizedAsBigDecimal

BigDecimal getManufacturerSuggestedRetailPriceLocalizedAsBigDecimal()

getManufacturerSuggestedRetailPriceLocalizedAsCurrency

Currency getManufacturerSuggestedRetailPriceLocalizedAsCurrency()

getMAP

string getMAP(boolean costIfNotSpecified)

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

getMAPLocalized

string getMAPLocalized()

same as getMAP, but returns back a formatted string in the localized currency

getMAPLocalizedCurrency

Currency getMAPLocalizedCurrency()

same as getMAP, but returns back a Currency object in the localized currency

getMaximumQuantity

integer getMaximumQuantity()

getMerchantItemID

string getMerchantItemID()

getMinimumQuantity

integer getMinimumQuantity()

getMSRP

string getMSRP(boolean costIfNotSpecified)

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

getMSRPPriceBreak

string getMSRPPriceBreak()

returns the difference between MSRP and the item best price

getMultimedia

ItemMultimedia getMultimedia(string type)

type is the multimedia type: Image, Video. type is optional

getMultimediaByCode

ItemMultimedia getMultimediaByCode(string code)

getMultimediaByFilename

ItemMultimedia getMultimediaByFilename(string filename)

getMultimediaDefaultFirst

ItemMultimedia[ ] getMultimediaDefaultFirst(string type)

getOptionByName

ItemOption getOptionsByName(string name)

getOptions

ItemOption[ ] getOptions()

getParent

ProductGroup getParent()

getPath

string getPath()

the relative url of this item display page

getPinterestPin

string getPinterestPin(boolean advanced)

getPricingTiers

PricingTier[ ] getPricingTiers()

gets a list of all pricing tiers for this item

getRegularCost

string getRegularCost(integer quantity)

quantity is optional. If omitted, 1 is assumed

getRegularCostAsBigDecimal

BigDecimal getRegularCostAsBigDecimal(integer quantity)

quantity is optional. If omitted, 1 is assumed

getRegularCostLocalized

string getRegularCostLocalized(integer quantity)

returns Regular cost in local currency. quantity is optional. If omitted, 1 is assumed

getRelatedItems

Item[ ] getVolumeDiscounts()

getReviewFilter

string getReviewFilter()

returns the ItemReviewFilter

getReviewFilterAsJson

string getReviewFilterAsJson()

returns the ItemReviewFilter in json format

getReviewOverall

BigDecimal getReviewOverall()

getReviewOverallAsHtml

string getReviewOverallAsHtml(string[ ] snippets)

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

getReviewOverallAsImages

string getReviewOverallAsImages(string[ ] images)

the images array should contain 5 imges. The appropriate one is returned. If the array is missing any or all values, defaults are used.

getReviewOverallAsRectangles

string getReviewOverallAsRectangles()

getReviewOverallAsStars

string getReviewOverallAsStars()

getReviews

ItemReview[ ] getReviews()

returns all product reviews

getReviewsAsJson

string getReviewsAsJson()

returns an array of ItemReview in json format

getReviewSummary

ItemReviewSummary getReviewSummary()

returns a summary of customer reviews

getReviewSummaryAsJson

ItemReviewSummary getReviewSummaryAsJson()

returns a summary of customer reviews in json format

getReviewUrl

string getReviewUrl()

relative url of the product review page

getSaleCost

string getSaleCost(integer quantity)

quantity is optional. If omitted, 1 is assumed

getSaleCostAsBigDecimal

BigDecimal getSaleCostAsBigDecimal(integer quantity)

quantity is optional. If omitted, 1 is assumed

getSaleCostLocalized

string getSaleCostLocalized(integer quantity)

returns sale cost in local currency. quantity is optional. If omitted, 1 is assumed

getSaleEnd

Date getSaleEnd()

getSaleExpiration

ItemSaleExpiration getSaleExpiration()

getSaleExpiresIn

string getSaleExpiresIn(string dateFormat)

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:

• getSaleExpiresIn("Expires in {Y} years, {M} months, {D} days, {H} hours, {m} minutes, and {S} seconds")

• getSaleExpiresIn("{HH}:{mm}:{SS}")

getSaleStart

Date getSaleStart()

getSavings

string getSavings()

difference between MSRP and cost

getSavingsPercent

string getSavingsPercent()

difference between MSRP and cost as a percentage

getSavingsPercentRoundedUp

string getSavingsPercentRoundedUp()

difference between MSRP and cost as a percentage rounded up to nearest whole number

getSchedules

string[ ] getSchedules

returns an array of schedules if the item isAutoOrderable() == true

getThumbnail

string getThumbnail(integer width, integer height, boolean squareThumbnail, boolean pngFormat)

all parameters are optional, default width and height is 80 pixels

getTitle

string getTitle()

getTitleNoEscape

string getTitleNoEscape()

getTotalAsBigDecimal

BigDecimal getTotalAsBigDecimal(integer quantity)

getTotalLocalized

string getTotalLocalized(integer quantity)

getTweetButton

string getTweetButton(string tweetText, string countBoxStyle, string buttonSize, string viaUser)

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

getUnapprovedReviews

ItemReview[ ] getUnapprovedReviews()

returns all unapproved product reviews

getVariationDefaultMultimedia

ItemMultimedia getVariationDefaultMultimedia(string code)

getVariationMatrix

ItemVariationMatrix getVariationMatrix()

returns back a matrix of this item's variations. Used to display the select box of choices to the customer

getVariationMultimedia

ItemMultimedia[ ] getVariationMultimedia(string type)

type is the multimedia type: Image, Video. type is optional

getVariationMultimediaByCode

ItemMultimedia getVariationMultimediaByCode(string code)

getVariations

ItemVariation[ ] getVariations()

getViewURL

string getViewURL()

returns the url for the catalog page of this item

getVolumeDiscounts

VolumeDiscount[ ] getVolumeDiscounts()

returns all the applicable volume discounts

getVolumeDiscountsForCart

VolumeDiscount[ ] getVolumeDiscountsForCart(boolean includeSingleUnit)

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

getWeight

string getWeight()

returns the weight as a string with unit of measure appended

getWidth

string getWidth()

returns the width and unit of measure

hasApprovedReview

boolean hasApprovedReview()

hasReview

boolean hasReview()

hasVariations

boolean hasVariations()

isAllowBackorder

boolean isAllowBackorder()

isAutoOrderable

boolean isAutoOrderable

true if the item is a recurring item and can be auto ordered

isHazmat

boolean isHazmat()

isInactive

boolean isInactive()

isInventoryTracked

boolean isInventoryTracked()

returns true if any one of these conditions is true:

1. Inventory is not being tracked.
2. Allow back order is enabled.
3. Pre-order is enabled.
4. Available quantity is greater than zero

isPreorder

boolean isPreorder()

isReviewabled

boolean isReviewable()