Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
23 lines (16 loc) · 2.54 KB

CreateOrderRequestLineItem.md

File metadata and controls

23 lines (16 loc) · 2.54 KB

CreateOrderRequestLineItem

Description

Deprecated: Please use the OrderLineItem type in the order field of CreateOrderRequest instead. 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. Note: This model is deprecated.

Properties

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 a value for `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.
basePriceMoney Money The base price for a single unit of the line item. `base_price_money` is required for ad hoc line items and variable priced `CatalogItemVariation`s. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the CatalogItemVariation's price. [optional]
variationName 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 500 characters. [optional]
catalogObjectId String Only used for Catalog line items. The catalog object ID for an existing `CatalogItemVariation`. Do not provide a value for this field if you provide a value for `name` and `base_price_money`. [optional]
modifiers List<CreateOrderRequestModifier> Only used for Catalog line items. The modifiers to include on the line item. [optional]
taxes List<CreateOrderRequestTax> The taxes to include on the line item. [optional]
discounts List<CreateOrderRequestDiscount> The discounts to include on the line item. [optional]