List carts

sort

string | null

Enables sorting by product fields. A - indicates descending order

skip

number | null

≥ 0

For use with paging. Number of records to skip when returning.

i.e., if there are 20 records and you want 5 at a time, your first skip would be 0, second would be 5, third would be 10, etc.

limit

number | null

0 to 250

For use with paging. Total number of records to return. Default limit is 100 and max limit is 250

select

string | null

A string of space-separated values containing the top-level field names to be returned.

status

string

enum

Filter by order cart status

Allowed:

venueId

string

Filter by venue/store associated with order cart

dateStart

string

deprecated

This field has been deprecated in favor of createdStart, but is still supported for backwards compatibility.

Filter by carts created after this date

dateEnd

string

deprecated

This field has been deprecated in favor of createdEnd, but is still supported for backwards compatibility.

Filter by carts created before this date

createdStart

string

Filter by carts created on or after this date.

To filter for a specific date, use a combination of createdStart and createdEnd. For example, to query for only 1/1/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for createdStart and ending date for createdEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-05T23:59

createdEnd

string

Filter by carts created on or before this date

To filter for a specific date, use a combination of createdStart and createdEnd. For example, to query for only 1/1/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for createdStart and ending date for createdEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?createdStart=2023-01-01T00:00&createdEnd=2023-01-05T23:59

modifiedStart

string

Filter by carts modified on or after this date

To filter for a specific date, use a combination of modifiedStart and modifiedEnd. For example, to query for only 1/1/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for modifiedStart and ending date for modifiedEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-05T23:59

modifiedEnd

string

Filter by carts modified on or before this date

To filter for a specific date, use a combination of modifiedStart and modifiedEnd. For example, to query for only 1/1/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-01T23:59.

To query for a range of dates, you would pass the starting date for modifiedStart and ending date for modifiedEnd. For example, to query for the range 1/1/2023-1/5/2023, you would pass ?modifiedStart=2023-01-01T00:00&modifiedEnd=2023-01-05T23:59

includeDeprecated

boolean

200Cart list response object.

defaultunexpected error