* docs: added features and guides overview page * added image * added version 2 * added version 3 * added version 4 * docs: implemented new color scheme * docs: redesigned sidebar (#3193) * docs: redesigned navbar for restructure (#3199) * docs: redesigned footer (#3209) * docs: redesigned cards (#3230) * docs: redesigned admonitions (#3231) * docs: redesign announcement bar (#3236) * docs: redesigned large cards (#3239) * docs: redesigned code blocks (#3253) * docs: redesigned search modal and page (#3264) * docs: redesigned doc footer (#3268) * docs: added new sidebars + refactored css and assets (#3279) * docs: redesigned api reference sidebar * docs: refactored css * docs: added code tabs transition * docs: added new sidebars * removed unused assets * remove unusued assets * Fix deploy errors * fix incorrect link * docs: fixed code responsivity + missing icons (#3283) * docs: changed icons (#3296) * docs: design fixes to the sidebar (#3297) * redesign fixes * docs: small design fixes * docs: several design fixes after restructure (#3299) * docs: bordered icon fixes * docs: desgin fixes * fixes to code blocks and sidebar scroll * design adjustments * docs: restructured homepage (#3305) * docs: restructured homepage * design fixes * fixed core concepts icon * docs: added core concepts page (#3318) * docs: restructured homepage * design fixes * docs: added core concepts page * changed text of different components * docs: added architecture link * added missing prop for user guide * docs: added regions overview page (#3327) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page (#3331) * docs: added regions overview * moved region pages to new structure * docs: fixed description of regions architecture page * small changes * small fix * docs: added customers overview page * fix link * resolve link issues * docs: updated regions architecture image * docs: second-iteration fixes (#3347) * docs: redesigned document * design fixes * docs: added products overview page (#3354) * docs: added carts overview page (#3363) * docs: added orders overview (#3364) * docs: added orders overview * added links in overview * docs: added vercel redirects * docs: added soon badge for cards (#3389) * docs: resolved feedback changes + organized troubleshooting pages (#3409) * docs: resolved feedback changes * added extra line * docs: changed icons for restructure (#3421) * docs: added taxes overview page (#3422) * docs: added taxes overview page * docs: fix sidebar label * added link to taxes overview page * fixed link * docs: fixed sidebar scroll (#3429) * docs: added discounts overview (#3432) * docs: added discounts overview * fixed links * docs: added gift cards overview (#3433) * docs: added price lists overview page (#3440) * docs: added price lists overview page * fixed links * docs: added sales channels overview page (#3441) * docs: added sales overview page * fixed links * docs: added users overview (#3443) * docs: fixed sidebar border height (#3444) * docs: fixed sidebar border height * fixed svg markup * docs: added possible solutions to feedback component (#3449) * docs: added several overview pages + restructured files (#3463) * docs: added several overview pages * fixed links * docs: added feature flags + PAK overview pages (#3464) * docs: added feature flags + PAK overview pages * fixed links * fix link * fix link * fixed links colors * docs: added strategies overview page (#3468) * docs: automated upgrade guide (#3470) * docs: automated upgrade guide * fixed vercel redirect * docs: restructured files in docs codebase (#3475) * docs: restructured files * docs: fixed eslint exception * docs: finished restructure loose-ends (#3493) * fixed uses of backend * docs: finished loose ends * eslint fixes * fixed links * merged master * added update instructions for v1.7.12
149 lines
4.3 KiB
Plaintext
149 lines
4.3 KiB
Plaintext
---
|
||
description: "Gift cards are prepaid codes that can be purchased and used during checkout as an alternative to payment methods or to receive a discount. Learn about the available features and guides."
|
||
---
|
||
|
||
import DocCardList from '@theme/DocCardList';
|
||
import DocCard from '@theme/DocCard';
|
||
import Icons from '@theme/Icon';
|
||
|
||
# Gift Cards
|
||
|
||
Gift cards are prepaid codes that can be purchased and used during checkout as an alternative to payment methods or to receive a discount. This overview introduces the available features related to gift cards.
|
||
|
||
:::note
|
||
|
||
Not a developer? Check out the [Gift Cards user guide](../../user-guide/gift-cards/index.md).
|
||
|
||
:::
|
||
|
||
## Features
|
||
|
||
### Gift Card Management
|
||
|
||
Admins can manage their main gift card with unlimited denominations.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/gift-cards/admin/manage-gift-cards',
|
||
label: 'Admin: Manage Gift Cards',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to manage gift cards using Admin APIs.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide/gift-cards/manage',
|
||
label: 'User Guide: Manage Discounts',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'Learn how to manage gift cards using Medusa Admin.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
### Gift Card Purchasing
|
||
|
||
Customers can view the gift card and purchase it on the storefront. Customers can also use the gift card during checkout to deduct the gift card’s balance from the checkout total.
|
||
|
||
Developers can implement custom logic to send the gift card to the customer. They can alternatively implement a Shipping Profile that specifically handles the fulfillment of gift cards.
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/gift-cards/backend/send-gift-card-to-customer',
|
||
label: 'Backend: Send Gift Card Code',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to use send a gift card code to a customer after their purchase.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/gift-cards/storefront/use-gift-cards',
|
||
label: 'Storefront: Use Gift Cards',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to show gift cards to customers and allow them to redeem them.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
### Custom Gift Cards
|
||
|
||
Admins can create custom gift cards that are sent to specific customers. These customers can then use the gift card during checkout, the same way they would if they purchased one.
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide/gift-cards/custom',
|
||
label: 'User Guide: Custom Gift Cards',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'Learn how to manage custom gift cards using Medusa Admin.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/gift-cards/admin/manage-gift-cards#manage-custom-gift-cards',
|
||
label: 'Admin: Manage Custom Gift Cards',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to manage custom gift cards using Admin APIs.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/gift-cards/backend/send-gift-card-to-customer',
|
||
label: 'Backend: Send Gift Card Code',
|
||
customProps: {
|
||
icon: Icons['academic-cap-solid'],
|
||
description: 'Learn how to use send a custom gift card code to a customer.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
---
|
||
|
||
## Understand the Architecture
|
||
|
||
Learn how gift card related entities and concepts are built, their relation to other modules, and more.
|
||
|
||
<DocCard item={{
|
||
type: 'link',
|
||
href: '/modules/gift-cards',
|
||
label: 'Architecture: Gift Card',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
description: 'Learn about the Gift Card architecture.'
|
||
}
|
||
}}
|
||
/>
|
||
|
||
---
|
||
|
||
## Related Modules
|
||
|
||
Discover Gift Card's relation to other modules in Medusa
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/products/overview',
|
||
label: 'Product',
|
||
customProps: {
|
||
icon: Icons['tag-solid'],
|
||
description: 'A store’s main gift card is essentially a Product.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/carts-and-checkout/overview',
|
||
label: 'Cart and Checkout',
|
||
customProps: {
|
||
icon: Icons['shopping-cart-solid'],
|
||
description: 'Gift Cards can be used during checkout.'
|
||
}
|
||
},
|
||
]} /> |