Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details. Line items can either reference objects from the merchant's catalog, or can alternatively specify a name and price instead.
Name | Type | Description | Notes |
---|---|---|---|
name | String | Only used for ad hoc line items. The name of the line item. This value cannot exceed 500 characters. Do not provide a value for this field if you provide values in catalog_object_id. | [optional] |
quantity | String | The quantity to purchase, as a string representation of a number. This string must have a positive integer value. | |
base_price_money | Money | Only used for ad hoc line items. The base price for a single unit of the line item's associated variation. Do not provide a value for this field if you provide a value for the `catalog_object_id`. | [optional] |
variation_name | String | Only used for ad hoc line items. The variation name of the line item. This value cannot exceed 255 characters. If this value is not set for an ad hoc line item, the default value of `Regular` is used. Do not provide a value for this field if you provide a value for the `catalog_object_id`. | [optional] |
note | String | The note of the line item. This value cannot exceed 50 characters. | [optional] |
catalog_object_id | String | Only used for Catalog line items. The catalog object ID from existing CatalogItemVariation. Do not provide a value for this field if you provide a value for `name` and `base_price_money`. | [optional] |
modifiers | Array<CreateOrderRequestModifier> | Only used for Catalog line items. The modifiers to include on the line item. | [optional] |
taxes | Array<CreateOrderRequestTax> | The taxes to include on the line item. | [optional] |
discounts | Array<CreateOrderRequestDiscount> | The discounts to include on the line item. | [optional] |