Class Adjustment
java.lang.Object
io.deeplumen.ucp.models.schemas.shopping.Adjustment
Adjustment
Append-only event that exists independently of fulfillment. Typically represents money movements but can be any post-order change. Polymorphic type that can optionally reference line items.
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanAmount in minor units (cents) for refunds, credits, price adjustments (optional).Human-readable reason or description (e.g., 'Defective item', 'Customer requested').getId()Adjustment event identifier.Which line items and quantities are affected (optional).RFC 3339 timestamp when this adjustment occurred.Adjustment status.getType()Type of adjustment (open string).inthashCode()voidsetAdditionalProperty(String name, Object value) voidAmount in minor units (cents) for refunds, credits, price adjustments (optional).voidsetDescription(String description) Human-readable reason or description (e.g., 'Defective item', 'Customer requested').voidAdjustment event identifier.voidsetLineItems(List<LineItem__2> lineItems) Which line items and quantities are affected (optional).voidsetOccurredAt(Date occurredAt) RFC 3339 timestamp when this adjustment occurred.voidsetStatus(Adjustment.Status status) Adjustment status.voidType of adjustment (open string).toString()withAdditionalProperty(String name, Object value) withAmount(Integer amount) withDescription(String description) withLineItems(List<LineItem__2> lineItems) withOccurredAt(Date occurredAt) withStatus(Adjustment.Status status)
-
Constructor Details
-
Adjustment
public Adjustment()
-
-
Method Details
-
getId
Adjustment event identifier. (Required) -
setId
Adjustment event identifier. (Required) -
withId
-
getType
Type of adjustment (open string). Typically money-related like: refund, return, credit, price_adjustment, dispute, cancellation. Can be any value that makes sense for the merchant's business. (Required) -
setType
Type of adjustment (open string). Typically money-related like: refund, return, credit, price_adjustment, dispute, cancellation. Can be any value that makes sense for the merchant's business. (Required) -
withType
-
getOccurredAt
RFC 3339 timestamp when this adjustment occurred. (Required) -
setOccurredAt
RFC 3339 timestamp when this adjustment occurred. (Required) -
withOccurredAt
-
getStatus
Adjustment status. (Required) -
setStatus
Adjustment status. (Required) -
withStatus
-
getLineItems
Which line items and quantities are affected (optional). -
setLineItems
Which line items and quantities are affected (optional). -
withLineItems
-
getAmount
Amount in minor units (cents) for refunds, credits, price adjustments (optional). -
setAmount
Amount in minor units (cents) for refunds, credits, price adjustments (optional). -
withAmount
-
getDescription
Human-readable reason or description (e.g., 'Defective item', 'Customer requested'). -
setDescription
Human-readable reason or description (e.g., 'Defective item', 'Customer requested'). -
withDescription
-
getAdditionalProperties
-
setAdditionalProperty
-
withAdditionalProperty
-
toString
-
hashCode
public int hashCode() -
equals
-