Return class
A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can also be used as part of a Swap or a Claim.
- Annotations
-
- @JsonSerializable()
Constructors
-
Return({required String id, required String status, List<
ReturnItem> ? items, String? swapId, Swap? swap, String? claimOrderId, ClaimOrder? claimOrder, String? orderId, Order? order, ShippingMethod? shippingMethod, Map<String, dynamic> ? shippingData, String? locationId, required double refundAmount, bool? noNotification, String? idempotencyKey, String? receivedAt, required String createdAt, required String updatedAt, Map<String, dynamic> ? metadata}) -
Return.fromJson(Map<
String, dynamic> json) -
factory
Properties
- claimOrder → ClaimOrder?
-
The details of the claim that the return may belong to.
final
- claimOrderId → String?
-
The ID of the claim that the return may belong to.
final
- createdAt → String
-
The date with timezone at which the resource was created.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The return's ID
final
- idempotencyKey → String?
-
Randomly generated key used to continue the completion of the return in case of failure.
final
-
items
→ List<
ReturnItem> ? -
The details of the items that the customer is returning.
final
- locationId → String?
-
The ID of the stock location the return will be added back.
final
-
metadata
→ Map<
String, dynamic> ? -
An optional key-value map with additional details
final
- noNotification → bool?
-
When set to true, no notification will be sent related to this return.
final
- order → Order?
-
The details of the order that the return was created for.
final
- orderId → String?
-
The ID of the order that the return was created for.
final
- receivedAt → String?
-
The date with timezone at which the return was received.
final
- refundAmount → double
-
The amount that should be refunded as a result of the return.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
shippingData
→ Map<
String, dynamic> ? -
Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.
final
- shippingMethod → ShippingMethod?
-
The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.
final
- status → String
-
Status of the Return.
final
- swap → Swap?
-
The details of the swap that the return may belong to.
final
- swapId → String?
-
The ID of the swap that the return may belong to.
final
- updatedAt → String
-
The date with timezone at which the resource was updated.
final
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