222 lines
5.7 KiB
YAML
222 lines
5.7 KiB
YAML
type: object
|
|
description: The item's items.
|
|
x-schemaName: BaseOrderLineItem
|
|
required:
|
|
- id
|
|
- title
|
|
- subtitle
|
|
- thumbnail
|
|
- variant_id
|
|
- product_id
|
|
- product_title
|
|
- product_description
|
|
- product_subtitle
|
|
- product_type_id
|
|
- product_type
|
|
- product_collection
|
|
- product_handle
|
|
- variant_sku
|
|
- variant_barcode
|
|
- variant_title
|
|
- variant_option_values
|
|
- requires_shipping
|
|
- is_discountable
|
|
- is_tax_inclusive
|
|
- unit_price
|
|
- quantity
|
|
- detail
|
|
- created_at
|
|
- updated_at
|
|
- metadata
|
|
- original_total
|
|
- original_subtotal
|
|
- original_tax_total
|
|
- item_total
|
|
- item_subtotal
|
|
- item_tax_total
|
|
- total
|
|
- subtotal
|
|
- tax_total
|
|
- discount_total
|
|
- discount_tax_total
|
|
- refundable_total
|
|
- refundable_total_per_unit
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id
|
|
description: The item's ID.
|
|
title:
|
|
type: string
|
|
title: title
|
|
description: The item's title.
|
|
subtitle:
|
|
type: string
|
|
title: subtitle
|
|
description: The item's subtitle.
|
|
thumbnail:
|
|
type: string
|
|
title: thumbnail
|
|
description: The URL of the item's thumbnail.
|
|
variant:
|
|
$ref: ./BaseProductVariant.yaml
|
|
variant_id:
|
|
type: string
|
|
title: variant_id
|
|
description: The ID of the associated variant.
|
|
product:
|
|
$ref: ./BaseProduct.yaml
|
|
product_id:
|
|
type: string
|
|
title: product_id
|
|
description: The ID of the associated product.
|
|
product_title:
|
|
type: string
|
|
title: product_title
|
|
description: The item's product title.
|
|
product_description:
|
|
type: string
|
|
title: product_description
|
|
description: The item's product description.
|
|
product_subtitle:
|
|
type: string
|
|
title: product_subtitle
|
|
description: The item's product subtitle.
|
|
product_type:
|
|
type: string
|
|
title: product_type
|
|
description: The item's product type.
|
|
product_collection:
|
|
type: string
|
|
title: product_collection
|
|
description: The ID of the collection the item's product belongs to.
|
|
product_handle:
|
|
type: string
|
|
title: product_handle
|
|
description: The item's product handle.
|
|
variant_sku:
|
|
type: string
|
|
title: variant_sku
|
|
description: The item's variant SKU.
|
|
variant_barcode:
|
|
type: string
|
|
title: variant_barcode
|
|
description: The item's variant barcode.
|
|
variant_title:
|
|
type: string
|
|
title: variant_title
|
|
description: The item's variant title.
|
|
variant_option_values:
|
|
type: object
|
|
description: The values of the item variant's options.
|
|
example:
|
|
Color: Blue
|
|
requires_shipping:
|
|
type: boolean
|
|
title: requires_shipping
|
|
description: Whether the item requires shipping.
|
|
is_discountable:
|
|
type: boolean
|
|
title: is_discountable
|
|
description: Whether the item is discountable.
|
|
is_tax_inclusive:
|
|
type: boolean
|
|
title: is_tax_inclusive
|
|
description: Whether the item is tax inclusive.
|
|
compare_at_unit_price:
|
|
type: number
|
|
title: compare_at_unit_price
|
|
description: The original price of the item before a promotion or sale.
|
|
unit_price:
|
|
type: number
|
|
title: unit_price
|
|
description: The item's unit price.
|
|
quantity:
|
|
type: number
|
|
title: quantity
|
|
description: The item's quantity.
|
|
tax_lines:
|
|
type: array
|
|
description: The item's tax lines.
|
|
items:
|
|
$ref: ./BaseOrderLineItemTaxLine.yaml
|
|
adjustments:
|
|
type: array
|
|
description: The item's adjustments.
|
|
items:
|
|
$ref: ./BaseOrderLineItemAdjustment.yaml
|
|
detail:
|
|
$ref: ./BaseOrderItemDetail.yaml
|
|
created_at:
|
|
type: string
|
|
format: date-time
|
|
title: created_at
|
|
description: The date the item was created.
|
|
updated_at:
|
|
type: string
|
|
format: date-time
|
|
title: updated_at
|
|
description: The date the item was updated.
|
|
metadata:
|
|
type: object
|
|
description: The item's metadata, can hold custom key-value pairs.
|
|
externalDocs:
|
|
url: https://docs.medusajs.com/api/store#manage-metadata
|
|
description: Learn how to manage metadata
|
|
original_total:
|
|
type: number
|
|
title: original_total
|
|
description: The item's total including taxes, excluding promotions.
|
|
original_subtotal:
|
|
type: number
|
|
title: original_subtotal
|
|
description: The item's total excluding taxes, including promotions.
|
|
original_tax_total:
|
|
type: number
|
|
title: original_tax_total
|
|
description: The total taxes of the item, excluding promotions.
|
|
item_total:
|
|
type: number
|
|
title: item_total
|
|
description: The total taxes of the item, including promotions.
|
|
item_subtotal:
|
|
type: number
|
|
title: item_subtotal
|
|
description: The item's total excluding taxes, including promotions.
|
|
item_tax_total:
|
|
type: number
|
|
title: item_tax_total
|
|
description: The total taxes of the item, including promotions.
|
|
total:
|
|
type: number
|
|
title: total
|
|
description: The item's total, including taxes and promotions.
|
|
subtotal:
|
|
type: number
|
|
title: subtotal
|
|
description: The item's subtotal excluding taxes, including promotions.
|
|
tax_total:
|
|
type: number
|
|
title: tax_total
|
|
description: The tax total of the item including promotions.
|
|
discount_total:
|
|
type: number
|
|
title: discount_total
|
|
description: The total discount amount of the item.
|
|
discount_tax_total:
|
|
type: number
|
|
title: discount_tax_total
|
|
description: The total taxes applied on the discounted amount.
|
|
refundable_total:
|
|
type: number
|
|
title: refundable_total
|
|
description: The total refundable amount of the item's total.
|
|
refundable_total_per_unit:
|
|
type: number
|
|
title: refundable_total_per_unit
|
|
description: The total refundable amount of the item's total for a single quantity.
|
|
product_type_id:
|
|
type: string
|
|
title: product_type_id
|
|
description: The ID of the associated product's type.
|