DocumentItemDto

data class DocumentItemDto(description: String?, brand: String?, buyLink: String?, discounts: List<DocumentDiscountDto>?, fees: List<DocumentFeeDto>?, imageUrl: String?, itemIds: List<String>?, listPrice: DocumentTaxableAmountDto?, loyaltyRewards: DocumentLoyaltyRewardsDto?, name: String?, price: DocumentTaxableAmountDto?, priceBeforeDiscountsFees: DocumentTaxableAmountDto?, properties: List<DocumentItemDtoPropertiesInner>?, serialNumbers: List<String>?, sku: String?, unitListPrice: DocumentTaxableAmountDto?, unitOfMeasure: String?, unitPrice: DocumentTaxableAmountDto?, unitQuantity: BigDecimal?)

Parameters

description

An additional description of an item.

brand

The brand name of this item.

buyLink

A link to this item on the retailer's website.

discounts
  • @param fees * @param imageUrl A url to an image of this item.

itemIds

A set of strings set by the merchant to identify this item. The meaning of these values vary by merchant, and are not guaranteed to be unique in any way.

listPrice
  • @param loyaltyRewards * @param name A user-presentable name for this item, which should be the main content of the line item.

price
  • @param priceBeforeDiscountsFees * @param properties Will be used to define miscellaneous item properties.

serialNumbers

The serial number of the item.

sku

The SKU for this item as is on the receipt.

unitListPrice
  • @param unitOfMeasure The unit of measure of the item.

unitPrice
  • @param unitQuantity The quantity of units of the item. If there is a unit of measure this will be the quantity of the specified units of measure.

Constructors

DocumentItemDto
Link copied to clipboard
fun DocumentItemDto(description: String? = null, brand: String? = null, buyLink: String? = null, discounts: List<DocumentDiscountDto>? = null, fees: List<DocumentFeeDto>? = null, imageUrl: String? = null, itemIds: List<String>? = null, listPrice: DocumentTaxableAmountDto? = null, loyaltyRewards: DocumentLoyaltyRewardsDto? = null, name: String? = null, price: DocumentTaxableAmountDto? = null, priceBeforeDiscountsFees: DocumentTaxableAmountDto? = null, properties: List<DocumentItemDtoPropertiesInner>? = null, serialNumbers: List<String>? = null, sku: String? = null, unitListPrice: DocumentTaxableAmountDto? = null, unitOfMeasure: String? = null, unitPrice: DocumentTaxableAmountDto? = null, unitQuantity: BigDecimal? = null)
An additional description of an item.

Properties

brand
Link copied to clipboard
@SerializedName(value = brand)
val brand: String? = null
The brand name of this item.
buyLink
Link copied to clipboard
@SerializedName(value = buyLink)
val buyLink: String? = null
A link to this item on the retailer's website.
description
Link copied to clipboard
@SerializedName(value = description)
val description: String? = null
An additional description of an item.
discounts
Link copied to clipboard
@SerializedName(value = discounts)
val discounts: List<DocumentDiscountDto>? = null
  • @param fees * @param imageUrl A url to an image of this item.

fees
Link copied to clipboard
@SerializedName(value = fees)
val fees: List<DocumentFeeDto>? = null
imageUrl
Link copied to clipboard
@SerializedName(value = imageUrl)
val imageUrl: String? = null
itemIds
Link copied to clipboard
@SerializedName(value = itemIds)
val itemIds: List<String>? = null
A set of strings set by the merchant to identify this item.
listPrice
Link copied to clipboard
@SerializedName(value = listPrice)
val listPrice: DocumentTaxableAmountDto? = null
  • @param loyaltyRewards * @param name A user-presentable name for this item, which should be the main content of the line item.

loyaltyRewards
Link copied to clipboard
@SerializedName(value = loyaltyRewards)
val loyaltyRewards: DocumentLoyaltyRewardsDto? = null
name
Link copied to clipboard
@SerializedName(value = name)
val name: String? = null
price
Link copied to clipboard
@SerializedName(value = price)
val price: DocumentTaxableAmountDto? = null
  • @param priceBeforeDiscountsFees * @param properties Will be used to define miscellaneous item properties.

priceBeforeDiscountsFees
Link copied to clipboard
@SerializedName(value = priceBeforeDiscountsFees)
val priceBeforeDiscountsFees: DocumentTaxableAmountDto? = null
properties
Link copied to clipboard
@SerializedName(value = properties)
val properties: List<DocumentItemDtoPropertiesInner>? = null
serialNumbers
Link copied to clipboard
@SerializedName(value = serialNumbers)
val serialNumbers: List<String>? = null
The serial number of the item.
sku
Link copied to clipboard
@SerializedName(value = sku)
val sku: String? = null
The SKU for this item as is on the receipt.
unitListPrice
Link copied to clipboard
@SerializedName(value = unitListPrice)
val unitListPrice: DocumentTaxableAmountDto? = null
  • @param unitOfMeasure The unit of measure of the item.

unitOfMeasure
Link copied to clipboard
@SerializedName(value = unitOfMeasure)
val unitOfMeasure: String? = null
unitPrice
Link copied to clipboard
@SerializedName(value = unitPrice)
val unitPrice: DocumentTaxableAmountDto? = null
  • @param unitQuantity The quantity of units of the item. If there is a unit of measure this will be the quantity of the specified units of measure.

unitQuantity
Link copied to clipboard
@SerializedName(value = unitQuantity)
val unitQuantity: BigDecimal? = null