API Playground - list_carts

list_carts


Lists shopping carts for a site or metasite. You can limit the carts listed to specific dates or only the ones that were checked out. A maximum of 500 carts will be listed. For further items use the 'page' parameter. (click for full documentation)

start_time

 
Start of time period

end_time

 
End of time period

site_id

For metasite API keys you can limit the results to carts created within a single site context

site_id

Planyo site ID (needed if using a metasite api key and you only want the results to come from a single site)

list_checked_out_only

If left empty or set to true, then only checked-out carts will be listed. Set this to false if you'd also like to list shopping carts which were abandoned or have not yet been checked out

sort_reverse

Set to true to list more recent carts first. Set to false (default) to list older carts first

page

Zero-based page number. The default is 0. Each page lists max 500 carts.

language

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key

your API key - Click here to get your key
* - required field