Order class abstract

The order

Available extensions

• OrderPatterns

Annotations

• @freezed

Constructors

Order({required String id, @JsonKey.new(defaultValue: '') required String email, required String currencyCode, @JsonKey.new(defaultValue: '') required String customerUrl, required LineItemsOrder lineItems, required String name, required int orderNumber, required String processedAt, required ShippingAddress? shippingAddress, required ShippingAddress? billingAddress, required String statusUrl, @JsonKey.new(fromJson: _priceOrZero) required PriceV2 subtotalPrice, required PriceV2 totalPrice, required PriceV2 totalShippingPrice, @JsonKey.new(fromJson: _priceOrZero) required PriceV2 totalTax, @JsonKey.new(defaultValue: '') required String financialStatus, required String fulfillmentStatus, PriceV2? totalRefunded, String? phone, String? cursor, String? canceledAt, String? cancelReason, List<SuccessfulFullfilment>? successfulFulfillments})

The order constructor

const

factory

Order.fromGraphJson(Map<String, dynamic> json)

The order from graph json

factory

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

The order from json

factory

Properties

billingAddress → ShippingAddress?

no setter, inherited

canceledAt → String?

no setter, inherited

cancelReason → String?

no setter, inherited

copyWith → $OrderCopyWith<Order>

Create a copy of Order with the given fields replaced by the non-null parameter values.

no setter, inherited

currencyCode → String

no setter, inherited

cursor → String?

no setter, inherited

customerUrl → String

Nullable on the Storefront API; empty string when absent.

no setter, inherited

email → String

Nullable on the Storefront API; empty string when absent.

no setter, inherited

financialStatus → String

Nullable on the Storefront API (for example on unpaid orders); empty string when absent.

no setter, inherited

fulfillmentStatus → String

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

no setter, inherited

lineItems → LineItemsOrder

no setter, inherited

name → String

no setter, inherited

orderNumber → int

no setter, inherited

phone → String?

no setter, inherited

processedAt → String

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shippingAddress → ShippingAddress?

no setter, inherited

statusUrl → String

no setter, inherited

subtotalPrice → PriceV2

Nullable on the Storefront API; zero amount when absent.

no setter, inherited

successfulFulfillments → List<SuccessfulFullfilment>?

no setter, inherited

totalPrice → PriceV2

no setter, inherited

totalRefunded → PriceV2?

no setter, inherited

totalShippingPrice → PriceV2

no setter, inherited

totalTax → PriceV2

Nullable on the Storefront API; zero amount when absent.

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_Order value)) → TResult

Available on Order, provided by the OrderPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_Order value)?) → TResult?

Available on Order, provided by the OrderPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_Order value)?, {required TResult orElse()}) → TResult

Available on Order, provided by the OrderPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String id, String email, String currencyCode, String customerUrl, LineItemsOrder lineItems, String name, int orderNumber, String processedAt, ShippingAddress? shippingAddress, ShippingAddress? billingAddress, String statusUrl, PriceV2 subtotalPrice, PriceV2 totalPrice, PriceV2 totalShippingPrice, PriceV2 totalTax, String financialStatus, String fulfillmentStatus, PriceV2? totalRefunded, String? phone, String? cursor, String? canceledAt, String? cancelReason, List<SuccessfulFullfilment>? successfulFulfillments)?, {required TResult orElse()}) → TResult

Available on Order, provided by the OrderPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this Order to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String id, String email, String currencyCode, String customerUrl, LineItemsOrder lineItems, String name, int orderNumber, String processedAt, ShippingAddress? shippingAddress, ShippingAddress? billingAddress, String statusUrl, PriceV2 subtotalPrice, PriceV2 totalPrice, PriceV2 totalShippingPrice, PriceV2 totalTax, String financialStatus, String fulfillmentStatus, PriceV2? totalRefunded, String? phone, String? cursor, String? canceledAt, String? cancelReason, List<SuccessfulFullfilment>? successfulFulfillments)) → TResult

Available on Order, provided by the OrderPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String id, String email, String currencyCode, String customerUrl, LineItemsOrder lineItems, String name, int orderNumber, String processedAt, ShippingAddress? shippingAddress, ShippingAddress? billingAddress, String statusUrl, PriceV2 subtotalPrice, PriceV2 totalPrice, PriceV2 totalShippingPrice, PriceV2 totalTax, String financialStatus, String fulfillmentStatus, PriceV2? totalRefunded, String? phone, String? cursor, String? canceledAt, String? cancelReason, List<SuccessfulFullfilment>? successfulFulfillments)?) → TResult?

Available on Order, provided by the OrderPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited