CookieStore.Get

Updated on 14 May 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

Returns a list of the cookies that belong to the specified cookie store.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name	Required	Type	Description
`CookieStoreID`	False*	numeric	Unique identifier of the cookie store.
`CookieStoreName`	False	string	The name of the cookie store.

* Either CookieStoreID or CookieStoreName is required.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`CookieStoreID`	numeric	Unique identifier of the cookie store.
`Name`	string	The cookie store name.
`Description`	string	The description of the cookie store.
`Cookies`	Cookies

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=CookieStore.Get&CookieStoreID=1002'

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<CookieStoreGetResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<CookieStoreID>1002</CookieStoreID>
	<Name>HomeDepot Cart</Name>
	<Description>Cart with One Item</Description>
	<CookiesList>
		<Cookies>
			<ItemID>1288</ItemID>
			<CookieStoreID>1004</CookieStoreID>
			<Settings/>
			<Name>THD_CART_HASH</Name>
			<Value>27ae3de</Value>
			<Domain>.homedepot.com</Domain>
			<Expires>2019-05-29 15:58:51</Expires>
			<TimeStamp>2019-04-29 10:00:44</TimeStamp>
			<HttpOnly>0</HttpOnly>
			<Secure>0</Secure>
			<Path>/mycart</Path>
			<Version>0</Version>
			<Comment/>
			<CommentUri/>
			<Port/>
		</Cookies>
		<Cookies>
			<ItemID>1350</ItemID>
			<CookieStoreID>1004</CookieStoreID>
			<Settings/>
			<Name>__CT_Data</Name>
			<Value>
				<![CDATA[
gpv=6&ckp=tld&dm=homedepot.com&apv_4_www23=6&cpv_4_www23=6&rpv_4_www23=5
				]]>
			</Value>
			<Domain>.homedepot.com</Domain>
			<Expires>2019-05-14 15:59:29</Expires>
			<TimeStamp>2019-04-29 10:00:44</TimeStamp>
			<HttpOnly>0</HttpOnly>
			<Secure>0</Secure>
			<Path>/</Path>
			<Version>0</Version>
			<Comment/>
			<CommentUri/>
			<Port/>
		</Cookies>
	</CookiesList>
</CookieStoreGetResponse>

JSON (add `&ResponseFormat=JSON`)

{
    "CookieStoreID": 1002,
    "Name": "CMSLogin",
    "Description": "",
    "Cookies": [
        {
            "ItemID": 1013,
            "CookieStoreID": 1002,
            "Settings": "",
            "Name": "SetByAPI",
            "Value": "I set this value",
            "Domain": "mozenda.com",
            "Expires": "2021-04-27 22:47:04",
            "TimeStamp": "",
            "HttpOnly": "0",
            "Secure": "0",
            "Path": "",
            "Version": "0",
            "Comment": "",
            "CommentUri": "",
            "Port": ""
        }
    ],
    "JsonResult": {
        "Command": "CookieStore.Get",
        "AutoLoggedIn": false,
        "WebConsoleKey": "",
        "Result": "Success",
        "ErrorCode": "",
        "ErrorDescription": "",
        "ErrorList": [],
        "ExecutionTime": {
            "Ticks": 0,
            "Days": 0,
            "Hours": 0,
            "Milliseconds": 0,
            "Minutes": 0,
            "Seconds": 0,
            "TotalDays": 0,
            "TotalHours": 0,
            "TotalMilliseconds": 0,
            "TotalMinutes": 0,
            "TotalSeconds": 0
        }
    }
}

Was this article helpful?

What's Next

CookieStore.GetList