MBAPI Element Index
MBAPI Intro → MBAPI Command Index → SetShoppingSession

SetShoppingSession

Description

Command to get product addon 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>
		<subCommand><!-- string --></subCommand>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<shoppingSessionID><!-- string --></shoppingSessionID>
			<clientID><!-- int --></clientID>
			<clientContactID><!-- int --></clientContactID>
			<shoppingSessionTimestamp><!-- int --></shoppingSessionTimestamp>
			<shoppingSessionIP><!-- int --></shoppingSessionIP>
			<shoppingSessionURL><!-- string --></shoppingSessionURL>
			<orderFormID><!-- int --></orderFormID>
		</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><!-- None --></results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string SetShoppingSession.

subCommand
Type
string
Description

Required. insert update or delete.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

SetShoppingSession parameters.

Children
shoppingSessionID
Type
string
Description

Shopping Session ID, hash tracking ID, needs to be 40 characters to be effective.

clientID
Type
int
Description

Client ID of this shopper.

clientContactID
Type
int
Description

Client Contact ID of this shopper.

shoppingSessionTimestamp
Type
int
Description

Shopping Session Timestamp, last time they hit a page.

shoppingSessionIP
Type
int
Description

Shopping session IP address as INT.

shoppingSessionURL
Type
string
Description

Shopping session URL, the current url this shopper is visiting.

orderFormID
Type
int
Description

Order Form ID that this widget uses.

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