On this page
No Headings
The item details.
objectitem_codestring^[a-zA-Z0-9_'\-., ":;\!?]*$An item code that identifies a merchant's goods or service.
item_namestring^[a-zA-Z0-9_'\-., ":;\!?]*$The item name.
item_descriptionstring^[a-zA-Z0-9_'\-., ":;\!?]*$The item description.
item_optionsstring^[a-zA-Z0-9_'\-., ":;\!?]*$The item options. Describes option choices on the purchase of the item in some detail.
item_quantitystring^[a-zA-Z0-9_'\-., ":;\!?]*$The number of purchased units of goods or a service.
item_unit_priceobjectThe cost for each instance of goods or a service.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.item_amountobjectThe amount of the payment for the item.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.discount_amountobjectThe reduction in price associated with goods or a service.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.adjustment_amountobjectAn increment or decrement to a purchase amount.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.gift_wrap_amountobjectThe amount of money charged for gift wrapping an item.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_percentagestringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$A rate, expressed in hundreds, that is used to calculate a levy for the purchase of goods or services.
tax_amountsarrayAn array of tax amounts levied by a government on the purchase of goods or services.
itemsobjectThe tax levied by a government on the purchase of goods or services.
tax_amountobjectThe tax levied by a government on the purchase of goods or services.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.basic_shipping_amountobjectThe delivery cost.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.extra_shipping_amountobjectThe cost for expedited delivery of the goods.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.handling_amountobjectA charge for processing the purchase of goods or services.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.insurance_amountobjectA charge for guaranteeing the quality of a product or delivery of a product.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.total_item_amountobjectThe sum of all factors, item cost, discounts, tax, shipping, and so on, that goes into the cost of an item.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.invoice_numberstring^[a-zA-Z0-9_'\-., ":;\!?]*$The invoice number. An alphanumeric string that identifies a billing for a merchant.
checkout_optionsarrayAn array of checkout options. Each option has a name and value.
itemsobjectA checkout option as a name-and-value pair.
checkout_option_namestring^[a-zA-Z0-9_'\-., ":;\!?]*$The checkout option name, such as color or texture.
checkout_option_valuestring^[a-zA-Z0-9_'\-., ":;\!?]*$The checkout option value. For example, the checkout option color might be blue or red while the checkout option texture might be smooth or rippled.