Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminCreateOrderCreditLine.yaml
2025-10-31 16:15:46 +02:00

30 lines
838 B
YAML

type: object
description: The details of a credit line to add to an order.
x-schemaName: AdminCreateOrderCreditLine
required:
- amount
- reference
- reference_id
properties:
amount:
type: number
title: amount
description: The amount of the credit line.
example: 100
reference:
type: string
title: reference
description: The name of the table that the credit line is referencing.
example: order
reference_id:
type: string
title: reference_id
description: The ID of a record in the table that the credit line is referencing.
example: order_123
metadata:
type: object
description: The credit line's metadata, can hold custom key-value pairs.
externalDocs:
url: https://docs.medusajs.com/api/admin#manage-metadata
description: Learn how to manage metadata