SearchOrdersRequest class

Annotations

• @JsonSerializable()

Constructors

SearchOrdersRequest({List<String>? locationIds, String? cursor, SearchOrdersQuery? query, int? limit, bool? returnEntries})

const

SearchOrdersRequest.fromJson(Map<String, dynamic> json)

Converts a Map to an SearchOrdersRequest

factory

Properties

cursor → String?

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query.

final

hashCode → int

The hash code for this object.

no setter, inherited

limit → int?

The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page.

final

locationIds → List<String>?

The location IDs for the orders to query. All locations must belong to the same merchant.

final

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter

query → SearchOrdersQuery?

Query conditions used to filter or sort the results. Note that when retrieving additional pages using a cursor, you must use the original query.

final

returnEntries → bool?

A Boolean that controls the format of the search results. If true, SearchOrders returns OrderEntry objects. If false, SearchOrders returns complete order objects.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Converts a SearchOrdersRequest to a Map

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited