Files
medusa-store/www/docs/content/user-guide/discounts/create.mdx
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770)
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

98 lines
5.9 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
sidebar_position: 2
description: 'This user guide explains how to create a discount on the Medusa admin.'
addHowToData: true
---
import UiIcon from '@site/src/components/UiIcon';
# Create a Discount
In this document, youll learn how to create a discount.
## How to Create a Discount
To create a discount:
1. Go to Discounts.
2. Click on the Add Discount button.
This opens a form with collapsible sections to fill in different information about the discount.
### Discount Type
In this section, you have to select the discount type. There are three types:
1. **Percentage:** discount a specific percentage of the price of each item that complies with the discount conditions.
2. **Fixed amount:** discount a specific amount either from the cart total or from the price each item that complies with the discount conditions. After choosing this type, a new field Allocation will show where you can choose how the discount should be applied.
3. **Free shipping:** Remove any shipping amount available during checkout.
Choose the type of the discount and fill in any additional fields if necessary.
### General
In this section, you have to enter general but required information related to the discount:
1. In the “Choose valid regions” field, choose the regions this discount should be applied in. You must select at least one region. For the Fixed Discount type, you can only pick one region. For other types you can select more than one region.
2. In the Code field, enter the code that the customers have to enter during checkout for the discount to be applied. Only uppercase letters and numbers are allowed.
3. If you chose Percentage for Discount Type earlier, enter the percentage that should be discounted in the Percentage field.
4. If you chose Fixed Amount for Discount Type earlier, enter the amount that should be discounted in the Amount field.
5. In the Description field, enter a description for the discount.
6. You can check the “This is a template discount” checkbox to create a template discount. You can use template discounts to reuse discount rules and configurations across a group of discounts.
### Configuration
In this section, you can set configurations that limit the application of the discount:
1. Toggle the Start date field if you want to set the date and time the customers can start using this discount. If you dont set a start date, the discount can be used once its published.
2. Toggle the “Discount has an expiry date?” field if you want to set the date and time the discount ends. If you dont set an expiry date, the discount can be used forever while its published.
3. Toggle the “Limit the number of redemptions?” field if you want to limit how many times the discount can be used. This number is used across customers, and not per customer. If you dont set a limit, the discount can be used unlimitedly.
4. If you chose to make the discount a template discount earlier, you can toggle the “Availability duration?” field to set the duration of the discount in years, months, days, hours, and minutes.
### Conditions
In this section, you can set the conditions that define when the discount can be applied. When the discount is used on a cart, it will only be applied if the items in the cart and the customer fit the discounts conditions.
The following condition types can be used:
1. **Product:** specify products that this discount can/cant be used with.
2. **Customer groups:** specify customer groups that this discount can/cant be used with.
3. **Tag:** specify tags that this discount can/cant be used with.
4. **Collection:** specify the collection that this discount can/cant be used with.
5. **Type:** specify the product type that this discount can/cant be used with.
To add a condition to the discount:
1. Click on the Add Condition button.
2. Click on the condition type.
3. In the new list that opens:
1. Choose at the top either “In” or “Not In,” where “In” indicates that the discount can be applied to the items selected in this list, and “Not In” indicates that the discount can be applied to all items except those selected in this list.
2. Select the items from the list.
4. Once done, click “Save and add more” to add more conditions, or click “Save and close” to close the conditions window.
:::info
You can use a condition type for only one condition. After using a condition type, you will not be able to use it again for another condition. Youll need to edit the condition you added if you need to make any changes.
:::
To edit a condition you already added to the discount:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the condition.
2. Click on Edit from the dropdown.
3. Make changes to the condition in the new window that opens.
4. Once done, click on the Save button.
To delete a condition you already added to the discount:
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon next to the condition.
2. Click on “Delete condition” from the dropdown.
### Save Discount
After filling out previous sections, you can save the discount by either clicking the “Save as draft” or “Publish discount” buttons.
If you save the discount as a draft, customers will not be able to use it but all of the information, configurations, and conditions will be saved. You can publish it at a later point.
If you publish the discount, customers will be able to use it within the configurations and conditions youve set. You can change the status of the discount back to draft later on as well.