Item Details
August 21, 2026 ยท View on GitHub
The item details.
Structure
ItemDetails
Fields
| Name | Type | Tags | Description | Getter | Setter |
|---|---|---|---|---|---|
ItemCode | String | Optional | An item code that identifies a merchant's goods or service. Constraints: Minimum Length: 1, Maximum Length: 1000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$ | String getItemCode() | setItemCode(String itemCode) |
ItemName | String | Optional | The item name. Constraints: Minimum Length: 1, Maximum Length: 200, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$ | String getItemName() | setItemName(String itemName) |
ItemDescription | String | Optional | The item description. Constraints: Minimum Length: 1, Maximum Length: 2000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$ | String getItemDescription() | setItemDescription(String itemDescription) |
ItemOptions | String | Optional | The item options. Describes option choices on the purchase of the item in some detail. Constraints: Minimum Length: 1, Maximum Length: 4000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$ | String getItemOptions() | setItemOptions(String itemOptions) |
ItemQuantity | String | Optional | The number of purchased units of goods or a service. Constraints: Minimum Length: 1, Maximum Length: 4000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$ | String getItemQuantity() | setItemQuantity(String itemQuantity) |
ItemUnitPrice | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getItemUnitPrice() | setItemUnitPrice(Money itemUnitPrice) |
ItemAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getItemAmount() | setItemAmount(Money itemAmount) |
DiscountAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getDiscountAmount() | setDiscountAmount(Money discountAmount) |
AdjustmentAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getAdjustmentAmount() | setAdjustmentAmount(Money adjustmentAmount) |
GiftWrapAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getGiftWrapAmount() | setGiftWrapAmount(Money giftWrapAmount) |
TaxPercentage | String | Optional | The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.Constraints: Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$ | String getTaxPercentage() | setTaxPercentage(String taxPercentage) |
TaxAmounts | List<TaxAmount> | Optional | An array of tax amounts levied by a government on the purchase of goods or services. Constraints: Minimum Items: 1, Maximum Items: 32767 | List | setTaxAmounts(List |
BasicShippingAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getBasicShippingAmount() | setBasicShippingAmount(Money basicShippingAmount) |
ExtraShippingAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getExtraShippingAmount() | setExtraShippingAmount(Money extraShippingAmount) |
HandlingAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getHandlingAmount() | setHandlingAmount(Money handlingAmount) |
InsuranceAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getInsuranceAmount() | setInsuranceAmount(Money insuranceAmount) |
TotalItemAmount | Money | Optional | The currency and amount for a financial transaction, such as a balance or payment due. | Money getTotalItemAmount() | setTotalItemAmount(Money totalItemAmount) |
InvoiceNumber | String | Optional | The invoice number. An alphanumeric string that identifies a billing for a merchant. Constraints: Minimum Length: 1, Maximum Length: 200, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$ | String getInvoiceNumber() | setInvoiceNumber(String invoiceNumber) |
CheckoutOptions | List<CheckoutOption> | Optional | An array of checkout options. Each option has a name and value. Constraints: Minimum Items: 1, Maximum Items: 32767 | List | setCheckoutOptions(List |
Example
import com.paypal.sdk.models.ItemDetails;
ItemDetails itemDetails = new ItemDetails.Builder()
.itemCode("item_code2")
.itemName("item_name0")
.itemDescription("item_description8")
.itemOptions("item_options4")
.itemQuantity("item_quantity4")
.build();