fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
55 lines
1.4 KiB
YAML
55 lines
1.4 KiB
YAML
title: Gift Card Transaction
|
|
description: >-
|
|
Gift Card Transactions are created once a Customer uses a Gift Card to pay for
|
|
their Order.
|
|
type: object
|
|
required:
|
|
- amount
|
|
- created_at
|
|
- gift_card_id
|
|
- id
|
|
- is_taxable
|
|
- order_id
|
|
- tax_rate
|
|
properties:
|
|
id:
|
|
description: The gift card transaction's ID
|
|
type: string
|
|
example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A
|
|
gift_card_id:
|
|
description: The ID of the Gift Card that was used in the transaction.
|
|
type: string
|
|
example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
|
|
gift_card:
|
|
description: The details of the gift card associated used in this transaction.
|
|
x-expandable: gift_card
|
|
nullable: true
|
|
type: object
|
|
order_id:
|
|
description: The ID of the order that the gift card was used for payment.
|
|
type: string
|
|
example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
|
|
order:
|
|
description: The details of the order that the gift card was used for payment.
|
|
x-expandable: order
|
|
nullable: true
|
|
type: object
|
|
amount:
|
|
description: The amount that was used from the Gift Card.
|
|
type: integer
|
|
example: 10
|
|
created_at:
|
|
description: The date with timezone at which the resource was created.
|
|
type: string
|
|
format: date-time
|
|
is_taxable:
|
|
description: Whether the transaction is taxable or not.
|
|
nullable: true
|
|
type: boolean
|
|
example: false
|
|
tax_rate:
|
|
description: The tax rate of the transaction
|
|
nullable: true
|
|
type: number
|
|
example: 0
|