docs: add loyalty plugin routes to OAS (#12811)
* generated OAS * remove unused schemas * generated specs * add cloud badge for routes * add to loyalty plugin page * allow clicking the tooltip
This commit is contained in:
@@ -159,6 +159,22 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/commerce-modules/fulfillment/item-fulfillment
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminFulfillment"
|
||||
- name: Gift Cards
|
||||
description: >
|
||||
A gift card is a prepaid card that can be used to pay for items during checkout.
|
||||
|
||||
Gift cards can be purchased by customers, or created by admin users. When a gift card is redeemed, its amount
|
||||
is added to the customer's store credit account, which can then be used to pay for items during checkout.
|
||||
|
||||
These API routes allow admin users to manage gift cards, transfer gift cards between customers, and more.
|
||||
|
||||
<Note>
|
||||
|
||||
Gift Card routes are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
|
||||
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminGiftCard"
|
||||
- name: Inventory Items
|
||||
description: |
|
||||
An inventory item is a stock-kept product whose inventory is managed.
|
||||
@@ -502,6 +518,22 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/commerce-modules/stock-location/concepts
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminStockLocation"
|
||||
- name: Store Credit Accounts
|
||||
description: >
|
||||
A store credit account is a ledger of store credit transactions for a customer. They hold the customer's store credit balance,
|
||||
including their credit and debit amounts.
|
||||
|
||||
Store credit accounts allow you to build features that let customers pay for items using their store credit balance, such as gift cards or loyalty points.
|
||||
|
||||
These API routes allow admin users to manage store credit accounts, their transactions, and more.
|
||||
|
||||
<Note>
|
||||
|
||||
Store Credit Account routes are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
|
||||
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminStoreCreditAccount"
|
||||
- name: Stores
|
||||
description: >
|
||||
A store holds the main configuration and information of your commerce
|
||||
@@ -558,6 +590,20 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/commerce-modules/tax/tax-region
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminTaxRegion"
|
||||
- name: Transaction Groups
|
||||
description: >
|
||||
A transaction group is a group of transactions that belong to a store credit account.
|
||||
It allows you to group transactions together, such as all transactions related to a specific gift card.
|
||||
|
||||
These API routes allow admin users to list transaction groups.
|
||||
|
||||
<Note>
|
||||
|
||||
Transaction Group routes are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
|
||||
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminTransactionGroup"
|
||||
- name: Uploads
|
||||
description: >
|
||||
Use these API routes to upload files to your Medusa application using the
|
||||
|
||||
@@ -65,6 +65,36 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/storefront-development/customers
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreCustomer"
|
||||
- name: Gift Card Invitations
|
||||
description: >
|
||||
A gift card invitation is a way to send a gift card to a customer. They
|
||||
can be sent from one customer to another.
|
||||
|
||||
These API routes allow logged-in customers to create and manage gift card invitations.
|
||||
|
||||
<Note>
|
||||
|
||||
Gift Card Invitations are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
|
||||
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreGiftCardInvitation"
|
||||
- name: Gift Cards
|
||||
description: >
|
||||
A gift card is a prepaid card that customers can use to purchase products
|
||||
in the store.
|
||||
|
||||
Customers can purchase gift cards for themselves or others, and then use them to pay for their orders.
|
||||
|
||||
These API routes allow logged-in customers to create and manage their gift cards.
|
||||
|
||||
<Note>
|
||||
|
||||
Gift Cards are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
|
||||
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreGiftCard"
|
||||
- name: Orders
|
||||
description: |
|
||||
Guest and registered customers can view orders they placed.
|
||||
@@ -142,6 +172,14 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/storefront-development/regions
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreRegion"
|
||||
- name: Return Reasons
|
||||
description: >
|
||||
A return reason is a possible reason a customer wants to return an item.
|
||||
|
||||
|
||||
Use these API routes when implementing return creation flow in your storefront to allow customers to select their return reason.
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreReturnReason"
|
||||
- name: Returns
|
||||
description: >
|
||||
Customers can request to return items in their order. The admin user then
|
||||
@@ -151,14 +189,6 @@ tags:
|
||||
These API routes allows customers to create a return.
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreReturn"
|
||||
- name: Return Reasons
|
||||
description: >
|
||||
A return reason is a possible reason a customer wants to return an item.
|
||||
|
||||
|
||||
Use these API routes when implementing return creation flow in your storefront to allow customers to select their return reason.
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreReturnReason"
|
||||
- name: Shipping Options
|
||||
description: >
|
||||
A shipping option is a way of shipping an item to or from the customer.
|
||||
@@ -173,6 +203,20 @@ tags:
|
||||
url: https://docs.medusajs.com/resources/storefront-development/checkout/shipping
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/StoreShippingOption"
|
||||
- name: Store Credit Accounts
|
||||
x-associatedSchema:
|
||||
description: >
|
||||
A store credit account is a way for customers to manage their store credit balance.
|
||||
Customers can use their store credit to pay for orders, and view their store credit balance.
|
||||
|
||||
These API routes allow customers to view their store credit accounts.
|
||||
|
||||
<Note>
|
||||
|
||||
Store Credit Accounts are only available for Cloud users using the [Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
|
||||
|
||||
</Note>
|
||||
$ref: "#/components/schemas/StoreStoreCreditAccount"
|
||||
servers:
|
||||
- url: http://localhost:9000
|
||||
- url: https://api.medusajs.com
|
||||
|
||||
Reference in New Issue
Block a user