Object Index / Definition

You are viewing an old version of the API
Create​Order​Request​Line​Item

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.

Properties

Name Description
quantity
string

Required

The quantity to purchase, as a string representation of a number.

This string must have a positive integer value.

Max Length 5 Min Length 1
base_price_money
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 CatalogItemVariations. If both catalog_object_id and base_price_money are set, base_price_money will override the CatalogItemVariation's price.

catalog_object_id
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.

Max Length 192
discounts
Create​Order​Request​Discount [ ]

The discounts to include on the line item.

modifiers
Create​Order​Request​Modifier [ ]

Only used for Catalog line items. The modifiers to include on the line item.

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.

Max Length 500
note
string

The note of the line item. This value cannot exceed 500 characters.

Max Length 500
taxes
Create​Order​Request​Tax [ ]

The taxes to include on the line item.

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.

Max Length 255

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?