Table of Contents
get_basket
Description
get a list of basket items.
The server doesn't return a gross_coupon property but does return a gross_coupon_basket and gross_coupon_shipping property. It's not clear to me if the server or this spec is correct.
Definition
get_basket ( String token )
Parameters
| Type | Parameter Name | Parameter Description |
|---|---|---|
| string | token | session token |
Return Values
This table doesn't convey the nested basketitem array elements very well.
The return value is a scalar that contains the following:
| Type | Return Value Name | Return Value Description |
|---|---|---|
| decimal | gross_basket | basket merchandise value |
| decimal | gross_shipping | shipping costs |
| decimal | gross_handling | handling costs |
| decimal | gross_discount | discount |
| decimal | gross_coupon | coupon value |
| decimal | gross_total | basket total |
| decimal | vat_basket | basket vat |
| decimal | vat_total | total vat |
| decimal | currency | basket currency |
| array | basketitem | list of basketitems |
| basketitem array elements | ||
| Type | basketitem element name | basketitem element description |
| int | basketitem_id | basket item ID |
| int | article_id | article ID |
| int | quantity | number of articles to store in basket |
| int | shop_id | shop ID |
| int | producttype_id | product type ID |
| int | producttype_size | size of articles to store in basket |
| int | producttype_color | colour of articles to store in basket |
| decimal | gross | article's price |
| int | vat | article vat |
| string | name | article name |
| string | description | article description |
| string | image_url | article default image URL |
Error Messages
The return string is a standard format error string and implements all standard error and success messages. The following SOAP exceptions represent specific error codes for this method:
- 101: missing token
- 201: empty result set
