Files
medusa-store/docs/api/admin/components/schemas/LineItemAdjustment.yaml
2022-12-22 17:09:49 +02:00

40 lines
1.0 KiB
YAML

title: Line Item Adjustment
description: Represents a Line Item Adjustment
type: object
required:
- item_id
- description
- amount
properties:
id:
type: string
description: The invite's ID
example: lia_01G8TKE4XYCTHSCK2GDEP47RE1
item_id:
type: string
description: The ID of the line item
example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
item:
description: Available if the relation `item` is expanded.
$ref: ./LineItem.yaml
description:
type: string
description: The line item's adjustment description
example: Adjusted item's price.
discount_id:
type: string
description: The ID of the discount associated with the adjustment
example: disc_01F0YESMW10MGHWJKZSDDMN0VN
discount:
description: Available if the relation `discount` is expanded.
$ref: ./Discount.yaml
amount:
type: number
description: The adjustment amount
example: 1000
metadata:
type: object
description: An optional key-value map with additional details
example:
car: white