AppsThemesSupport

line_item

Suggest Edits

A line in a cart, or order. Each line item represents a product variant.

PropertiesTypeDescription
allocation_methodstring from a set of values, refer to allocation_method valuesPurchase limit rules.
allow_oversoldstring from a set of values, refer to allow_oversold valuesWhether to buy at the selling price after the sale exceeds.
can_buybooleanReturns true if the line item's variant can be sold. Returns false if not.
cart_idstringThe cart id of the parent cart of the line item.
compare_at_pricestringThe compare at price of the line item.
customary_off_rationumberThe customary discount ratio of the line item.
customary_saved_pricestringThe customary saved price of the line item.
barcodestringThe barcode of the line item's variant.
discount_applicationsan array of discount_applicationThe discount applications for the line item.
discount_idstringThe id of the discount application of the line item.
discount_off_ratiostringThe discount ratio of the line item.
discount_pricestringThe discount price of the line item.
discount_salesnumberThe sales of the discount of the line item's variant.
discount_saved_pricenumberThe discount saved price of the line item.
discount_stocknumberThe stock of the discount of the line item's variant.
discount_totalstringThe discount total of the line item.
ends_atnumberA timestamp of the end of the discount.
final_line_pricestringThe combined price, in the currency's subunit, of all of the items in the line item. This includes any line-level discounts.

The value is equal to line_item.final_price multiplied by line_item.quantity. It's output in the customer's local (presentment) currency.
final_pricestringThe price of the line item in the currency's subunit. This includes any line-level discounts.

The value is output in the customer's local (presentment) currency.
idstringThe ID of the line item.
imageimageThe image of the line item's variant.
inventory_quantitynumberThe inventory quantity of the line item's variant.
line_pricestringThe combined price of the line item.
mixed_wholesalebooleanReturns true if the line item's product supports mixed wholesale. Returns false if not.
notestringThe note of the line item.
optionsan array of variant_optionThe values of the line item's variant of the product option.
original_line_pricenumberThe original price of the line item.
pricestringThe price of the line item.
product_handlestringThe handle of the line item's product.
product_idstringThe ID of the line item's product.
product_tagsan array of stringThe tags of the line item's product.
product_titlestringThe title of the line item's product.
product_urlstringThe URL of the line item's product.
propertiesThe properties of the line item.

You can add, or allow customers to add, custom information to a line item by the Product options app.
publishedbooleanReturns true if the line item's product was published. Returns false if not.
quantitystringThe quantity of the line item.
requires_shippingbooleanReturns true if the line item's product needs shipping. Returns false if not
retail_pricestringThe retail price of the line item's variant in the currency's subunit..
saved_pricenumberThe saved price of the line item.
skustringThe SKU of the line item's variant.
starts_atnumberA timestamp of the start of the discount.
store_idstringThe store id.
taxablebooleanReturns true if taxes should be charged on the line item's product. Returns false if not.
use_before_pricenumberReturns false if the price before the line item isn't used.
variant_idstringThe ID of the line item's variant.
variant_titlestringThe title of the line item's variant.
vendorstringThe vendor of the line item's product.
vendor_urlstringThe vendor URL of the line item's product.
weightstringThe weight of the line item's variant.
weight_unitstringThe weight unit of the line item's variant.
wholesale_pricearrayThe wholesale price of the line item's variant.

allow_oversold values

Possible valuesDescription
checkBuy at selling price after oversold
unchecknot oversell

allocation_method values

Possible valuesDescription
allPurchase limit specified per person per activity.
eachEach person is limited to purchasing the specified quantity of each item.
noneNo limit.
{
  "id": "298049_1825cbb82902c53fdc4e12283829e832",
  "properties": "",
  "note": "",
  "variant_id": "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
  "product_id": "b1ab6324-ae4f-4cca-907e-18af16839447",
  "quantity": "1",
  "discount_id": "65c00d9b-060c-4206-a2d8-f2971cacee43",
  "limit_time": -1,
  "limit_buy": 0,
  "user_limit_buy": -1,
  "discount_sales": 1,
  "discount_sales_rate": "1",
  "discount_stock": 87,
  "ends_at": -1,
  "starts_at": 1682405275,
  "allow_oversold": "uncheck",
  "allocation_method": "none",
  "price": "205.2",
  "compare_at_price": "228",
  "discount_price": "205.2",
  "customary_saved_price": "22.8",
  "customary_off_ratio": 10,
  "discount_saved_price": "22.8",
  "discount_off_ratio": "10",
  "use_before_price": false,
  "before_price": "188",
  "title": "促销",
  "trunk_price": "0",
  "total_price": "0",
  "inventory_tracking": true,
  "inventory_policy": "deny",
  "inventory_quantity": 87,
  "cart_id": "298049",
  "store_id": "7126",
  "user_id": "",
  "user_sign": "8f7be7ef-367f-473c-91b6-b32a75971450",
  "created_at": "2023-07-06 14:09:48",
  "updated_at": "2023-07-06 14:09:48",
  "custom": false,
  "parts_price": null,
  "variant_title": "pink",
  "product_title": "Sale Squared Sunglasses ",
  "product_handle": "sale-squared-sunglasses",
  "product_tags": [
    "Color_Lightcoral",
    "Location_Alabama",
    "Price_$200-$300"
  ],
  "published": true,
  "published_at": "2022-08-11T08:15:07Z",
  "product_url": "/products/sale-squared-sunglasses",
  "available": true,
  "available_quantity": 87,
  "cost_price": "0.00",
  "weight": "0.00",
  "weight_unit": "kg",
  "sku": "",
  "spu": "",
  "vendor": "Nero Theme Fashion",
  "vendor_url": "",
  "taxable": false,
  "requires_shipping": true,
  "barcode": "",
  "mixed_wholesale": false,
  "tax_code": "",
  "retail_price": "0.00",
  "product_type": "",
  "image": {
    "src": "//cdn.shoplazza.com/d8217e1e2e216cd8b71b1035bde035ec.jpeg",
    "path": "d8217e1e2e216cd8b71b1035bde035ec.jpeg",
    "width": 1280,
    "height": 1710,
    "alt": ""
  },
  "options": [
    {
      "name": "Color",
      "value": "pink"
    }
  ],
  "wholesale_price": [
    {
      "min_quantity": 1,
      "price": "205.20"
    }
  ],
  "discount_applications": [
    {
      "type": "discount_flashsale",
      "subtype": "discount_flashsale",
      "discount_id": "65c00d9b-060c-4206-a2d8-f2971cacee43",
      "title": "促销",
      "value": "",
      "discount_type": "",
      "value_type": "",
      "allocation_method": "",
      "target_selection": "",
      "target_type": "",
      "total_discount_amount": "0",
      "discount_amount": "0",
      "is_free_gift": false,
      "icon": "//cdn.shoplazza.com/oss/operation/372e6ab307143855fbd0ad3d28568d1e.svg"
    }
  ],
  "saved_price": 22.8,
  "line_price": "205.20",
  "original_line_price": 228,
  "flashsale_tip": false,
  "discount_info": {
    "id": "298049",
    "variant_id": "4a3d825c-2fac-4f72-a68b-b8604b0935c4",
    "product_id": "b1ab6324-ae4f-4cca-907e-18af16839447",
    "quantity": 1,
    "discount_id": "65c00d9b-060c-4206-a2d8-f2971cacee43",
    "limit_time": -1,
    "limit_buy": 0,
    "user_limit_buy": -1,
    "discount_sales": 1,
    "discount_sales_rate": "1",
    "discount_stock": 87,
    "ends_at": -1,
    "starts_at": 1682405275,
    "allow_oversold": "uncheck",
    "allocation_method": "none",
    "price": "205.2",
    "compare_at_price": "228",
    "discount_price": "205.2",
    "customary_saved_price": "22.8",
    "customary_off_ratio": "10",
    "discount_saved_price": "22.8",
    "discount_off_ratio": "10",
    "use_before_price": false,
    "before_price": "188",
    "title": "促销",
    "trunk_price": "0",
    "total_price": "0",
    "inventory_tracking": true,
    "inventory_policy": "deny",
    "inventory_quantity": 87
  },
  "item_id": "298049",
  "can_buy": true,
  "discount_total": "0.00",
  "final_line_price": "205.20",
  "final_price": "205.20"
}

Updated 10 months ago