Objects

ShippingCarriers

PropertyDescription
titleName of the carrier
urlOfficial website

Cart

PropertyDescription
cart_idCard identifier
product_idProduct ID
combination_idCombination ID
quantityQuantity of products
fulfilledFulfilled count
shippedShipped count
original_priceOriginal price
RelationDescription
combinationCombinations instance
productProducts instance
shippingCarrierShippingCarriers instance
MethodDescription
getCarrier_name()Returns shipping carrier's name
getIsMultiVariant()Returns true if combination is multi variant
getPositionPrice()Returns position price
getPositionImage()Returns position image
getTotal()Returns total per position
getFullyFulfilled()Returns true if product is fully fulfilled
getFullyShipped()Returns true if product is fully shipped

OptionsImages

PropertyDescription
option_idOption ID
orderOrder number
MethodDescription
getImageUrl() / imageUrlReturn image URL
RelationDescription
optionReturns Options instance

Options

PropertyDescription
pricePrice
compare_priceCompare Price
product_idProduct ID
combination_idCombination ID
skuSKU
MethodDescription
getParentSku()Returns product SKU
getVariantName()Returns combination name
RelationDescription
optionImagesReturns list of OptionsImages instances
mainImageReturns main image (OptionsImages instance)
productReturns Products instance

Combinations

PropertyDescription
product_idProduct ID
variant_idVariant ID
RelationDescription
optionReturns Options instance
variantReturns Variants instance
optionsReturns list of Options instances
inventoryReturns list of Inventory instances

Variants

PropertyDescription
variantVariant
optionOption
RelationDescription
productReturns Product instance
optionsReturns list of Options instances
thumbnailsReturns list of Thumbnails instances
thumbnailReturns main Thumbnail instance
combinationsReturns list of Combinations instances

Types

PropertyDescription
nameName

Vendors

PropertyDescription
nameName

Reviews

PropertyDescription
emailEmail of reviewer
nameName of reviewer
verifiedIs verified?
starsStars given
reviewReview text

Warehouses

PropertyDescription
titleTitle

Inventory

PropertyDescription
stockCount in stock
commitedCommited count
RelationDescription
productReturns Product instance
warehouseReturns Warehouse instance

Tags

PropertyDescription
tagTag
RelationDescription
productProduct instance

Collections

PropertyDescription
titleTitle
descDescription
MethodDescription
getImageUrl() / imageUrlImage URL
getFrontURL() / frontURLReturns collection URL
RelationDescription
productsReturns Product instances

ZonesRegions

PropertyDescription
zone_idZone id
countryCountry code (e.g. US)
region_idRegion_id

ZonesExceptions

PropertyDescription
typeType
minMin
maxMax
unitUnit
rateRate
descriptionDescription

type:

  • 1 - weight
  • 2 - items
  • 3 - total

ZonesAdditional

PropertyDescription
descriptionZone description
rateRate

ShippingZones

PropertyDescription
nameZone name
descriptionZone description
rateRate
RelationDescription
additionalReturns list of ZonesAdditional instances
exceptionsReturns list of ZonesExceptions instances
regionsReturns list of ZonesRegions instances
MethodsDescription
getException() / exceptionreturns cheapest ZonesExceptions instance

Product

PropertyDescription
titleTitle
seo_urlURL in the store
seo_titleSEO title
seo_metaSEO meta description
track_inventory(bool) Is inventory tracking enabled
auto_fulfilmentshipment fulfilment (0 - manual, 1 - auto)
shipping_weightShipping weight
skuSKU
pricePrice
compare_pricePrice to compare
salesSales number
Method / PropertyDescription
getAvgRating() / avgRatingReturns average rating based on reviews
getReviewCount() / reviewCountReturns reviews count
getFrontURL() / frontURLReturns valid product URL
hasTag($tag)checks if product has specified tag
getTagsArray() / tagsArrayReturns array of tag ids
getTypeName() / typeNameReturns type name
getVendorName() / vendorNameReturns vendor name
getImagesWithFullUrl()Returns product images with full valid URL
getMainImage()Returns main product image
getDefaultPrice()Returns default product price
getRelated()Returns list of related products
RelationDescription
collectionsReturns list of collections of specified product
tagsReturns list of tags
inventoryReturns inventory list
reviewsReturns list of reviews
vendorsReturns Vendor instance
typesReturns Type instance
variantsReturns list of varians
thumbnailsReturns thumbnails
optionsReturns list of options
defaultOptionReturns default option

Order

RelationDescription
orderProductsinstances of products of the current order
PropertyDescription
totalTotal price paid
display_numberOrder Number (ID to display)