Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 3.12 KB

Product.md

File metadata and controls

23 lines (19 loc) · 3.12 KB

Product

Properties

Name Type Description Notes
code string Identifier for this product given by the merchant. Not validated for uniqueness by OPG. May appear on customer invoice. [optional]
name string Human readable name of this product. May appear on customer invoice.
amount double Total price of this product record with respect to `quantity` field. For example, if single item of product costs `10.00` and `quantity` indicates `2` items in this product record, the value of this field must be `20.00`. The sum of all product amounts should match the `amount` field in `payment` object. [optional]
net_amount double Total net price of this product record with respect to the `quantity` field. For example, if single item of product costs `10.00` and `quantity` indicates `2` items in this product record, the value of this field must be `20.00`. [optional]
tax_amount double Total tax amount (e.g. VAT amount) of this product record. [optional]
tax_rate_percentage double Tax rate percentage (e.g. VAT tax rate) for this product record. [optional]
currency string Currency of the `amount` field. Value format is according to ISO-4217 form, e.g. "EUR", "USD". If undefined the currency will be taken from `payment` object. [optional]
quantity int Product quantity. By default is `1`. [optional]
planned_shipping_date \DateTime Date (or time stamp) of planned shipment for this product record. [optional]
product_description_url string URL to product description page. This URL can be used by PSP to build an order-friendly payment page during checkout or during future communication with customer about this order or product. [optional]
product_image_url string URL to product image. This URL can be used by PSP to build an order-friendly payment page during checkout or during future communication with customer about this order or product. [optional]
description string Product description in free form (no markup supported). [optional]
shipping_address_id string Shipping address ID to deliver this product to. If undefined, the product is delivered to the address described by `customer.addresses.shipping` property. [optional]
type string Defines a type of the product: * `PHYSICAL` - Physical product * `DIGITAL` - Digital product * `SERVICE` - Service * `TAX` - The type which should be used in the case when the tax information about shopping card should be provided as a separate order line (common case for USA market) * `OTHER` - Other types not listed above [optional]

[Back to Model list] [Back to API list] [Back to README]