WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 23:40 UTC.

API reference Models

HppCatalogOrderLine

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

One product on a catalog order: the catalog facts snapshotted when the order was built, the page's presentation rules for it, and the quantity currently chosen. The unit price is the price the payer was shown; it never changes after the snapshot, whatever happens to the catalog.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description
productId required string (uuid) The catalog product this line sells.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
displayOrder required integer (int32) Position in the payer-facing list.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
name required string Display name at snapshot time. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
unitPrice required number (double) Price per unit at snapshot time.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowFractionalQuantity required boolean Whether a non-integer quantity is allowed.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
minimumQuantity required number (double) The smallest quantity a payer may buy: the larger of the catalog's floor and the page's own.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
maximumQuantity required number (double) The largest quantity a payer may buy: the smaller of the catalog's ceiling, the page's own and the platform cap.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isOptional required boolean `true` for an add-on the payer may leave out.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
allowQuantityChange required boolean Whether the payer may change `quantity`.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
defaultQuantity required number (double) The quantity the page configured for this product (or the link overrode it to): what a fixed-quantity line always sells, and what an optional line returns to when re-selected.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
quantity required number (double) The quantity currently on the order. Starts at the page's default (or the link's own override) and, once the payer submits, holds what they chose. Zero on an optional line the payer left out.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isTaxable required boolean Whether the product is taxable.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
description required string Optional longer description at snapshot time. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
productCode required string Optional SKU at snapshot time. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
unitOfMeasure required string Optional unit label at snapshot time. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
taxCode required string Optional tax code at snapshot time. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
taxAmount required number (double) Tax attributed to this line. Zero until a tax mode attributes one; the platform's tax modes are a separate concern and this line only carries their answer. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
discountAmount required number (double) Discount attributed to this line. Zero until a promotion is apportioned; the promotion comes off the order subtotal as a whole today. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lineTotal required number (double) `unitPrice` times `quantity`, rounded to cents. Recomputed by the policy whenever the quantity changes; stored so a reader of the document does not have to. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.