Order class

Order.

Production access (all methods) requires the order manager role. Sandbox access does not.

Constructors

Order({bool? acknowledged, List<OrderOrderAnnotation>? annotations, OrderAddress? billingAddress, OrderCustomer? customer, OrderDeliveryDetails? deliveryDetails, String? id, String? kind, List<OrderLineItem>? lineItems, String? merchantId, String? merchantOrderId, Price? netPriceAmount, Price? netTaxAmount, String? paymentStatus, OrderPickupDetails? pickupDetails, String? placedDate, List<OrderPromotion>? promotions, List<OrderRefund>? refunds, List<OrderShipment>? shipments, Price? shippingCost, Price? shippingCostTax, String? status, String? taxCollector})

Order.fromJson(Map json_)

Properties

acknowledged ↔ bool?

Whether the order was acknowledged.

getter/setter pair

annotations ↔ List<OrderOrderAnnotation>?

List of key-value pairs that are attached to a given order.

getter/setter pair

billingAddress ↔ OrderAddress?

The billing address.

getter/setter pair

customer ↔ OrderCustomer?

The details of the customer who placed the order.

getter/setter pair

deliveryDetails ↔ OrderDeliveryDetails?

Delivery details for shipments of type delivery.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ String?

The REST ID of the order.

getter/setter pair

kind ↔ String?

Identifies what kind of resource this is.

getter/setter pair

lineItems ↔ List<OrderLineItem>?

Line items that are ordered.

getter/setter pair

merchantId ↔ String?

getter/setter pair

merchantOrderId ↔ String?

Merchant-provided ID of the order.

getter/setter pair

netPriceAmount ↔ Price?

The net amount for the order (price part).

getter/setter pair

netTaxAmount ↔ Price?

The net amount for the order (tax part).

getter/setter pair

paymentStatus ↔ String?

The status of the payment.

getter/setter pair

pickupDetails ↔ OrderPickupDetails?

Pickup details for shipments of type pickup.

getter/setter pair

placedDate ↔ String?

The date when the order was placed, in ISO 8601 format.

getter/setter pair

promotions ↔ List<OrderPromotion>?

Promotions associated with the order.

getter/setter pair

refunds ↔ List<OrderRefund>?

Refunds for the order.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shipments ↔ List<OrderShipment>?

Shipments of the order.

getter/setter pair

shippingCost ↔ Price?

The total cost of shipping for all items.

getter/setter pair

shippingCostTax ↔ Price?

The tax for the total shipping cost.

getter/setter pair

status ↔ String?

The status of the order.

getter/setter pair

taxCollector ↔ String?

The party responsible for collecting and remitting taxes.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited