GetShoppingItems

Description

Command to get product ledger entries and their filter cycles and currencies.

Attributes

Product

modernbill

subProduct

mbapi

version

0.9

author

Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<shoppingItemID><!-- int --></shoppingItemID>
			<shoppingSessionID><!-- string --></shoppingSessionID>
			<productID><!-- int --></productID>
			<productVariantID><!-- int --></productVariantID>
			<parentShoppingItemID><!-- int --></parentShoppingItemID>
			<cycleID><!-- int --></cycleID>
			<currencyID><!-- string --></currencyID>
			<shoppingItemQuantity><!-- int --></shoppingItemQuantity>
			<shoppingItemSLD><!-- string --></shoppingItemSLD>
			<shoppingItemTLD><!-- string --></shoppingItemTLD>
			<shoppingItemDomainLanguage><!-- string --></shoppingItemDomainLanguage>
			<shoppingItemTransferKey><!-- string --></shoppingItemTransferKey>
			<shoppingItemPrice><!-- double --></shoppingItemPrice>
			<shoppingItemSetupPrice><!-- double --></shoppingItemSetupPrice>
			<shoppingItemDateAdded><!-- int --></shoppingItemDateAdded>
		</params>
	</mbapi>

		

Example Response

	<mbapi>
		<header>
			<remoteSessionID><!-- hex --></remoteSessionID>
			<errorCount><!-- int --></errorCount>
			<errors>
				<error>
					<title><!-- string --></title>
					<message><!-- string --></message>
				</error>
			</errors>
			<numResults><!-- int --></numResults>
			<numAffectedRows><!-- int --></numAffectedRows>
		</header>
		<results>
			<shoppingItems>
				<shoppingItem>
					<shoppingItemID><!-- int --></shoppingItemID>
					<shoppingSessionID><!-- string --></shoppingSessionID>
					<productID><!-- int --></productID>
					<productVariantID><!-- int --></productVariantID>
					<parentShoppingItemID><!-- int --></parentShoppingItemID>
					<cycleID><!-- int --></cycleID>
					<currencyID><!-- string --></currencyID>
					<shoppingItemQuantity><!-- int --></shoppingItemQuantity>
					<shoppingItemSLD><!-- string --></shoppingItemSLD>
					<shoppingItemTLD><!-- string --></shoppingItemTLD>
					<shoppingItemDomainLanguage><!-- string --></shoppingItemDomainLanguage>
					<shoppingItemTransferKey><!-- string --></shoppingItemTransferKey>
					<shoppingItemPrice><!-- double --></shoppingItemPrice>
					<shoppingItemSetupPrice><!-- double --></shoppingItemSetupPrice>
					<shoppingItemDateAdded><!-- int --></shoppingItemDateAdded>
				</shoppingItem>
			</shoppingItems>
		</results>
	</mbapi>

		

Request Elements

mbapi

Type

group

Description

MBAPI request document root.

Children

command

Type

string

Description

Required. The string GetShoppingItems.

showXMLHeader

Type

boolean

Description

Whether to show an XML header in the results.

params

Type

group

Description

GetShoppingItems parameters.

Children

shoppingItemID

Type

int

Description

Shopping Item ID, auto increment id of this item for editing purposes.

shoppingSessionID

Type

string

Description

Shopping Session ID, hash tracking ID.

productID

Type

int

Description

Product ID of this item.

productVariantID

Type

int

Description

Product Variant ID of this item.

parentShoppingItemID

Type

int

Description

Parent Shopping Item ID, the id of the item this item is a sub item of.

cycleID

Type

int

Description

Cycle ID chosen for this item.

currencyID

Type

string

Description

Currency ID for this item (reference only).

shoppingItemQuantity

Type

int

Description

Quantity.

shoppingItemSLD

Type

string

Description

SLD, used for domain items only.

shoppingItemTLD

Type

string

Description

TLD, used for domain items only.

shoppingItemDomainLanguage

Type

string

Description

Language for IDN's

shoppingItemTransferKey

Type

string

Description

String used as a key for domain transfers

shoppingItemPrice

Type

double

Description

Price of each of these items.

shoppingItemSetupPrice

Type

double

Description

One time Setup Price.

shoppingItemDateAdded

Type

int

Description

Shopping item date added, just a timestamp when this item was added to the cart.

Response Elements

mbapi

Type

group

Description

MBAPI response document root.

Children

header

Type

group

Description

Contains result meta data: data about the result itself.

Children

remoteSessionID

Type

hex

Description

A session ID that may be used for authentication instead of a remote access hash.

errorCount

Type

int

Description

The number of errors that occured.

errors

Type

group

Description

Contains any errors that occured.

Children

error

Type

group

Description

Contains information relating to a single error. Occurs header errorCount times.

Children

title

Type

string

Description

The title of the error.

message

Type

string

Description

The error message.

numResults

Type

int

Description

The number of results that have been returned. For Get commands.

numAffectedRows

Type

int

Description

The number of rows that have been affected. For Set commands.

results

Type

None

Description

None

Children

shoppingItems

Type

None

Description

None

Children

shoppingItem

Type

None

Description

None

Children

shoppingItemID

Type

int

Description

Shopping Item ID, auto increment id of this item for editing purposes.

shoppingSessionID

Type

string

Description

Shopping Session ID, hash tracking ID.

productID

Type

int

Description

Product ID of this item.

productVariantID

Type

int

Description

Product Variant ID of this item.

parentShoppingItemID

Type

int

Description

Parent Shopping Item ID, the id of the item this item is a sub item of.

cycleID

Type

int

Description

Cycle ID chosen for this item.

currencyID

Type

string

Description

Currency ID for this item (reference only).

shoppingItemQuantity

Type

int

Description

Quantity.

shoppingItemSLD

Type

string

Description

SLD, used for domain items only.

shoppingItemTLD

Type

string

Description

TLD, used for domain items only.

shoppingItemDomainLanguage

Type

string

Description

Language for IDN's

shoppingItemTransferKey

Type

string

Description

String used as a key for domain transfers

shoppingItemPrice

Type

double

Description

Price of each of these items.

shoppingItemSetupPrice

Type

double

Description

One time Setup Price.

shoppingItemDateAdded

Type

int

Description

Shopping item date added, just a timestamp when this item was added to the cart.