Class CheckoutResponse
java.lang.Object
io.deeplumen.ucp.models.schemas.shopping.CheckoutResponse
Checkout Response
Base checkout schema. Extensions compose onto this using allOf.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumCheckout state indicating the current phase and required action. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleangetBuyer()BuyerURL for checkout handoff and session recovery.ISO 4217 currency code.RFC 3339 expiry timestamp.getId()Unique identifier of the checkout session.List of line items being checked out.getLinks()Links to be displayed by the platform (Privacy Policy, TOS).List of messages with error and info about the checkout session state.getOrder()Order ConfirmationPayment ResponseCheckout state indicating the current phase and required action.Different cart totals.getUcp()UCP Checkout ResponseinthashCode()voidsetAdditionalProperty(String name, Object value) voidBuyervoidsetContinueUrl(URI continueUrl) URL for checkout handoff and session recovery.voidsetCurrency(String currency) ISO 4217 currency code.voidsetExpiresAt(Date expiresAt) RFC 3339 expiry timestamp.voidUnique identifier of the checkout session.voidsetLineItems(List<LineItemResponse> lineItems) List of line items being checked out.voidLinks to be displayed by the platform (Privacy Policy, TOS).voidsetMessages(List<Message> messages) List of messages with error and info about the checkout session state.voidsetOrder(OrderConfirmation order) Order ConfirmationvoidsetPayment(PaymentResponse payment) Payment ResponsevoidsetStatus(CheckoutResponse.Status status) Checkout state indicating the current phase and required action.voidsetTotals(List<TotalResponse> totals) Different cart totals.voidUCP Checkout ResponsetoString()withAdditionalProperty(String name, Object value) withContinueUrl(URI continueUrl) withCurrency(String currency) withExpiresAt(Date expiresAt) withLineItems(List<LineItemResponse> lineItems) withMessages(List<Message> messages) withOrder(OrderConfirmation order) withPayment(PaymentResponse payment) withStatus(CheckoutResponse.Status status) withTotals(List<TotalResponse> totals)
-
Constructor Details
-
CheckoutResponse
public CheckoutResponse()
-
-
Method Details
-
getUcp
UCP Checkout ResponseUCP metadata for checkout responses. (Required)
-
setUcp
UCP Checkout ResponseUCP metadata for checkout responses. (Required)
-
withUcp
-
getId
Unique identifier of the checkout session. (Required) -
setId
Unique identifier of the checkout session. (Required) -
withId
-
getLineItems
List of line items being checked out. (Required) -
setLineItems
List of line items being checked out. (Required) -
withLineItems
-
getBuyer
Buyer -
setBuyer
Buyer -
withBuyer
-
getStatus
Checkout state indicating the current phase and required action. See Checkout Status lifecycle documentation for state transition details. (Required) -
setStatus
Checkout state indicating the current phase and required action. See Checkout Status lifecycle documentation for state transition details. (Required) -
withStatus
-
getCurrency
ISO 4217 currency code. (Required) -
setCurrency
ISO 4217 currency code. (Required) -
withCurrency
-
getTotals
Different cart totals. (Required) -
setTotals
Different cart totals. (Required) -
withTotals
-
getMessages
List of messages with error and info about the checkout session state. -
setMessages
List of messages with error and info about the checkout session state. -
withMessages
-
getLinks
Links to be displayed by the platform (Privacy Policy, TOS). Mandatory for legal compliance. (Required) -
setLinks
Links to be displayed by the platform (Privacy Policy, TOS). Mandatory for legal compliance. (Required) -
withLinks
-
getExpiresAt
RFC 3339 expiry timestamp. Default TTL is 6 hours from creation if not sent. -
setExpiresAt
RFC 3339 expiry timestamp. Default TTL is 6 hours from creation if not sent. -
withExpiresAt
-
getContinueUrl
URL for checkout handoff and session recovery. MUST be provided when status is requires_escalation. See specification for format and availability requirements. -
setContinueUrl
URL for checkout handoff and session recovery. MUST be provided when status is requires_escalation. See specification for format and availability requirements. -
withContinueUrl
-
getPayment
Payment ResponsePayment configuration containing handlers. (Required)
-
setPayment
Payment ResponsePayment configuration containing handlers. (Required)
-
withPayment
-
getOrder
Order ConfirmationOrder details available at the time of checkout completion.
-
setOrder
Order ConfirmationOrder details available at the time of checkout completion.
-
withOrder
-
getAdditionalProperties
-
setAdditionalProperty
-
withAdditionalProperty
-
toString
-
hashCode
public int hashCode() -
equals
-