Objects

ShippingCarriers

Property

Description

title

Name of the carrier

url

Official website

Cart

Property

Description

cart_id

Card identifier

product_id

Product ID

combination_id

Combination ID

quantity

Quantity of products

fulfilled

Fulfilled count

shipped

Shipped count

original_price

Original price

Relation

Description

combination

Combinations instance

product

Products instance

shippingCarrier

ShippingCarriers instance

Method

Description

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

Property

Description

option_id

Option ID

order

Order number

Method

Description

getImageUrl() / imageUrl

Return image URL

Relation

Description

option

Returns Options instance

Options

Property

Description

price

Price

compare_price

Compare Price

product_id

Product ID

combination_id

Combination ID

sku

SKU

Method

Description

getParentSku()

Returns product SKU

getVariantName()

Returns combination name

Relation

Description

optionImages

Returns list of OptionsImages instances

mainImage

Returns main image (OptionsImages instance)

product

Returns Products instance

Combinations

Property

Description

product_id

Product ID

variant_id

Variant ID

Relation

Description

option

Returns Options instance

variant

Returns Variants instance

options

Returns list of Options instances

inventory

Returns list of Inventory instances

Variants

Property

Description

variant

Variant

option

Option

Relation

Description

product

Returns Product instance

options

Returns list of Options instances

thumbnails

Returns list of Thumbnails instances

thumbnail

Returns main Thumbnail instance

combinations

Returns list of Combinations instances

Types

Property

Description

name

Name

Vendors

Property

Description

name

Name

Reviews

Property

Description

email

Email of reviewer

name

Name of reviewer

verified

Is verified?

stars

Stars given

review

Review text

Warehouses

Property

Description

title

Title

Inventory

Property

Description

stock

Count in stock

commited

Commited count

Relation

Description

product

Returns Product instance

warehouse

Returns Warehouse instance

Tags

Property

Description

tag

Tag

Relation

Description

product

Product instance

Collections

Property

Description

title

Title

desc

Description

Method

Description

getImageUrl() / imageUrl

Image URL

getFrontURL() / frontURL

Returns collection URL

Relation

Description

products

Returns Product instances

ZonesRegions

Property

Description

zone_id

Zone id

country

Country code (e.g. US)

region_id

Region_id

ZonesExceptions

Property

Description

type

Type

min

Min

max

Max

unit

Unit

rate

Rate

description

Description

type:

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

ZonesAdditional

Property

Description

description

Zone description

rate

Rate

ShippingZones

Property

Description

name

Zone name

description

Zone description

rate

Rate

Relation

Description

additional

Returns list of ZonesAdditional instances

exceptions

Returns list of ZonesExceptions instances

regions

Returns list of ZonesRegions instances

Methods

Description

getException() / exception

returns cheapest ZonesExceptions instance

Product

Property

Description

title

Title

seo_url

URL in the store

seo_title

SEO title

seo_meta

SEO meta description

track_inventory

(bool) Is inventory tracking enabled

auto_fulfilment

shipment fulfilment (0 - manual, 1 - auto)

shipping_weight

Shipping weight

sku

SKU

price

Price

compare_price

Price to compare

sales

Sales number

Method / Property

Description

getAvgRating() / avgRating

Returns average rating based on reviews

getReviewCount() / reviewCount

Returns reviews count

getFrontURL() / frontURL

Returns valid product URL

hasTag($tag)

checks if product has specified tag

getTagsArray() / tagsArray

Returns array of tag ids

getTypeName() / typeName

Returns type name

getVendorName() / vendorName

Returns 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

Relation

Description

collections

Returns list of collections of specified product

tags

Returns list of tags

inventory

Returns inventory list

reviews

Returns list of reviews

vendors

Returns Vendor instance

types

Returns Type instance

variants

Returns list of varians

thumbnails

Returns thumbnails

options

Returns list of options

defaultOption

Returns default option

Order

Relation

Description

orderProducts

instances of products of the current order

Property

Description

total

Total price paid

display_number

Order Number (ID to display)