ezbasket

Summary

Contains information about a user's shopping basket.

Persistent

Yes.

Attributes

Attribute

Type

Static*

Description

id

string

Yes.

The ID number of the shopping basket.

session_id

string

Yes.

The ID of the session that the basket belongs to.

productcollection_id

string

Yes.

The ID number of the product collection that belongs to the basket.

order_id

string

Yes.

The ID number of the order that belongs to the basket.

items

array

No.

An array of hashes containing information about the items. Each element consists of the following data:

Attribute

Type

Description

id

string

The ID number of the item in the basket.

vat_value

string

The actual value of VAT (for example, 22).

item_count

string

The quantity.

node_id

string

The ID number of the node that represents the item.

object_name

string

The name of the object that represents the item.

price_ex_vat

double

The price of the item excluding the VAT.

price_inc_vat

string

The price of the item including the VAT.

discount_percent

string

The discount percentage (if any).

total_price_ex_vat

double

The total price excluding the VAT.

total_price_inc_vat

double

The total price including the VAT.

item_object

object

The item itself (as an ezproductcollectionitem object).

total_ex_vat

float

No.

The total amount to be payed excluding the VAT.

total_inc_vat

float

No.

The total amount to be payed including the VAT.

is_empty

boolean

No.

Returns TRUE if there are no items in the basket, FALSE otherwise.

productcollection

object

No.

The product collection that belongs to the basket.

* Indicates whether the attribute provides a pre-fetched value or if it needs to be computed upon request.

Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2013 eZ Systems AS (except where otherwise noted). All rights reserved.