MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetShoppingSessions

GetShoppingSessions

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>
			<shoppingSessionID><!-- string --></shoppingSessionID>
			<clientID><!-- int --></clientID>
			<clientContactID><!-- int --></clientContactID>
			<shoppingSessionURL><!-- string --></shoppingSessionURL>
			<orderFormID><!-- int --></orderFormID>
			<shoppingSessionTimestamp><!-- int --></shoppingSessionTimestamp>
			<shoppingSessionTimestampGreaterThan><!-- int --></shoppingSessionTimestampGreaterThan>
			<shoppingSessionTimestampLessThan><!-- int --></shoppingSessionTimestampLessThan>
			<shoppingSessionTimestampGreatest><!-- int --></shoppingSessionTimestampGreatest>
			<shoppingSessionTimestampLeast><!-- int --></shoppingSessionTimestampLeast>
			<shoppingSessionIP><!-- int --></shoppingSessionIP>
			<shoppingSessionIPGreaterThan><!-- int --></shoppingSessionIPGreaterThan>
			<shoppingSessionIPLessThan><!-- int --></shoppingSessionIPLessThan>
			<shoppingSessionIPGreatest><!-- int --></shoppingSessionIPGreatest>
			<shoppingSessionIPLeast><!-- int --></shoppingSessionIPLeast>
		</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>
			<shoppingSessions>
				<shoppingSession>
					<shoppingSessionID><!-- string --></shoppingSessionID>
					<clientID><!-- int --></clientID>
					<shoppingSessionURL><!-- string --></shoppingSessionURL>
					<orderFormID><!-- int --></orderFormID>
					<shoppingSessionTimestamp><!-- int --></shoppingSessionTimestamp>
					<shoppingSessionIP><!-- int --></shoppingSessionIP>
				</shoppingSession>
			</shoppingSessions>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetShoppingSessions.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetShoppingSessions parameters.

Children
shoppingSessionID
Type
string
Description

Shopping session id, if you only want one result.

clientID
Type
int
Description

Client id, if you want to search by that. null = not logged in

clientContactID
Type
int
Description

Client Contact id, if you want to search by that

shoppingSessionURL
Type
string
Description

Shopping Session URL, this is the url they visited last.

orderFormID
Type
int
Description

Order Form id, this is the order form of the shopping session.

shoppingSessionTimestamp
Type
int
Description

Shopping Session Timestamp, the last update time of this session.

shoppingSessionTimestampGreaterThan
Type
int
Description

Shopping Session Timestamp to be greater than.

shoppingSessionTimestampLessThan
Type
int
Description

Shopping Session Timestamp to be less than.

shoppingSessionTimestampGreatest
Type
int
Description

Shopping Session Timestamp to be less than or equal to.

shoppingSessionTimestampLeast
Type
int
Description

Shopping Session Timestamp to be greater than or equal to.

shoppingSessionIP
Type
int
Description

Shopping Session IP, the last update time of this session.

shoppingSessionIPGreaterThan
Type
int
Description

Shopping Session IP to be greater than.

shoppingSessionIPLessThan
Type
int
Description

Shopping Session IP to be less than.

shoppingSessionIPGreatest
Type
int
Description

Shopping Session IP to be less than or equal to.

shoppingSessionIPLeast
Type
int
Description

Shopping Session IP to be greater than or equal to.

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
shoppingSessions
Type
None
Description
None
Children
shoppingSession
Type
None
Description
None
Children
shoppingSessionID
Type
string
Description

Shopping session id.

clientID
Type
int
Description

Client id, if null they are not logged in.

shoppingSessionURL
Type
string
Description

Shopping Session URL, this is the url they visited last.

orderFormID
Type
int
Description

Order Form id, this is the order form of the shopping session.

shoppingSessionTimestamp
Type
int
Description

Shopping Session Timestamp.

shoppingSessionIP
Type
int
Description

Shopping Session IP.