914d773d3a
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
244 lines
6.9 KiB
YAML
244 lines
6.9 KiB
YAML
title: Line Item
|
|
description: >-
|
|
Line Items are created when a product is added to a Cart. When Line Items are
|
|
purchased they will get copied to the resulting order, swap, or claim, and can
|
|
eventually be referenced in Fulfillments and Returns. Line items may also be
|
|
used for order edits.
|
|
type: object
|
|
required:
|
|
- allow_discounts
|
|
- cart_id
|
|
- claim_order_id
|
|
- created_at
|
|
- description
|
|
- fulfilled_quantity
|
|
- has_shipping
|
|
- id
|
|
- is_giftcard
|
|
- is_return
|
|
- metadata
|
|
- order_edit_id
|
|
- order_id
|
|
- original_item_id
|
|
- quantity
|
|
- returned_quantity
|
|
- shipped_quantity
|
|
- should_merge
|
|
- swap_id
|
|
- thumbnail
|
|
- title
|
|
- unit_price
|
|
- updated_at
|
|
- variant_id
|
|
properties:
|
|
id:
|
|
description: The line item's ID
|
|
type: string
|
|
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
|
|
cart_id:
|
|
description: The ID of the cart that the line item may belongs to.
|
|
nullable: true
|
|
type: string
|
|
example: cart_01G8ZH853Y6TFXWPG5EYE81X63
|
|
cart:
|
|
description: The details of the cart that the line item may belongs to.
|
|
x-expandable: cart
|
|
nullable: true
|
|
type: object
|
|
order_id:
|
|
description: The ID of the order that the line item may belongs to.
|
|
nullable: true
|
|
type: string
|
|
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
order:
|
|
description: The details of the order that the line item may belongs to.
|
|
x-expandable: order
|
|
nullable: true
|
|
type: object
|
|
swap_id:
|
|
description: The ID of the swap that the line item may belong to.
|
|
nullable: true
|
|
type: string
|
|
example: null
|
|
swap:
|
|
description: The details of the swap that the line item may belong to.
|
|
x-expandable: swap
|
|
nullable: true
|
|
type: object
|
|
claim_order_id:
|
|
description: The ID of the claim that the line item may belong to.
|
|
nullable: true
|
|
type: string
|
|
example: null
|
|
claim_order:
|
|
description: The details of the claim that the line item may belong to.
|
|
x-expandable: claim_order
|
|
nullable: true
|
|
type: object
|
|
tax_lines:
|
|
description: The details of the item's tax lines.
|
|
x-expandable: tax_lines
|
|
type: array
|
|
items:
|
|
$ref: ./LineItemTaxLine.yaml
|
|
adjustments:
|
|
description: >-
|
|
The details of the item's adjustments, which are available when a discount
|
|
is applied on the item.
|
|
x-expandable: adjustments
|
|
type: array
|
|
items:
|
|
$ref: ./LineItemAdjustment.yaml
|
|
original_item_id:
|
|
description: >-
|
|
The ID of the original line item. This is useful if the line item belongs
|
|
to a resource that references an order, such as a return or an order edit.
|
|
nullable: true
|
|
type: string
|
|
order_edit_id:
|
|
description: The ID of the order edit that the item may belong to.
|
|
nullable: true
|
|
type: string
|
|
order_edit:
|
|
description: The details of the order edit.
|
|
x-expandable: order_edit
|
|
nullable: true
|
|
type: object
|
|
title:
|
|
description: The title of the Line Item.
|
|
type: string
|
|
example: Medusa Coffee Mug
|
|
description:
|
|
description: A more detailed description of the contents of the Line Item.
|
|
nullable: true
|
|
type: string
|
|
example: One Size
|
|
thumbnail:
|
|
description: A URL string to a small image of the contents of the Line Item.
|
|
nullable: true
|
|
type: string
|
|
format: uri
|
|
example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png
|
|
is_return:
|
|
description: Is the item being returned
|
|
type: boolean
|
|
default: false
|
|
is_giftcard:
|
|
description: Flag to indicate if the Line Item is a Gift Card.
|
|
type: boolean
|
|
default: false
|
|
should_merge:
|
|
description: >-
|
|
Flag to indicate if new Line Items with the same variant should be merged
|
|
or added as an additional Line Item.
|
|
type: boolean
|
|
default: true
|
|
allow_discounts:
|
|
description: >-
|
|
Flag to indicate if the Line Item should be included when doing discount
|
|
calculations.
|
|
type: boolean
|
|
default: true
|
|
has_shipping:
|
|
description: Flag to indicate if the Line Item has fulfillment associated with it.
|
|
nullable: true
|
|
type: boolean
|
|
example: false
|
|
unit_price:
|
|
description: >-
|
|
The price of one unit of the content in the Line Item. This should be in
|
|
the currency defined by the Cart/Order/Swap/Claim that the Line Item
|
|
belongs to.
|
|
type: integer
|
|
example: 8000
|
|
variant_id:
|
|
description: The id of the Product Variant contained in the Line Item.
|
|
nullable: true
|
|
type: string
|
|
example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
|
|
variant:
|
|
description: The details of the product variant that this item was created from.
|
|
x-expandable: variant
|
|
nullable: true
|
|
$ref: ./ProductVariant.yaml
|
|
quantity:
|
|
description: The quantity of the content in the Line Item.
|
|
type: integer
|
|
example: 1
|
|
fulfilled_quantity:
|
|
description: The quantity of the Line Item that has been fulfilled.
|
|
nullable: true
|
|
type: integer
|
|
example: 0
|
|
returned_quantity:
|
|
description: The quantity of the Line Item that has been returned.
|
|
nullable: true
|
|
type: integer
|
|
example: 0
|
|
shipped_quantity:
|
|
description: The quantity of the Line Item that has been shipped.
|
|
nullable: true
|
|
type: integer
|
|
example: 0
|
|
refundable:
|
|
description: >-
|
|
The amount that can be refunded from the given Line Item. Takes taxes and
|
|
discounts into consideration.
|
|
type: integer
|
|
example: 0
|
|
subtotal:
|
|
description: The subtotal of the line item
|
|
type: integer
|
|
example: 8000
|
|
tax_total:
|
|
description: The total of tax of the line item
|
|
type: integer
|
|
example: 0
|
|
total:
|
|
description: The total amount of the line item
|
|
type: integer
|
|
example: 8000
|
|
original_total:
|
|
description: The original total amount of the line item
|
|
type: integer
|
|
example: 8000
|
|
original_tax_total:
|
|
description: The original tax total amount of the line item
|
|
type: integer
|
|
example: 0
|
|
discount_total:
|
|
description: The total of discount of the line item rounded
|
|
type: integer
|
|
example: 0
|
|
raw_discount_total:
|
|
description: The total of discount of the line item
|
|
type: integer
|
|
example: 0
|
|
gift_card_total:
|
|
description: The total of the gift card of the line item
|
|
type: integer
|
|
example: 0
|
|
includes_tax:
|
|
description: Indicates if the line item unit_price include tax
|
|
x-featureFlag: tax_inclusive_pricing
|
|
type: boolean
|
|
default: false
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
updated_at:
|
|
description: The date with timezone at which the resource was updated.
|
|
type: string
|
|
format: date-time
|
|
metadata:
|
|
description: An optional key-value map with additional details
|
|
nullable: true
|
|
type: object
|
|
example:
|
|
car: white
|
|
externalDocs:
|
|
description: Learn about the metadata attribute, and how to delete and update it.
|
|
url: >-
|
|
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|