Merge branch 'master' into develop
This commit is contained in:
commit
94eb2bfc02
301 files changed
+8779
-3776
No files matched your search
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
"medusa-payment-manual": patch
|
||||||
|
---
|
||||||
|
|
||||||
|
fix(medusa-payment-manual): Add missing update method
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
name: Generate Docs Release Announcement Bar
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
add-announcement:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.REFERENCE_PAT }}
|
||||||
|
steps:
|
||||||
|
- name: Cancel Previous Runs
|
||||||
|
uses: styfle/cancel-workflow-action@0.9.1
|
||||||
|
with:
|
||||||
|
access_token: ${{ github.token }}
|
||||||
|
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2.3.5
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Node.js environment
|
||||||
|
uses: actions/setup-node@v2.4.1
|
||||||
|
with:
|
||||||
|
node-version: "14"
|
||||||
|
cache: "yarn"
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
uses: ./.github/actions/cache-deps
|
||||||
|
with:
|
||||||
|
extension: docs-release
|
||||||
|
|
||||||
|
- name: Build Packages
|
||||||
|
run: yarn build
|
||||||
|
|
||||||
|
- name: Generate Announcement Bar
|
||||||
|
run: yarn generate:announcement
|
||||||
|
|
||||||
|
- name: Create Pull Request
|
||||||
|
uses: peter-evans/create-pull-request@v4
|
||||||
|
with:
|
||||||
|
commit-message: 'chore(docs): Generated Docs Announcement Bar (automated)'
|
||||||
|
base: 'master'
|
||||||
|
title: 'chore(docs): Generated Docs Announcement Bar (automated)'
|
||||||
|
labels: 'type: chore'
|
||||||
|
add-paths: www/docs/**
|
||||||
|
branch: 'chore/generate-announcement'
|
||||||
|
branch-suffix: 'timestamp'
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
# Checks if the announcement bar info was last edited more than 6 days ago, and if so removes it
|
||||||
|
name: Remove Docs Release Announcement Bar
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: '0 0 * * *'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
remove-announcement:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.REFERENCE_PAT }}
|
||||||
|
steps:
|
||||||
|
- name: Cancel Previous Runs
|
||||||
|
uses: styfle/cancel-workflow-action@0.9.1
|
||||||
|
with:
|
||||||
|
access_token: ${{ github.token }}
|
||||||
|
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2.3.5
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Node.js environment
|
||||||
|
uses: actions/setup-node@v2.4.1
|
||||||
|
with:
|
||||||
|
node-version: "14"
|
||||||
|
cache: "yarn"
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
uses: ./.github/actions/cache-deps
|
||||||
|
with:
|
||||||
|
extension: docs-remove-announcement
|
||||||
|
|
||||||
|
- name: Remove Announcement Bar
|
||||||
|
run: yarn generate:announcement --expire
|
||||||
|
|
||||||
|
- name: Create Pull Request
|
||||||
|
uses: peter-evans/create-pull-request@v4
|
||||||
|
with:
|
||||||
|
commit-message: 'chore(docs): Removed Docs Announcement Bar (automated)'
|
||||||
|
base: 'master'
|
||||||
|
title: 'chore(docs): Removed Docs Announcement Bar (automated)'
|
||||||
|
labels: 'type: chore'
|
||||||
|
add-paths: www/docs/**
|
||||||
|
branch: 'chore/remove-announcement'
|
||||||
|
branch-suffix: 'timestamp'
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
name: Docusaurus Documentation Test
|
name: Documentation Tests
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
paths:
|
paths:
|
||||||
@@ -34,3 +34,29 @@ jobs:
|
|||||||
cd www/docs
|
cd www/docs
|
||||||
yarn install
|
yarn install
|
||||||
yarn build
|
yarn build
|
||||||
|
lint:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Cancel Previous Runs
|
||||||
|
uses: styfle/cancel-workflow-action@0.9.1
|
||||||
|
with:
|
||||||
|
access_token: ${{ github.token }}
|
||||||
|
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2.3.5
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Get Directories to Scan
|
||||||
|
working-directory: docs
|
||||||
|
run: ./get-files.sh
|
||||||
|
id: directories
|
||||||
|
|
||||||
|
- name: Vale Linter
|
||||||
|
uses: errata-ai/vale-action@reviewdog
|
||||||
|
with:
|
||||||
|
files: ${{ steps.directories.outputs.LIST }}
|
||||||
|
fail_on_error: true
|
||||||
|
vale_flags: '--minAlertLevel=error'
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ github.token }}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
StylesPath = docs/styles
|
||||||
|
|
||||||
|
MinAlertLevel = suggestion
|
||||||
|
Vocab = Base
|
||||||
|
|
||||||
|
Packages = write-good
|
||||||
|
|
||||||
|
[*.{md,mdx}]
|
||||||
|
BasedOnStyles = Vale, write-good, docs
|
||||||
|
Vale.Spelling=warning
|
||||||
|
write-good.E-Prime=No
|
||||||
|
write-good.So=No
|
||||||
|
write-good.ThereIs=No
|
||||||
|
Vale.Terms=No
|
||||||
|
|
||||||
|
[formats]
|
||||||
|
mdx = md
|
||||||
@@ -56,6 +56,8 @@ All PRs should include tests for the changes that are included. We have two type
|
|||||||
- **Unit tests** found under `packages/*/src/services/__tests__` and `packages/*/src/api/routes/*/__tests__`
|
- **Unit tests** found under `packages/*/src/services/__tests__` and `packages/*/src/api/routes/*/__tests__`
|
||||||
- **Integration tests** found in `integration-tests/*/__tests__`
|
- **Integration tests** found in `integration-tests/*/__tests__`
|
||||||
|
|
||||||
|
Check out our [local development documentation](https://docs.medusajs.com/usage/local-development) to learn how to test your changes both in the Medusa repository and in a local server.
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
- We generally encourage to document your changes through comments in your code.
|
- We generally encourage to document your changes through comments in your code.
|
||||||
|
|||||||
@@ -37,19 +37,7 @@ An open-source composable commerce engine built for developers.
|
|||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
### Deploy in 5 minutes
|
You can install Medusa by either following our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start) or the following steps:
|
||||||
|
|
||||||
You can deploy your Medusa server in 5 minutes just by clicking the button below.
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://heroku.com/deploy?template=https://github.com/medusajs/medusa-starter-default/tree/feat/deploy-heroku">
|
|
||||||
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
### Install Locally
|
|
||||||
|
|
||||||
You can install Medusa locally or manually on your server by either following our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start) or the following steps:
|
|
||||||
|
|
||||||
1. **Install Medusa CLI**
|
1. **Install Medusa CLI**
|
||||||
|
|
||||||
@@ -66,6 +54,7 @@ You can install Medusa locally or manually on your server by either following ou
|
|||||||
3. **Start your Medusa engine**
|
3. **Start your Medusa engine**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
cd my-medusa-store
|
||||||
medusa develop
|
medusa develop
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ Through Medusa's flexible plugin system, it is possible to add a search engine t
|
|||||||
|
|
||||||
### Medusa Components
|
### Medusa Components
|
||||||
|
|
||||||
It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with our [quickstart guide](../quickstart/quick-start.md) to get started in minutes.
|
It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with the [quickstart guide](../quickstart/quick-start.md) to get started in minutes.
|
||||||
|
|
||||||
Furthermore, it’s highly recommended to ensure your Medusa server is configured to work with Redis. As Medusa uses Redis for the event queue internally, configuring Redis ensures that the search indices in Algolia are updated whenever products on the Medusa server are updated. You can follow [this documentation to install Redis](../tutorial/0-set-up-your-development-environment.mdx#redis) and then [configure it on your Medusa server](../usage/configurations.md#redis).
|
Furthermore, it’s highly recommended to ensure your Medusa server is configured to work with Redis. As Medusa uses Redis for the event queue internally, configuring Redis ensures that the search indices in Algolia are updated whenever products on the Medusa server are updated. You can follow [this documentation to install Redis](../tutorial/0-set-up-your-development-environment.mdx#redis) and then [configure it on your Medusa server](../usage/configurations.md#redis).
|
||||||
|
|
||||||
|
|||||||
@@ -227,13 +227,13 @@ export const query = graphql`
|
|||||||
To test this out, run your Medusa server by running this command in its directory:
|
To test this out, run your Medusa server by running this command in its directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
Then run the Gatsby storefront by running this command in its directory:
|
Then run the Gatsby storefront by running this command in its directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
This runs the Gatsby storefront on `localhost:8000`. Go to the storefront in your browser and open the About page. You should see the Rich Text content you added.
|
This runs the Gatsby storefront on `localhost:8000`. Go to the storefront in your browser and open the About page. You should see the Rich Text content you added.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Contentful
|
# Contentful
|
||||||
|
|
||||||
In this document, you’ll learn how to integrate a Medusa server with Contentful to add rich CMS functionalities
|
In this document, you’ll learn how to integrate a Medusa server with Contentful to add rich Content Management System (CMS) functionalities
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -36,7 +36,7 @@ This installs a new Medusa server in the directory `medusa-contentful`.
|
|||||||
|
|
||||||
### Add Contentful Environment Variables
|
### Add Contentful Environment Variables
|
||||||
|
|
||||||
Change to the `medusa-contentful` directory. In `.env` you’ll find 3 variables:
|
Change to the `medusa-contentful` directory. In `.env` you’ll find three variables:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
CONTENTFUL_SPACE_ID=
|
CONTENTFUL_SPACE_ID=
|
||||||
@@ -172,7 +172,7 @@ npm run seed
|
|||||||
To start the server run the following command:
|
To start the server run the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
If you seeded the database with demo data, you should see that events related to the products are triggered.
|
If you seeded the database with demo data, you should see that events related to the products are triggered.
|
||||||
@@ -257,7 +257,7 @@ You should find the field "Content Delivery API - access token”. Copy its valu
|
|||||||
Make sure the Medusa server is still running. Then, start the storefront:
|
Make sure the Medusa server is still running. Then, start the storefront:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
This starts the storefront at `localhost:8000`. Open it in your browser and you should see on the homepage the Featured Product section with the products you chose on Contentful.
|
This starts the storefront at `localhost:8000`. Open it in your browser and you should see on the homepage the Featured Product section with the products you chose on Contentful.
|
||||||
|
|||||||
@@ -10,19 +10,19 @@ By integrating Mailchimp with Medusa, customers will be able to subscribe from M
|
|||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
This plugin is only used to allow your customers to subscribe but does not actually do any email sending. If you want to send emails to customers based on specific events, for example, when an order is placed, you should check out our [SendGrid plugin](./sendgrid.mdx) instead.
|
This plugin is only used to allow your customers to subscribe but does not actually do any email sending. If you want to send emails to customers based on specific events, for example, when an order is placed, you should check out the [SendGrid plugin](./sendgrid.mdx) instead.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Before going further with this guide make sure you have a Medusa server set up. You can follow our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start).
|
Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start).
|
||||||
|
|
||||||
You also need a Mailchimp account, so please [create one](https://mailchimp.com/signup) before you start.
|
You also need a Mailchimp account, so please [create one](https://mailchimp.com/signup) before you start.
|
||||||
|
|
||||||
## Obtain Mailchimp Keys
|
## Obtain Mailchimp Keys
|
||||||
|
|
||||||
To integrate the plugin into Medusa you need 2 keys: The API Key and the Newsletter list or Audience ID. The API Key acts as a credential for your account, whereas the Newsletter list ID determines which audience should the subscribed customers be added to.
|
To integrate the plugin into Medusa you need two keys: The API Key and the Newsletter list or Audience ID. The API Key acts as a credential for your account, whereas the Newsletter list ID determines which audience should the subscribed customers be added to.
|
||||||
|
|
||||||
You can follow [this guide](https://mailchimp.com/help/about-api-keys/#Find_or_generate_your_API_key) from Mailchimp’s documentation to obtain an API Key.
|
You can follow [this guide](https://mailchimp.com/help/about-api-keys/#Find_or_generate_your_API_key) from Mailchimp’s documentation to obtain an API Key.
|
||||||
|
|
||||||
@@ -179,5 +179,5 @@ If you try entering an email and clicking Subscribe, the email will be subscribe
|
|||||||
|
|
||||||
## What’s Next 🚀
|
## What’s Next 🚀
|
||||||
|
|
||||||
- Check out SendGrid plugin for more Email functionalities.
|
- Check out [SendGrid plugin](../add-plugins/sendgrid.mdx) for more Email functionalities.
|
||||||
- [Learn more about plugins.](../advanced/backend/plugins/overview.md)
|
- [Learn more about plugins.](../advanced/backend/plugins/overview.md)
|
||||||
@@ -14,7 +14,7 @@ Through Medusa's flexible plugin system, it is possible to add a search engine t
|
|||||||
|
|
||||||
### Medusa Components
|
### Medusa Components
|
||||||
|
|
||||||
It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with our [quickstart guide](../quickstart/quick-start.md) to get started in minutes.
|
It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with the [quickstart guide](../quickstart/quick-start.md) to get started in minutes.
|
||||||
|
|
||||||
Furthermore, it’s highly recommended to ensure your Medusa server is configured to work with Redis. As Medusa uses Redis for the event queue internally, configuring Redis ensures that the search indices in MeiliSearch are updated whenever products on the Medusa server are updated. You can follow [this documentation to install Redis](../tutorial/0-set-up-your-development-environment.mdx#redis) and then [configure it on your Medusa server](../usage/configurations.md#redis).
|
Furthermore, it’s highly recommended to ensure your Medusa server is configured to work with Redis. As Medusa uses Redis for the event queue internally, configuring Redis ensures that the search indices in MeiliSearch are updated whenever products on the Medusa server are updated. You can follow [this documentation to install Redis](../tutorial/0-set-up-your-development-environment.mdx#redis) and then [configure it on your Medusa server](../usage/configurations.md#redis).
|
||||||
|
|
||||||
|
|||||||
@@ -117,27 +117,29 @@ Run your Medusa server alongside the [Medusa Admin](../admin/quickstart.md) to t
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Additional Configuration for Exports
|
## Private Buckets
|
||||||
|
|
||||||
Medusa v1.3.3 introduced the Export API. For example, you can now export your products from the Medusa Admin on the Products page.
|
### Handle Exports
|
||||||
|
|
||||||

|
Medusa provides export functionalities including exporting products and orders. For exports to work, you must [set up a private bucket](#create-private-bucket).
|
||||||
|
|
||||||
:::note
|
### Handle Imports
|
||||||
|
|
||||||
Exports require using Redis to handle the event queue, and using PostgreSQL for the database. If you don’t use Redis or PostgreSQL, you can follow [this documentation to install](../tutorial/0-set-up-your-development-environment.mdx#postgresql) and then [configure them on your Medusa server](../usage/configurations.md#postgresql-configurations).
|
Medusa provides import functionalities including importing products. For imports to work, you must [set the private bucket](#add-private-bucket-environment-variable) to be the same as the public bucket.
|
||||||
|
|
||||||
:::
|
### Create Private Bucket
|
||||||
|
|
||||||
When using MinIO, you must create a private bucket that will store these product exports. To do that, follow along the [steps mentioned earlier to create a bucket](#create-a-minio-bucket), but keep Access Policy set to private.
|
To create a private bucket, follow along the [steps mentioned earlier](#create-a-minio-bucket), but keep Access Policy set to private.
|
||||||
|
|
||||||
Then, add the following environment variable on your Medusa server:
|
### Add Private Bucket Environment Variable
|
||||||
|
|
||||||
|
Add the following environment variable on your Medusa server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
MINIO_PRIVATE_BUCKET=exports
|
MINIO_PRIVATE_BUCKET=exports
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, add a new option to the plugin’s options in `medusa-config.js`:
|
Then, add a new option to the plugin’s options in `medusa-config.js`:
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
{
|
{
|
||||||
@@ -149,16 +151,6 @@ Finally, add a new option to the plugin’s options in `medusa-config.js`:
|
|||||||
},
|
},
|
||||||
```
|
```
|
||||||
|
|
||||||
If you start your Medusa server now and click on Export Products on the Medusa admin, the export will run in the background. When ready, it should be available for download.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
If you face any errors, make sure you have the latest version of the plugin installed.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Use Different Secret and Access Keys
|
### Use Different Secret and Access Keys
|
||||||
|
|
||||||
If you only add the `private_bucket` option, the same secret and access keys that you used for the public bucket will be used to access the private bucket.
|
If you only add the `private_bucket` option, the same secret and access keys that you used for the public bucket will be used to access the private bucket.
|
||||||
|
|||||||
@@ -18,9 +18,9 @@ In addition, you need to configure a webhook listener on your PayPal Developer D
|
|||||||
|
|
||||||
Webhooks are used in scenarios where the customer might leave the page during the authorization and before the checkout flow is fully complete. It will then create the order or swap after the payment is authorized if they weren’t created
|
Webhooks are used in scenarios where the customer might leave the page during the authorization and before the checkout flow is fully complete. It will then create the order or swap after the payment is authorized if they weren’t created
|
||||||
|
|
||||||
Additionally, you need a Medusa server installed and set up. If not, you can follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to get started.
|
Additionally, you need a Medusa server installed and set up. If not, you can follow the [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to get started.
|
||||||
|
|
||||||
You also need [Medusa Admin](../admin/quickstart.md) installed to enable PayPal as a payment provider. You can alternatively use our [REST APIs](https://docs.medusajs.com/api/admin).
|
You also need [Medusa Admin](../admin/quickstart.md) installed to enable PayPal as a payment provider. You can alternatively use the [REST APIs](https://docs.medusajs.com/api/admin).
|
||||||
|
|
||||||
## Medusa Server
|
## Medusa Server
|
||||||
|
|
||||||
@@ -80,17 +80,7 @@ If you don’t have a Medusa admin installed, make sure to follow along with [th
|
|||||||
|
|
||||||
### Add PayPal to Regions
|
### Add PayPal to Regions
|
||||||
|
|
||||||
Run your Medusa server and Medusa admin, then open the Medusa admin and login.
|
You can refer to [this documentation in the user guide](../user-guide/regions/providers.mdx#manage-payment-providers) to learn how to add a payment provider like PayPal to a region.
|
||||||
|
|
||||||
Choose Settings from the Sidebar. Then, choose Regions.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Then, choose the regions you want to add PayPal as a payment provider. In the right-side settings, scroll down to “Payment Providers” and choose “paypal”.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Once you’re done, click Save. PayPal is now a payment provider in your store in the regions you added it to.
|
|
||||||
|
|
||||||
## Storefront Setup
|
## Storefront Setup
|
||||||
|
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ The Create Bucket form will open. In the General Configuration section enter a n
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Next, in the Object Ownership section, choose ACLs enabled. Then, 2 radio buttons will show below it. Choose Bucket owner preferred.
|
Next, in the Object Ownership section, choose ACLs enabled. Then, two radio buttons will show below it. Choose Bucket owner preferred.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
@@ -119,7 +119,7 @@ const plugins = [
|
|||||||
Run your server with the following command:
|
Run your server with the following command:
|
||||||
|
|
||||||
```bash npm2yarn
|
```bash npm2yarn
|
||||||
npm start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, try triggering one of the [mentioned events earlier in this document](#events-that-the-segment-plugin-tracks). For example, you can place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
|
Then, try triggering one of the [mentioned events earlier in this document](#events-that-the-segment-plugin-tracks). For example, you can place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ By integrating SendGrid with Medusa, you’ll be sending email notifications to
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Before going further with this guide make sure you have a Medusa server set up. You can follow our [Quickstart guide](../quickstart/quick-start.md).
|
Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](../quickstart/quick-start.md).
|
||||||
|
|
||||||
You also must have [Redis configured on your Medusa server](/tutorial/set-up-your-development-environment#redis). Sending emails is done through Subscribers, which uses Redis as the event queue. If you don’t set up Redis, the plugin will not send emails.
|
You also must have [Redis configured on your Medusa server](/tutorial/set-up-your-development-environment#redis). Sending emails is done through Subscribers, which uses Redis as the event queue. If you don’t set up Redis, the plugin will not send emails.
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ If you choose to give the API Key restricted access, make sure to at least give
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
Once you create the API key, the key will be shown for one time only. So, make sure to copy and save it somewhere for later usage.
|
Once you create the API key, the key will be shown for one time only. Make sure to copy and save it somewhere for later usage.
|
||||||
|
|
||||||
### Email Templates
|
### Email Templates
|
||||||
|
|
||||||
@@ -3953,7 +3953,7 @@ To test it out, perform an action that would trigger one of the emails being sen
|
|||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
If you don’t have a storefront installed, check out our [Gatsby](../starters/gatsby-medusa-starter.md) or [Next.js](../starters/nextjs-medusa-starter.md) starters to create a storefront in minutes.
|
If you don’t have a storefront installed, check out the [Gatsby](../starters/gatsby-medusa-starter.md) or [Next.js](../starters/nextjs-medusa-starter.md) starters to create a storefront in minutes.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Strapi
|
# Strapi
|
||||||
|
|
||||||
In this document, you’ll learn how to integrate Strapi with Medusa to add rich CMS functionalities.
|
In this document, you’ll learn how to integrate Strapi with Medusa to add rich Content Management System (CMS) functionalities.
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ Try updating any products on Strapi by going to Content Manager → Products and
|
|||||||
|
|
||||||
### Update Products on Medusa
|
### Update Products on Medusa
|
||||||
|
|
||||||
If you try to update products on Medusa either using the [REST APIs](https://docs.medusajs.com/api/admin/#tag/Product/operation/PostProductsProduct) or using [the Medusa Admin](../user-guide/products/manage.md), you’ll see that the product is also updated on Strapi.
|
If you try to update products on Medusa either using the [REST APIs](https://docs.medusajs.com/api/admin/#tag/Product/operation/PostProductsProduct) or using [the Medusa Admin](../user-guide/products/manage.mdx), you’ll see that the product is also updated on Strapi.
|
||||||
|
|
||||||
## What’s Next 🚀
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ This document guides you through setting up Stripe payments in your Medusa serve
|
|||||||
|
|
||||||
## Video Guide
|
## Video Guide
|
||||||
|
|
||||||
You can also follow our video guide to learn how the setup works:
|
You can also follow this video guide to learn how the setup works:
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<video width="100%" height="100%" playsinline autoplay muted controls>
|
<video width="100%" height="100%" playsinline autoplay muted controls>
|
||||||
@@ -26,7 +26,7 @@ Before you proceed with this guide, make sure you create a [Stripe account](http
|
|||||||
|
|
||||||
This section guides you over the steps necessary to add Stripe as a payment provider to your Medusa server.
|
This section guides you over the steps necessary to add Stripe as a payment provider to your Medusa server.
|
||||||
|
|
||||||
If you don’t have a Medusa server installed yet, you must follow our [quickstart guide](../quickstart/quick-start) first.
|
If you don’t have a Medusa server installed yet, you must follow the [quickstart guide](../quickstart/quick-start) first.
|
||||||
|
|
||||||
### Install the Stripe Plugin
|
### Install the Stripe Plugin
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ You might find that this code is already available but commented out. You can pr
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
The Stripe plugin uses 2 configuration options. The `api_key` is essential to both your development and production environments. As for the `webhook_secret`, it’s essential for your production environment. So, if you’re only using Stripe for development you can skip adding the value for this option at the moment.
|
The Stripe plugin uses two configuration options. The `api_key` is essential to both your development and production environments. As for the `webhook_secret`, it’s essential for your production environment. So, if you’re only using Stripe for development you can skip adding the value for this option at the moment.
|
||||||
|
|
||||||
### Retrieve Stripe's Keys
|
### Retrieve Stripe's Keys
|
||||||
|
|
||||||
@@ -107,17 +107,7 @@ If you don’t have a Medusa admin installed, make sure to follow along with [th
|
|||||||
|
|
||||||
### Add Stripe to Regions
|
### Add Stripe to Regions
|
||||||
|
|
||||||
First, make sure that both your Medusa server and Medusa Admin are running.
|
You can refer to [this documentation in the user guide](../user-guide/regions/providers.mdx#manage-payment-providers) to learn how to add a payment provider like Stripe to a region.
|
||||||
|
|
||||||
Then, in your Medusa Admin, log in and choose Settings from the Sidebar. Then, choose Regions.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Then, choose the regions you want to add Stripe as a payment provider. In the right-side settings, scroll down to “Payment Providers” and choose Stripe.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
Once you’re done, click Save. Stripe is now a payment provider in your store in the regions you selected.
|
|
||||||
|
|
||||||
## Storefront Setup
|
## Storefront Setup
|
||||||
|
|
||||||
|
|||||||
@@ -16,13 +16,13 @@ This plugin only gives you access to the Twilio SMS API but does not implement s
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Before going further with this guide make sure you have a Medusa server set up. You can follow our [Quickstart guide](../quickstart/quick-start.md) if you don’t.
|
Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](../quickstart/quick-start.md) if you don’t.
|
||||||
|
|
||||||
You also must have a [Twilio account created](https://www.twilio.com/sms) so if you don’t already please go ahead and create one.
|
You also must have a [Twilio account created](https://www.twilio.com/sms) so if you don’t already please go ahead and create one.
|
||||||
|
|
||||||
## Retrieve Credentials
|
## Retrieve Credentials
|
||||||
|
|
||||||
For the [Twilio SMS plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-twilio-sms), you need three credentials from your Twilio account: Account SID, Auth Token, and a Twilio phone number to send from. You can find these 3 from your [Twilio Console’s homepage](https://console.twilio.com).
|
For the [Twilio SMS plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-twilio-sms), you need three credentials from your Twilio account: Account SID, Auth Token, and a Twilio phone number to send from. You can find these three from your [Twilio Console’s homepage](https://console.twilio.com).
|
||||||
|
|
||||||
## Install Plugin
|
## Install Plugin
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ If you create an order now on your storefront, you should receive a message from
|
|||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
If you don’t have a storefront set up yet, you can install one of our [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
|
If you don’t have a storefront set up yet, you can install one of the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ The default port is set in `package.json` in the `develop` script:
|
|||||||
|
|
||||||
If you wish to change the port you can simply change the `7000` to your desired port.
|
If you wish to change the port you can simply change the `7000` to your desired port.
|
||||||
|
|
||||||
However, if you change your Medusa admin port, you need to change it in your Medusa server. The Medusa server has the Medusa admin and store URLs set in the configurations to avoid CORS issues.
|
However, if you change your Medusa admin port, you need to change it in your Medusa server. The Medusa server has the Medusa admin and store URLs set in the configurations to avoid Cross-Origin Resource Sharing (CORS) issues.
|
||||||
|
|
||||||
To change the URL of the Medusa admin in the server, add a new environment variable `ADMIN_CORS` or modify it if you already have it to your Admin URL:
|
To change the URL of the Medusa admin in the server, add a new environment variable `ADMIN_CORS` or modify it if you already have it to your Admin URL:
|
||||||
|
|
||||||
|
|||||||
@@ -58,7 +58,6 @@ You can do that by sending the following request to the [Upload Files](https://d
|
|||||||
<TabItem value="client" label="Medusa JS Client" default>
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using JS Client
|
|
||||||
medusa.admin.uploads.create(file) //file is an instance of File
|
medusa.admin.uploads.create(file) //file is an instance of File
|
||||||
.then(({ uploads }) => {
|
.then(({ uploads }) => {
|
||||||
const key = uploads[0].key;
|
const key = uploads[0].key;
|
||||||
@@ -69,7 +68,6 @@ medusa.admin.uploads.create(file) //file is an instance of File
|
|||||||
<TabItem value="fetch" label="Fetch API">
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using Fetch API
|
|
||||||
const formData = new FormData();
|
const formData = new FormData();
|
||||||
formData.append('files', file); //file is an instance of File
|
formData.append('files', file); //file is an instance of File
|
||||||
|
|
||||||
@@ -90,7 +88,6 @@ fetch(`<YOUR_SERVER>/admin/uploads`, {
|
|||||||
<TabItem value="curl" label="cURL">
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# using cURL
|
|
||||||
curl --location --request POST '<YOUR_SERVER>/admin/uploads' \
|
curl --location --request POST '<YOUR_SERVER>/admin/uploads' \
|
||||||
--header 'Authorization: Bearer {api_token}' \
|
--header 'Authorization: Bearer {api_token}' \
|
||||||
--header 'Content-Type: text/csv' \
|
--header 'Content-Type: text/csv' \
|
||||||
@@ -112,7 +109,6 @@ You can do that by sending the following request to the [Create a Batch Job](htt
|
|||||||
<TabItem value="client" label="Medusa JS Client" default>
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using JS Client
|
|
||||||
medusa.admin.batchJobs.create({
|
medusa.admin.batchJobs.create({
|
||||||
type: 'product-import',
|
type: 'product-import',
|
||||||
context: {
|
context: {
|
||||||
@@ -129,7 +125,6 @@ medusa.admin.batchJobs.create({
|
|||||||
<TabItem value="fetch" label="Fetch API">
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using Fetch API
|
|
||||||
fetch(`<YOUR_SERVER>/admin/batch-jobs`, {
|
fetch(`<YOUR_SERVER>/admin/batch-jobs`, {
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
headers: {
|
headers: {
|
||||||
@@ -153,7 +148,6 @@ fetch(`<YOUR_SERVER>/admin/batch-jobs`, {
|
|||||||
<TabItem value="curl" label="cURL">
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# using cURL
|
|
||||||
curl --location --request POST '<YOUR_SERVER>/admin/batch-jobs' \
|
curl --location --request POST '<YOUR_SERVER>/admin/batch-jobs' \
|
||||||
--header 'Authorization: Bearer {api_token}' \
|
--header 'Authorization: Bearer {api_token}' \
|
||||||
--header 'Content-Type: application/json' \
|
--header 'Content-Type: application/json' \
|
||||||
@@ -194,7 +188,6 @@ You can retrieve all the details of the batch job, including its status and the
|
|||||||
<TabItem value="client" label="Medusa JS Client" default>
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using JS Client
|
|
||||||
medusa.admin.batchJobs.retrieve(batchJobId)
|
medusa.admin.batchJobs.retrieve(batchJobId)
|
||||||
.then(( batch_job ) => {
|
.then(( batch_job ) => {
|
||||||
console.log(batch_job.status, batch_job.result);
|
console.log(batch_job.status, batch_job.result);
|
||||||
@@ -205,7 +198,6 @@ medusa.admin.batchJobs.retrieve(batchJobId)
|
|||||||
<TabItem value="fetch" label="Fetch API">
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using Fetch API
|
|
||||||
fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}`)
|
fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}`)
|
||||||
.then((response) => response.json())
|
.then((response) => response.json())
|
||||||
.then(({ batch_job }) => {
|
.then(({ batch_job }) => {
|
||||||
@@ -217,7 +209,6 @@ fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}`)
|
|||||||
<TabItem value="curl" label="cURL">
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# using cURL
|
|
||||||
curl --location --request GET '<YOUR_SERVER>/admin/batch-jobs/<BATCH_JOB_ID>' \
|
curl --location --request GET '<YOUR_SERVER>/admin/batch-jobs/<BATCH_JOB_ID>' \
|
||||||
--header 'Authorization: Bearer {api_token}'
|
--header 'Authorization: Bearer {api_token}'
|
||||||
# <BATCH_JOB_ID> is the ID of the batch job
|
# <BATCH_JOB_ID> is the ID of the batch job
|
||||||
@@ -256,7 +247,6 @@ To confirm a batch job send the following request:
|
|||||||
<TabItem value="client" label="Medusa JS Client" default>
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using JS Client
|
|
||||||
medusa.admin.batchJobs.confirm(batchJobId)
|
medusa.admin.batchJobs.confirm(batchJobId)
|
||||||
.then(( batch_job ) => {
|
.then(( batch_job ) => {
|
||||||
console.log(batch_job.status);
|
console.log(batch_job.status);
|
||||||
@@ -267,7 +257,6 @@ medusa.admin.batchJobs.confirm(batchJobId)
|
|||||||
<TabItem value="fetch" label="Fetch API">
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
// using Fetch API
|
|
||||||
fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}/confirm`, {
|
fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}/confirm`, {
|
||||||
method: 'POST'
|
method: 'POST'
|
||||||
})
|
})
|
||||||
@@ -281,7 +270,6 @@ fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}/confirm`, {
|
|||||||
<TabItem value="curl" label="cURL">
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# using cURL
|
|
||||||
curl --location --request POST '<YOUR_SERVER>/admin/batch-jobs/<BATCH_JOB_ID>/confirm' \
|
curl --location --request POST '<YOUR_SERVER>/admin/batch-jobs/<BATCH_JOB_ID>/confirm' \
|
||||||
--header 'Authorization: Bearer {api_token}'
|
--header 'Authorization: Bearer {api_token}'
|
||||||
# <BATCH_JOB_ID> is the ID of the batch job
|
# <BATCH_JOB_ID> is the ID of the batch job
|
||||||
|
|||||||
@@ -0,0 +1,382 @@
|
|||||||
|
# Create a Batch Job Strategy
|
||||||
|
|
||||||
|
In this document, you’ll learn how to create a batch job strategy on your Medusa server.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
If you’re interested to learn more about what Batch Jobs are and how they work, check out [this documentation](./index.md).
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Batch jobs can be used to perform long tasks in the background of your Medusa server. Batch jobs are handled by batch job strategies. An example of a batch job strategy is the Import Products functionality.
|
||||||
|
|
||||||
|
This documentation helps you learn how to create a batch job strategy. The batch job strategy used in this example changes the status of all draft products to `published`.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
### Medusa Components
|
||||||
|
|
||||||
|
It is assumed that you already have a Medusa server installed and set up. If not, you can follow our [quickstart guide](../../../quickstart/quick-start.md) to get started.
|
||||||
|
|
||||||
|
### Redis
|
||||||
|
|
||||||
|
Redis is required for batch jobs to work. Make sure you [install Redis](../../../tutorial/0-set-up-your-development-environment.mdx#redis) and [configure it with your Medusa server](../../../usage/configurations.md#redis).
|
||||||
|
|
||||||
|
### PostgreSQL
|
||||||
|
|
||||||
|
If you use SQLite during your development, it’s highly recommended that you use PostgreSQL when working with batch jobs. Learn how to [install PostgreSQL](../../../tutorial/0-set-up-your-development-environment.mdx#postgresql) and [configure it with your Medusa server](../../../usage/configurations.md#postgresql-configurations).
|
||||||
|
|
||||||
|
## 1. Create a File
|
||||||
|
|
||||||
|
A batch job strategy is essentially a class defined in a TypeScript or JavaScript file. You should create this file in `src/strategies`.
|
||||||
|
|
||||||
|
Following the example used in this documentation, create the file `src/strategies/publish.ts`.
|
||||||
|
|
||||||
|
## 2. Create Class
|
||||||
|
|
||||||
|
Batch job strategies must extend the abstract class `AbstractBatchJobStrategy` and implement its abstract methods.
|
||||||
|
|
||||||
|
Add the following content to the file you created:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
import { AbstractBatchJobStrategy, BatchJobService } from '@medusajs/medusa'
|
||||||
|
import { EntityManager } from 'typeorm'
|
||||||
|
|
||||||
|
class PublishStrategy extends AbstractBatchJobStrategy {
|
||||||
|
protected batchJobService_: BatchJobService
|
||||||
|
processJob(batchJobId: string): Promise<void> {
|
||||||
|
throw new Error('Method not implemented.')
|
||||||
|
}
|
||||||
|
buildTemplate(): Promise<string> {
|
||||||
|
throw new Error('Method not implemented.')
|
||||||
|
}
|
||||||
|
protected manager_: EntityManager
|
||||||
|
protected transactionManager_: EntityManager
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
export default PublishStrategy
|
||||||
|
```
|
||||||
|
|
||||||
|
## 3. Define Required Properties
|
||||||
|
|
||||||
|
A batch job strategy class must have two static properties: the `identifier` and `batchType` properties. The `identifier` must be a unique string associated with your batch job strategy, and `batchType` must be the batch job's type.
|
||||||
|
|
||||||
|
You will use the `batchType` later when you [interact with the Batch Job APIs](#test-your-batch-job-strategy).
|
||||||
|
|
||||||
|
Following the same example, add the following properties to the `PublishStrategy` class:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
class PublishStrategy extends AbstractBatchJobStrategy {
|
||||||
|
static identifier = 'publish-products-strategy'
|
||||||
|
static batchType = 'publish-products'
|
||||||
|
|
||||||
|
//...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 4. Define Methods
|
||||||
|
|
||||||
|
### (Optional) prepareBatchJobForProcessing
|
||||||
|
|
||||||
|
Medusa runs this method before it creates the batch job to prepare the content of the batch job record in the database. It accepts two parameters: the batch job data sent in the body of the [Create Batch Job request](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs), and the request instance.
|
||||||
|
|
||||||
|
Implementing this method is optional. For example:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
async prepareBatchJobForProcessing(batchJob: CreateBatchJobInput, req: Express.Request): Promise<CreateBatchJobInput> {
|
||||||
|
//make changes to the batch job's fields...
|
||||||
|
return batchJob
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### (Optional) preProcessBatchJob
|
||||||
|
|
||||||
|
Medusa runs this method after it creates the batch job, but before it is confirmed and processed. You can use this method to perform any necessary action before the batch job is processed. You can also use this method to add information related to the expected result.
|
||||||
|
|
||||||
|
For example, this implementation of the `preProcessBatchJob` method calculates how many draft products it will published and adds it to the `result` attribute of the batch job:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
async preProcessBatchJob(batchJobId: string): Promise<void> {
|
||||||
|
return await this.atomicPhase_(async (transactionManager) => {
|
||||||
|
const batchJob = (await this.batchJobService_
|
||||||
|
.withTransaction(transactionManager)
|
||||||
|
.retrieve(batchJobId))
|
||||||
|
|
||||||
|
const count = await this.productService_
|
||||||
|
.withTransaction(transactionManager)
|
||||||
|
.count({
|
||||||
|
status: ProductStatus.DRAFT
|
||||||
|
});
|
||||||
|
|
||||||
|
await this.batchJobService_
|
||||||
|
.withTransaction(transactionManager)
|
||||||
|
.update(batchJob, {
|
||||||
|
result: {
|
||||||
|
advancement_count: 0,
|
||||||
|
count,
|
||||||
|
stat_descriptors: [
|
||||||
|
{
|
||||||
|
key: 'product-publish-count',
|
||||||
|
name: 'Number of products to publish',
|
||||||
|
message: `${count} product(s) will be published.`
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `result` attribute is an object that can hold many properties including:
|
||||||
|
|
||||||
|
- `count`: used to indicate how many items (in this case, products) that the task will run on.
|
||||||
|
- `advancement_count`: used to indicate the current number of items processed at a given moment. Since the batch job isn't processed yet, you set it to zero.
|
||||||
|
- `stat_descriptors`: can be used to show human-readable messages.
|
||||||
|
|
||||||
|
### processJob
|
||||||
|
|
||||||
|
Medusa runs this method to process the batch job once it is confirmed.
|
||||||
|
|
||||||
|
For example, this implementation of the `processJob` method retrieves all draft products and changes their status to published:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
async processJob(batchJobId: string): Promise<void> {
|
||||||
|
return await this.atomicPhase_(
|
||||||
|
async (transactionManager) => {
|
||||||
|
const productServiceTx = this.productService_
|
||||||
|
.withTransaction(transactionManager)
|
||||||
|
|
||||||
|
const productList = await productServiceTx
|
||||||
|
.list({
|
||||||
|
status: [ProductStatus.DRAFT]
|
||||||
|
})
|
||||||
|
|
||||||
|
productList.forEach(async (product: Product) => {
|
||||||
|
await productServiceTx
|
||||||
|
.update(product.id, {
|
||||||
|
status: ProductStatus.PUBLISHED
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
await this.batchJobService_
|
||||||
|
.withTransaction(transactionManager)
|
||||||
|
.update(batchJobId, {
|
||||||
|
result: {
|
||||||
|
advancement_count: productList.length
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
When a batch job is canceled, the processing of the batch job doesn’t automatically stop. You will have to manually check for changes in the status of the batch job. For example, you can retrieve the batch job and use the condition `batchJob.status === BatchJobStatus.CANCELED` to check if the batch job was canceled.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
### buildTemplate
|
||||||
|
|
||||||
|
This method can be used in cases where you provide a template file to download, such as when implementing an import or export functionality.
|
||||||
|
|
||||||
|
If not necessary to your use case, you can simply return an empty string:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
async buildTemplate(): Promise<string> {
|
||||||
|
return ''
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### (Optional) shouldRetryOnProcessingError
|
||||||
|
|
||||||
|
Medusa uses this method to decide whether it should retry the batch job if an error occurs during processing.
|
||||||
|
|
||||||
|
By default, the `AbstractBatchJobStrategy` class implements this method and returns `false`, indicating that if a batch job’s process fails it will not be retried.
|
||||||
|
|
||||||
|
If you would like to change that behavior, you can override this method to return a different value:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
protected async shouldRetryOnProcessingError(batchJob: BatchJob, err: unknown): Promise<boolean> {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### (Optional) handleProcessingError
|
||||||
|
|
||||||
|
Medusa uses this method to handle errors that occur during processing. By default, it changes the status of the batch job to `failed` and sets the `errors` property of the batch job’s `result` attribute.
|
||||||
|
|
||||||
|
You can use this method as implemented in `AbstractBatchJobStrategy` at any point in your batch job process to set the batch job as failed.
|
||||||
|
|
||||||
|
You can also override this method in your batch job strategy and change how it works:
|
||||||
|
|
||||||
|
```tsx
|
||||||
|
protected async handleProcessingError<T>(batchJobId: string, err: unknown, result: T): Promise<void> {
|
||||||
|
//different implementation...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 5. Run Build Command
|
||||||
|
|
||||||
|
After you create the batch job and before testing it out, you must run the build command in the directory of your Medusa server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Test your Batch Job Strategy
|
||||||
|
|
||||||
|
This section covers how to test and use your batch job strategy. Make sure to start your server first:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
If your `start` script uses the `medusa develop` command, whenever you make changes in the `src` directory the `build` command will automatically run and the server will restart.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
You must also use an authenticated user to send batch job requests. You can refer to the [authentication guide in the API reference](https://docs.medusajs.com/api/admin/#section/Authentication) for more details.
|
||||||
|
|
||||||
|
If you follow along with the JS Client code snippets, make sure to [install and set it up first](../../../js-client/overview.md).
|
||||||
|
|
||||||
|
### Create Batch Job
|
||||||
|
|
||||||
|
The first step is to create a batch job using the [Create Batch Job endpoint](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs). In the body of the request, you must set the `type` to the value of `batchType` in the batch job strategy you created.
|
||||||
|
|
||||||
|
For example, this creates a batch job of the type `publish-products`:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// using JS Client
|
||||||
|
medusa.admin.batchJobs.create({
|
||||||
|
type: 'publish-products',
|
||||||
|
context: { },
|
||||||
|
dry_run: true
|
||||||
|
})
|
||||||
|
.then(( batch_job ) => {
|
||||||
|
console.log(batch_job.status);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// using Fetch API
|
||||||
|
fetch(`<YOUR_SERVER>/admin/batch-jobs`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
type: 'publish-products',
|
||||||
|
context: { },
|
||||||
|
dry_run: true
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ batch_job }) => {
|
||||||
|
console.log(batch_job.status);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# using cURL
|
||||||
|
curl --location --request POST '<YOUR_SERVER>/admin/batch-jobs' \
|
||||||
|
--header 'Authorization: Bearer {api_token}' \
|
||||||
|
--header 'Content-Type: application/json' \
|
||||||
|
--data-raw '{
|
||||||
|
"type": "publish-products",
|
||||||
|
"context": { },
|
||||||
|
"dry_run": true
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
You set the `dry_run` to `true` to disable automatic confirmation and running of the batch job. If you want the batch job to run automatically, you can remove this body parameter.
|
||||||
|
|
||||||
|
Make sure to replace `<YOUR_SERVER>` with the server URL where applicable.
|
||||||
|
|
||||||
|
### (Optional) Retrieve Batch Job
|
||||||
|
|
||||||
|
You can retrieve the batch job afterward to get its status and view details about the process in the `result` property:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// using JS Client
|
||||||
|
medusa.admin.batchJobs.retrieve(batchJobId)
|
||||||
|
.then(( batch_job ) => {
|
||||||
|
console.log(batch_job.status, batch_job.result);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// using Fetch API
|
||||||
|
fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}`)
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ batch_job }) => {
|
||||||
|
console.log(batch_job.status, batch_job.result);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# using cURL
|
||||||
|
curl --location --request GET '<YOUR_SERVER>/admin/batch-jobs/<BATCH_JOB_ID>' \
|
||||||
|
--header 'Authorization: Bearer {api_token}'
|
||||||
|
# <BATCH_JOB_ID> is the ID of the batch job
|
||||||
|
```
|
||||||
|
|
||||||
|
Based on the batch job strategy implemented in this documentation, the `result` property could be something like this:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
"result": {
|
||||||
|
"count": 1,
|
||||||
|
"stat_descriptors": [
|
||||||
|
{
|
||||||
|
"key": "product-publish-count",
|
||||||
|
"name": "Number of products to publish",
|
||||||
|
"message": "1 product(s) will be published."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"advancement_count": 0
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
|
### Confirm Batch Job
|
||||||
|
|
||||||
|
To process the batch job, send a request to [confirm the batch job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobsBatchJobConfirmProcessing):
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// using JS Client
|
||||||
|
medusa.admin.batchJobs.confirm(batchJobId)
|
||||||
|
.then(( batch_job ) => {
|
||||||
|
console.log(batch_job.status);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// using Fetch API
|
||||||
|
fetch(`<YOUR_SERVER>/admin/batch-jobs/${batchJobId}/confirm`, {
|
||||||
|
method: 'POST'
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ batch_job }) => {
|
||||||
|
console.log(batch_job.status);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# using cURL
|
||||||
|
curl --location --request POST '<YOUR_SERVER>/admin/batch-jobs/<BATCH_JOB_ID>/confirm' \
|
||||||
|
--header 'Authorization: Bearer {api_token}'
|
||||||
|
# <BATCH_JOB_ID> is the ID of the batch job
|
||||||
|
```
|
||||||
|
|
||||||
|
The batch job will start processing afterward. Based on the batch job strategy implemented in this documentation, draft products will be published.
|
||||||
|
|
||||||
|
You can [retrieve the batch job](#optional-retrieve-batch-job) at any given point to check its status.
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn more about [batch jobs](./index.md).
|
||||||
|
- Learn how to [import products using the Admin API](../../admin/import-products.mdx).
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
# Customize Import Strategy
|
||||||
|
|
||||||
|
In this document, you’ll learn how to create a custom product import strategy either by overwriting the default strategy or creating your own.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Product Import Strategy is essentially a batch job strategy. Medusa provides the necessary mechanisms to overwrite or create your own strategy.
|
||||||
|
|
||||||
|
Although this documentation specifically targets import strategies, you can use the same steps to overwrite any batch job strategy in Medusa, including export strategies.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
### Medusa Components
|
||||||
|
|
||||||
|
It's assumed that you already have a Medusa server installed and set up. If not, you can follow our [quickstart guide](../../../quickstart/quick-start.md) to get started.
|
||||||
|
|
||||||
|
### Redis
|
||||||
|
|
||||||
|
Redis is required for batch jobs to work. Make sure you [install Redis](../../../tutorial/0-set-up-your-development-environment.mdx#redis) and [configure it with your Medusa server](../../../usage/configurations.md#redis).
|
||||||
|
|
||||||
|
### PostgreSQL
|
||||||
|
|
||||||
|
If you use SQLite during your development, it’s highly recommended that you use PostgreSQL when working with batch jobs. Learn how to [install PostgreSQL](../../../tutorial/0-set-up-your-development-environment.mdx#postgresql) and [configure it with your Medusa server](../../../usage/configurations.md#postgresql-configurations).
|
||||||
|
|
||||||
|
## Overwrite Batch Job Strategy
|
||||||
|
|
||||||
|
The steps required for overwriting a batch job strategy are essentially the same steps required to create a batch job strategy with a minor difference. For that reason, this documentation does not cover the basics of a batch job strategy.
|
||||||
|
|
||||||
|
If you’re interested to learn more about batch job strategies and how they work, please check out the [Create Batch Job Strategy documentation](./create.md).
|
||||||
|
|
||||||
|
### 1. Create a File
|
||||||
|
|
||||||
|
You must store batch job strategies in the `src/strategies` directory of your Medusa server. They are either TypeScript or JavaScript files.
|
||||||
|
|
||||||
|
So, for example, you can create the file `src/strategies/import.ts`.
|
||||||
|
|
||||||
|
### 2. Create a Class
|
||||||
|
|
||||||
|
The batch job strategy class must extend the `AbstractBatchJobStrategy` class which you can import from Medusa’s core repository.
|
||||||
|
|
||||||
|
For example, you can define the following class in the file you created:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AbstractBatchJobStrategy, BatchJobService } from '@medusajs/medusa'
|
||||||
|
import { EntityManager } from 'typeorm'
|
||||||
|
|
||||||
|
class MyImportStrategy extends AbstractBatchJobStrategy {
|
||||||
|
protected batchJobService_: BatchJobService
|
||||||
|
protected manager_: EntityManager
|
||||||
|
protected transactionManager_: EntityManager
|
||||||
|
|
||||||
|
processJob(batchJobId: string): Promise<void> {
|
||||||
|
throw new Error('Method not implemented.')
|
||||||
|
}
|
||||||
|
buildTemplate(): Promise<string> {
|
||||||
|
throw new Error('Method not implemented.')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default MyImportStrategy
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
This is the base implementation of a batch job strategy. You can learn about all the different methods and properties in [this documentation](./create.md#3-define-required-properties).
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
### 3. Set the batchType Property
|
||||||
|
|
||||||
|
Every batch job strategy class must have the static property `batchType` defined. It determines the type of batch job this strategy handles.
|
||||||
|
|
||||||
|
Since only one batch job strategy can handle a batch job type, you can overwrite Medusa’s default batch job strategies by using the same `batchType` value in your custom strategy.
|
||||||
|
|
||||||
|
So, for example, to overwrite the product import strategy set the `batchType` property in your strategy to `product-import`:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
class MyImportStrategy extends AbstractBatchJobStrategy {
|
||||||
|
static batchType = 'product-import'
|
||||||
|
//...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Define your Custom Functionality
|
||||||
|
|
||||||
|
You can now define your custom functionality in your batch job strategy. For example, you can create custom import logic to import products.
|
||||||
|
|
||||||
|
Refer to the [Create a Batch Job documentation](./create.md#3-define-required-properties) to understand what properties and methods are required in your batch job strategy and how you can use them to implement your custom functionality.
|
||||||
|
|
||||||
|
### 5. Run Build Command
|
||||||
|
|
||||||
|
Before you can test out your batch job strategy, you must run the `build` command:
|
||||||
|
|
||||||
|
```bash npm2yarn
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6. Test your Functionality
|
||||||
|
|
||||||
|
Since you didn’t create a new batch job type and overwrote the functionality of the strategy, you can test out your functionality using the [same steps used with the default strategy](./create.md#test-your-batch-job-strategy).
|
||||||
|
|
||||||
|
Specifically, since you create batch jobs using the [Create Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs) endpoint which accepts the batch job type as a body parameter, you just need to send the same type you used for this field. In the example of this documentation, the `type` would be `product-import`.
|
||||||
|
|
||||||
|
If you overwrote the import functionality, you can follow [these steps to learn how to import products using the Admin APIs](../../admin/import-products.mdx).
|
||||||
|
|
||||||
|
## Create Custom Batch Job Strategy
|
||||||
|
|
||||||
|
If you don’t want to overwrite Medusa’s batch job strategy, you can create a custom batch job strategy with a different `batchType` value. Then, use that type when you send a request to [Create a Batch Job](https://docs.medusajs.com/api/admin/#tag/Batch-Job).
|
||||||
|
|
||||||
|
For more details on creating custom batch job strategies, please check out the [Create Batch Job Strategy documentation](create.md).
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn more about [batch jobs](./index.md).
|
||||||
|
- Learn [how to use the Import Product APIs](../../admin/import-products.mdx).
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
In this document, you’ll learn what Batch Jobs are and how they work in Medusa.
|
In this document, you’ll learn what Batch Jobs are and how they work in Medusa.
|
||||||
|
|
||||||
## What are Batch Jobs?
|
## What are Batch Jobs
|
||||||
|
|
||||||
Batch Jobs are tasks that can be performed asynchronously and iteratively. They can be [created using the Admin API](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs), then, once confirmed, they are processed asynchronously.
|
Batch Jobs are tasks that can be performed asynchronously and iteratively. They can be [created using the Admin API](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs), then, once confirmed, they are processed asynchronously.
|
||||||
|
|
||||||
@@ -56,6 +56,6 @@ If the batch job fails at any point in this flow, its status is changed to `fail
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## What’s Next?
|
## What’s Next
|
||||||
|
|
||||||
- Learn about the [Batch Job’s events](../subscribers/events-list.md#batch-jobs-events).
|
- Learn about the [Batch Job’s events](../subscribers/events-list.md#batch-jobs-events).
|
||||||
@@ -4,7 +4,7 @@ In this document, you’ll learn how to create a cron job in Medusa.
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Medusa allows you to create cron jobs that run at specific times during your server’s lifetime. For example, you can synchronize your inventory with an ERP system once a day.
|
Medusa allows you to create cron jobs that run at specific times during your server’s lifetime. For example, you can synchronize your inventory with an Enterprise Resource Planning (ERP) system once a day.
|
||||||
|
|
||||||
This guide explains how to create a cron job on your Medusa server. The cron job in this example will simply change the status of draft products to `published`.
|
This guide explains how to create a cron job on your Medusa server. The cron job in this example will simply change the status of draft products to `published`.
|
||||||
|
|
||||||
@@ -12,7 +12,7 @@ This guide explains how to create a cron job on your Medusa server. The cron job
|
|||||||
|
|
||||||
### Medusa Components
|
### Medusa Components
|
||||||
|
|
||||||
It is assumed that you already have a Medusa server installed and set up. If not, you can follow our [quickstart guide](../../../quickstart/quick-start.md) to get started.
|
It is assumed that you already have a Medusa server installed and set up. If not, you can follow the [quickstart guide](../../../quickstart/quick-start.md) to get started.
|
||||||
|
|
||||||
### Redis
|
### Redis
|
||||||
|
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ import cors from "cors"
|
|||||||
import { projectConfig } from "../../medusa-config"
|
import { projectConfig } from "../../medusa-config"
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, create an object that will hold the CORS configurations:
|
Then, create an object that will hold the Cross-Origin Resource Sharing (CORS) configurations:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const corsOptions = {
|
const corsOptions = {
|
||||||
@@ -204,7 +204,7 @@ const user = await userService.retrieve(id)
|
|||||||
|
|
||||||
### Route Parameters
|
### Route Parameters
|
||||||
|
|
||||||
The routes you create receive 2 parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
|
The routes you create receive two parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
export default (rootDirectory, pluginOptions) => {
|
export default (rootDirectory, pluginOptions) => {
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ import cors from "cors"
|
|||||||
import { projectConfig } from "../../medusa-config"
|
import { projectConfig } from "../../medusa-config"
|
||||||
```
|
```
|
||||||
|
|
||||||
Then, create an object that will hold the CORS configurations:
|
Then, create an object that will hold the Cross-Origin Resource Sharing (CORS) configurations:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const corsOptions = {
|
const corsOptions = {
|
||||||
@@ -203,7 +203,7 @@ const customer = await customerService.retrieve(id)
|
|||||||
|
|
||||||
### Route Parameters
|
### Route Parameters
|
||||||
|
|
||||||
The routes you create receive 2 parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
|
The routes you create receive two parameters. The first one is the absolute path to the root directory that your server is running from. The second one is an object that has your plugin's options. If your API route is not implemented in a plugin, then it will be an empty object.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
export default (rootDirectory, pluginOptions) => {
|
export default (rootDirectory, pluginOptions) => {
|
||||||
|
|||||||
@@ -2,20 +2,6 @@
|
|||||||
|
|
||||||
In this document, you’ll learn how you can create an [Entity](overview.md).
|
In this document, you’ll learn how you can create an [Entity](overview.md).
|
||||||
|
|
||||||
## Prerequisites
|
|
||||||
|
|
||||||
It’s recommended to create a `tsconfig.json` file in the root of your Medusa server with the following content:
|
|
||||||
|
|
||||||
```jsx
|
|
||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This will remove any errors that show up in your IDE related to experimental decorators.
|
|
||||||
|
|
||||||
## Create the Entity
|
## Create the Entity
|
||||||
|
|
||||||
To create an entity, create a TypeScript file in `src/models`. For example, here’s a `Post` entity defined in the file `src/models/post.ts`:
|
To create an entity, create a TypeScript file in `src/models`. For example, here’s a `Post` entity defined in the file `src/models/post.ts`:
|
||||||
@@ -121,7 +107,7 @@ In the constructor, you can use dependency injection to get access to instances
|
|||||||
|
|
||||||
Then, in the method `list`, you can obtain an instance of the `PostRepository` using `this.manager_.getCustomRepository` passing it `this.postRepository` as a parameter. This lets you use [Custom Repositories with Typeorm](https://typeorm.io/custom-repository) to create custom methods in your repository that work with the data in your database.
|
Then, in the method `list`, you can obtain an instance of the `PostRepository` using `this.manager_.getCustomRepository` passing it `this.postRepository` as a parameter. This lets you use [Custom Repositories with Typeorm](https://typeorm.io/custom-repository) to create custom methods in your repository that work with the data in your database.
|
||||||
|
|
||||||
After getting an instance of the repository, you can then use [Typeorm’s Repository methods](https://typeorm.io/repository-api) to perform CRUD (Create, Read, Update, Delete) operations on your entity.
|
After getting an instance of the repository, you can then use [Typeorm’s Repository methods](https://typeorm.io/repository-api) to perform Create, Read, Update, and Delete (CRUD) operations on your entity.
|
||||||
|
|
||||||
If you need access to your entity in endpoints, you can then use the methods you define in the service.
|
If you need access to your entity in endpoints, you can then use the methods you define in the service.
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
In this document, you'll learn what Entities are in Medusa.
|
In this document, you'll learn what Entities are in Medusa.
|
||||||
|
|
||||||
## What are Entities?
|
## What are Entities
|
||||||
|
|
||||||
Entities in medusa represent tables in the database as classes. An example of this would be the `Order` entity which represents the `order` table in the database. Entities provide a uniform way of defining and interacting with data retrieved from the database.
|
Entities in medusa represent tables in the database as classes. An example of this would be the `Order` entity which represents the `order` table in the database. Entities provide a uniform way of defining and interacting with data retrieved from the database.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,91 @@
|
|||||||
|
# Toggle Feature Flags
|
||||||
|
|
||||||
|
In this document, you’ll learn about what feature flags are and how to toggle them.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Feature flags are used in Medusa to guard beta features that aren’t ready for live and production servers. This allows the Medusa team to keep publishing releases more frequently, while also working on necessary future features behind the scenes.
|
||||||
|
|
||||||
|
To use these beta features, you must enable their feature flags.
|
||||||
|
|
||||||
|
## Available Feature Flags
|
||||||
|
|
||||||
|
You can view a list of available feature flags that you can toggle in [the Medusa GitHub mono-repository](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags). In each feature flag file, you can find the default value of the feature flag, its name, environment variable name, and more.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
If a feature flag is enabled/disabled by default, you don’t need to manually enable/disable it. Only set the feature flag’s value if it’s different than the default.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Enable Feature Flags
|
||||||
|
|
||||||
|
:::caution
|
||||||
|
|
||||||
|
Features guarded by feature flags are experimental and beta features. Enable them with caution.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
There are two ways to enable a feature flag.
|
||||||
|
|
||||||
|
### Method One: Using Environment Variables
|
||||||
|
|
||||||
|
You can enable a feature by setting the value of its environment variable to `true`. You can find [the name of a feature flag’s environment variable in the loader file](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags) it’s defined in. It is defined under the property `env_key` in the exported object.
|
||||||
|
|
||||||
|
For example, to enable the Tax-Inclusive Pricing beta feature, add the following environment variable:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
MEDUSA_FF_TAX_INCLUSIVE_PRICING=true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Method Two: Using Server Settings
|
||||||
|
|
||||||
|
You can enable a feature by using the server settings in `medusa-config.js`. You can find [a feature flag’s key in the loader file](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags) it’s defined in. It is defined under the property `key` in the exported object.
|
||||||
|
|
||||||
|
For example, to enable the Tax-Inclusive Pricing beta feature, add the following to the exported object in `medusa-config.js`:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
module.exports = {
|
||||||
|
featureFlags: {
|
||||||
|
tax_inclusive_pricing: true
|
||||||
|
},
|
||||||
|
//...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Note About Precedence
|
||||||
|
|
||||||
|
The environment variable’s value has higher precedence over the server settings. So, if you use both these methods on your server, the value of the environment variable will be used.
|
||||||
|
|
||||||
|
For example, if the value of the environment variable is set to `false`, but the value of the feature flag in the server settings is set to `true`, the feature flag will take the value of the environment variable and will be disabled.
|
||||||
|
|
||||||
|
### Running Migrations
|
||||||
|
|
||||||
|
As feature flags generally include adding new entities or making changes to entities in the database, you must run the migrations after enabling the feature flag:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
medusa migrations run
|
||||||
|
```
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
You can learn more about migrations in this documentation.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Disable Feature Flags
|
||||||
|
|
||||||
|
Disabling feature flags follows the same process as enabling the feature flags. All you have to do is change the value in the environment variables or the server settings to `false`.
|
||||||
|
|
||||||
|
Once you disable a feature flag, all endpoints, entities, services, or other related classes and functionalities are disabled.
|
||||||
|
|
||||||
|
### Revert Migrations
|
||||||
|
|
||||||
|
If you had the feature flag previously enabled, and you want to disable this feature flag completely, you might need to revert the migrations you ran when you enabled it.
|
||||||
|
|
||||||
|
You can follow [this documentation to learn how to revert the last migration you ran](https://docs.medusajs.com/cli/reference#migrations).
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn more about [Migrations](../migrations/overview.md).
|
||||||
|
- Learn how to [configure your Medusa server](../../../usage/configurations.md).
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# How to Create Migrations
|
# How to Create Migrations
|
||||||
|
|
||||||
In this document, you’ll learn how to create a [Migration](overview.md) using [Typeorm](https://typeorm.io).
|
In this document, you’ll learn how to create a [Migration](overview.md) using [Typeorm](https://typeorm.io) on your Medusa server.
|
||||||
|
|
||||||
## Create Migration File
|
## Create Migration File
|
||||||
|
|
||||||
@@ -10,14 +10,10 @@ To create a migration that makes changes to your Medusa schema, run the followin
|
|||||||
npx typeorm migration:create -n UserChanged --dir src/migrations
|
npx typeorm migration:create -n UserChanged --dir src/migrations
|
||||||
```
|
```
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
The migration file must be inside the `src/migrations` directory. When the build command is run, it will be transpiled into the directory `dist/migrations`. The `migrations run` command can only pick up migrations under the `dist/migrations` directory.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
This will create the migration file in the path you specify. You can use this without the need to install Typeorm's CLI tool. You can then go ahead and make changes to it as necessary.
|
This will create the migration file in the path you specify. You can use this without the need to install Typeorm's CLI tool. You can then go ahead and make changes to it as necessary.
|
||||||
|
|
||||||
|
The migration file must be inside the `src/migrations` directory. When you run the build command, it will be transpiled into the directory `dist/migrations`. The `migrations run` command can only pick up migrations under the `dist/migrations` directory on a Medusa server. This applies to migrations created in a Medusa server, and not in a Medusa plugin. For plugins, check out the [Plugin's Structure section](../plugins/create.md).
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
You can learn more about writing migrations in [Typeorm’s Documentation](https://typeorm.io/migrations).
|
You can learn more about writing migrations in [Typeorm’s Documentation](https://typeorm.io/migrations).
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Medusa’s Migrations do not work with SQLite databases. They are intended to be
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## What are Migrations?
|
## What are Migrations
|
||||||
|
|
||||||
Migrations are scripts that are used to make additions or changes to your database schema. In Medusa, they are essential for both when you first install your server and for subsequent server upgrades later on.
|
Migrations are scripts that are used to make additions or changes to your database schema. In Medusa, they are essential for both when you first install your server and for subsequent server upgrades later on.
|
||||||
|
|
||||||
|
|||||||
@@ -100,7 +100,7 @@ When an event is triggered that your Notification Provider is registered as a ha
|
|||||||
|
|
||||||
In this method, you can perform the necessary operation to send the Notification. Following the example above, you can send an email to the customer when they place an order.
|
In this method, you can perform the necessary operation to send the Notification. Following the example above, you can send an email to the customer when they place an order.
|
||||||
|
|
||||||
This method receives 3 parameters:
|
This method receives three parameters:
|
||||||
|
|
||||||
1. `eventName`: This is the name of the event that was triggered. For example, `order.placed`.
|
1. `eventName`: This is the name of the event that was triggered. For example, `order.placed`.
|
||||||
2. `eventData`: This is the data payload of the event that was triggered. For example, if the `order.placed` event is triggered, the `eventData` object contains the property `id` which is the ID of the order that was placed.
|
2. `eventData`: This is the data payload of the event that was triggered. For example, if the `order.placed` event is triggered, the `eventData` object contains the property `id` which is the ID of the order that was placed.
|
||||||
@@ -156,7 +156,7 @@ The `to` and `data` properties are used in the `NotificationService` in Medusa
|
|||||||
|
|
||||||
Using the [Resend Notification endpoint](https://docs.medusajs.com/api/admin/#tag/Notification/operation/PostNotificationsNotificationResend), an admin user can resend a Notification to the customer. The [`NotificationService`](../../../references/services/classes/NotificationService.md) in Medusa’s core then executes the `resendNotification` method in your Notification Provider.
|
Using the [Resend Notification endpoint](https://docs.medusajs.com/api/admin/#tag/Notification/operation/PostNotificationsNotificationResend), an admin user can resend a Notification to the customer. The [`NotificationService`](../../../references/services/classes/NotificationService.md) in Medusa’s core then executes the `resendNotification` method in your Notification Provider.
|
||||||
|
|
||||||
This method receives 3 parameters:
|
This method receives three parameters:
|
||||||
|
|
||||||
1. `notification`: This is the original Notification record that was created after you sent the notification with `sendNotification`. You can get an overview of the entity and its attributes in the [architecture overview](overview.md#notification-entity-overview), but most notably it includes the `to` and `data` attributes which are populated originally using the `to` and `data` properties of the object you return in `sendNotification`.
|
1. `notification`: This is the original Notification record that was created after you sent the notification with `sendNotification`. You can get an overview of the entity and its attributes in the [architecture overview](overview.md#notification-entity-overview), but most notably it includes the `to` and `data` attributes which are populated originally using the `to` and `data` properties of the object you return in `sendNotification`.
|
||||||
2. `config`: In the Resend Notification endpoint you may specify an alternative receiver of the notification using the `to` request body parameter. For example, you may want to resend the order confirmation email to a different email. If that’s the case, you have access to it in the `config` parameter object. Otherwise, `config` will be an empty object.
|
2. `config`: In the Resend Notification endpoint you may specify an alternative receiver of the notification using the `to` request body parameter. For example, you may want to resend the order confirmation email to a different email. If that’s the case, you have access to it in the `config` parameter object. Otherwise, `config` will be an empty object.
|
||||||
@@ -240,7 +240,7 @@ Then, place an order either using the [REST APIs](https://docs.medusajs.com/api/
|
|||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
If you don’t have a storefront installed you can get started with either our [Next.js](../../../starters/nextjs-medusa-starter.md) or [Gatsby](../../../starters/gatsby-medusa-starter.md) starter storefronts in minutes.
|
If you don’t have a storefront installed you can get started with either the [Next.js](../../../starters/nextjs-medusa-starter.md) or [Gatsby](../../../starters/gatsby-medusa-starter.md) starter storefronts in minutes.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ This document gives an overview of the notification architecture and how it work
|
|||||||
|
|
||||||
Medusa provides a Notification API to mainly handle sending and resending notifications when an event occurs. For example, sending an email to the customer when they place an order.
|
Medusa provides a Notification API to mainly handle sending and resending notifications when an event occurs. For example, sending an email to the customer when they place an order.
|
||||||
|
|
||||||
The Notification architecture is made up of 2 main components: the Notification Provider and the Notification. Simply put, the Notification Provider handles the sending and resending of a Notification.
|
The Notification architecture is made up of two main components: the Notification Provider and the Notification. Simply put, the Notification Provider handles the sending and resending of a Notification.
|
||||||
|
|
||||||
## Notification Provider
|
## Notification Provider
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ When you run your Medusa server, the Notification Provider is registered on your
|
|||||||
|
|
||||||
### NotificationProvider Entity Overview
|
### NotificationProvider Entity Overview
|
||||||
|
|
||||||
The `NotificationProvider` entity only has 2 attributes: `id` and `is_installed`.
|
The [`NotificationProvider`](../../../references/js-client/classes/internal-11.NotificationProvider.md) entity only has 2 attributes: `id` and `is_installed`.
|
||||||
|
|
||||||
`id` is the value of the static property `identifier` defined inside the notification Service class.
|
`id` is the value of the static property `identifier` defined inside the notification Service class.
|
||||||
|
|
||||||
@@ -33,7 +33,6 @@ The `NotificationProvider` entity only has 2 attributes: `id` and `is_installed`
|
|||||||
If you installed a Notification provider and then removed the Service files or plugin that registered the Notification Provider, the Notification Provider remains in your database, but the value of the `is_installed` field changes to `false`.
|
If you installed a Notification provider and then removed the Service files or plugin that registered the Notification Provider, the Notification Provider remains in your database, but the value of the `is_installed` field changes to `false`.
|
||||||
|
|
||||||
## Notification
|
## Notification
|
||||||
|
|
||||||
A notification is a form of an alert sent to the customers or users to inform them of an action that has occurred. For example, if an order is placed, the notification, in this case, can be an email that confirms their order and lists the order details.
|
A notification is a form of an alert sent to the customers or users to inform them of an action that has occurred. For example, if an order is placed, the notification, in this case, can be an email that confirms their order and lists the order details.
|
||||||
|
|
||||||
Notifications can take on other forms such as an SMS or a Slack message.
|
Notifications can take on other forms such as an SMS or a Slack message.
|
||||||
@@ -48,7 +47,7 @@ A Notification also represents a resent notification. So, when a notification is
|
|||||||
|
|
||||||
### Notification Entity Overview
|
### Notification Entity Overview
|
||||||
|
|
||||||
The 2 most important properties in the `Notification` entity are the `to` and `data` properties.
|
The two most important properties in the [`Notification`](../../../references/js-client/classes/internal-11.Notification.md) entity are the `to` and `data` properties.
|
||||||
|
|
||||||
The `to` property is a string that represents the receiver of the Notification. For example, if the Notification was sent to an email address, the `to` property holds the email address the Notification was sent to.
|
The `to` property is a string that represents the receiver of the Notification. For example, if the Notification was sent to an email address, the `to` property holds the email address the Notification was sent to.
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ A Payment Provider in Medusa is a method to handle payments in selected regions.
|
|||||||
|
|
||||||
Payment Providers can be integrated with third-party services that handle payment operations such as capturing a payment. An example of a Payment Provider is Stripe.
|
Payment Providers can be integrated with third-party services that handle payment operations such as capturing a payment. An example of a Payment Provider is Stripe.
|
||||||
|
|
||||||
Payment Providers can also be related to a custom way of handling payment operations. An example of that is cash on delivery (COD) payment methods or Medusa’s [manual payment provider plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-payment-manual) which provides a minimal implementation of a payment provider and allows store operators to manually handle order payments.
|
Payment Providers can also be related to a custom way of handling payment operations. An example of that is Cash on Delivery (COD) payment methods or Medusa’s [manual payment provider plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-payment-manual) which provides a minimal implementation of a payment provider and allows store operators to manually handle order payments.
|
||||||
|
|
||||||
### How Payment Provider is Created
|
### How Payment Provider is Created
|
||||||
|
|
||||||
|
|||||||
@@ -22,26 +22,13 @@ Where `medusa-plugin-custom` is the name of the plugin you’re creating. In Med
|
|||||||
|
|
||||||
By convention, all plugin names start with `medusa` followed by a descriptive name of what the plugin does. For example, the Stripe plugin is named `medusa-payment-stripe`.
|
By convention, all plugin names start with `medusa` followed by a descriptive name of what the plugin does. For example, the Stripe plugin is named `medusa-payment-stripe`.
|
||||||
|
|
||||||
|
## Changes to package.json
|
||||||
|
|
||||||
### Rename Project Name
|
### Rename Project Name
|
||||||
|
|
||||||
Update the `name` field in the `package.json` file to the name of your plugin. This should be the same name that you chose when running the `medusa new` command.
|
Update the `name` field in the `package.json` file to the name of your plugin. This should be the same name that you chose when running the `medusa new` command.
|
||||||
|
|
||||||
### Project Structure
|
### Change Dependencies
|
||||||
|
|
||||||
The command above creates a new directory `medusa-plugin-custom` that holds essentially the same codebase you would have for a Medusa server. This is because a plugin has the same directory structure as a Medusa server.
|
|
||||||
|
|
||||||
Under the `src` directory is where the code of your plugin resides. After running the previous command, you should have at least 3 directories inside the `src` directory:
|
|
||||||
|
|
||||||
- `api` is where you can add custom endpoints.
|
|
||||||
- `services` is where you can add custom services.
|
|
||||||
- `subscribers` is where you can add custom subscribers.
|
|
||||||
|
|
||||||
You can also add more directories and files to your plugin including:
|
|
||||||
|
|
||||||
- `src/models` for adding custom entities or extending existing entities.
|
|
||||||
- `src/migrations` for migrations that make changes to the database schema.
|
|
||||||
|
|
||||||
## Change Dependencies in package.json
|
|
||||||
|
|
||||||
A basic Medusa server installed with the `medusa new` command has dependencies similar to this:
|
A basic Medusa server installed with the `medusa new` command has dependencies similar to this:
|
||||||
|
|
||||||
@@ -93,44 +80,39 @@ Once you’re done making these changes, re-run the install command to update yo
|
|||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Recommended Changes in package.json
|
|
||||||
|
|
||||||
This section includes recommended changes to your `package.json`. You can skip any of these changes if you don’t find them necessary to your plugin.
|
This section includes recommended changes to your `package.json`. You can skip any of these changes if you don’t find them necessary to your plugin.
|
||||||
|
|
||||||
### Change Basic Info
|
### Recommended: Change scripts
|
||||||
|
|
||||||
`package.json` holds information that further describes the package or the author that created the package. It is recommended to make the following changes:
|
:::caution
|
||||||
|
|
||||||
- `description`: Change this to a sentence that describes what your plugin does.
|
If you don't make changes to the `build` and `watch` commands, please be aware of the [expected plugin structure](#plugin-structure).
|
||||||
- `author`: Your name and email.
|
|
||||||
- `repository`: The repository that holds your plugin’s codebase.
|
|
||||||
- `keywords`: This should hold the keywords that are related to your plugin. It’s recommended that all plugins use the keywords `medusa-plugin` or `medusa`.
|
|
||||||
|
|
||||||
### Change scripts
|
:::
|
||||||
|
|
||||||
A basic Medusa installation comes with the following scripts:
|
A basic Medusa installation comes with the following scripts:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"seed": "medusa seed -f ./data/seed.json",
|
"seed": "medusa seed -f ./data/seed.json",
|
||||||
"build": "babel src -d dist --extensions \".ts,.js\"",
|
"build": "babel src --out-dir . --ignore **/__tests__ --extensions \".ts,.js\"",
|
||||||
"start": "medusa develop"
|
"start": "medusa develop"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `seed` and `start` scripts are not necessary for plugin development so you can remove them.
|
The `seed` and `start` scripts aren't necessary for plugin development so you can remove them.
|
||||||
|
|
||||||
It’s also recommended to add the `watch` script that automatically compiles your files if they are changed:
|
It’s also recommended to add the `watch` script that automatically compiles your files if they are changed:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"watch": "babel -w src --out-dir . --ignore **/__tests__"
|
"watch": "babel -w src --out-dir . --ignore **/__tests__ --extensions \".ts,.js\""
|
||||||
```
|
```
|
||||||
|
|
||||||
This is helpful when testing the plugin.
|
This is helpful when testing the plugin.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
Testing the plugin is covered in a later section.
|
Testing the plugin is covered in a [later section](#test-your-plugin).
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@@ -148,16 +130,64 @@ This script requires installing the package `cross-env` as a development depende
|
|||||||
npm install --save-dev cross-env
|
npm install --save-dev cross-env
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Recommended: Change Basic Info
|
||||||
|
|
||||||
|
`package.json` holds information that further describes the package or the author that created the package. It is recommended to make the following changes:
|
||||||
|
|
||||||
|
- `description`: Change this to a sentence that describes what your plugin does.
|
||||||
|
- `author`: Your name and email.
|
||||||
|
- `repository`: The repository that holds your plugin’s codebase.
|
||||||
|
- `keywords`: This should hold the keywords that are related to your plugin. It’s recommended that all plugins use the keywords `medusa-plugin` or `medusa`.
|
||||||
|
|
||||||
## Develop your Plugin
|
## Develop your Plugin
|
||||||
|
|
||||||
Now, You can start developing your plugin. This can include adding services, endpoints, entities, or anything that is relevant to your plugin.
|
Now, You can start developing your plugin. This can include adding services, endpoints, entities, or anything that's relevant to your plugin.
|
||||||
|
|
||||||
This guide does not cover how to create each of those files or components. If you’re interested in learning how to do that, you can check out these guides:
|
### Plugin Structure
|
||||||
|
|
||||||
|
While developing your plugin, you can create your TypeScript or JavaScript files under the `src` directory. This includes creating services, endpoints, migrations, etc...
|
||||||
|
|
||||||
|
However, before you test the changes on a Medusa server or publish your plugin, you must transpile your files, which moves them into the root of your plugin directory.
|
||||||
|
|
||||||
|
For example, if you have an endpoint in `src/api/index.js`, after running the `build` or `watch` commands [as defined earlier](#change-scripts), the file should be transpiled into `api/index.js` in your plugin's root.
|
||||||
|
|
||||||
|
If files and directories aren't placed in the root of your plugin, the Medusa server won't detect or load them.
|
||||||
|
|
||||||
|
An example of a plugin's directory before testing or publishing:
|
||||||
|
|
||||||
|
```
|
||||||
|
medusa-plugin-custom
|
||||||
|
|
|
||||||
|
|_ _ _ api
|
||||||
|
| |
|
||||||
|
| |_ _ _ index.js
|
||||||
|
|
|
||||||
|
|_ _ _ migrations
|
||||||
|
| |
|
||||||
|
| |_ _ _ <TIMESTAMP>_UserChanged.js
|
||||||
|
|
|
||||||
|
|_ _ _ src
|
||||||
|
| |
|
||||||
|
| |_ _ _ api
|
||||||
|
| | |
|
||||||
|
| | |_ _ _ index.ts
|
||||||
|
| |
|
||||||
|
| |_ _ _ migrations
|
||||||
|
| |
|
||||||
|
| |_ _ _ <TIMESTAMP>_UserChanged.ts
|
||||||
|
|
|
||||||
|
|_ _ _ package.json
|
||||||
|
//... other files
|
||||||
|
```
|
||||||
|
|
||||||
|
### Development Resources
|
||||||
|
|
||||||
|
This guide doesn't cover how to create different files and components. If you’re interested in learning how to do that, you can check out these guides:
|
||||||
|
|
||||||
- How to create endpoints for [storefront](../endpoints/add-storefront.md) and [admin](../endpoints/add-admin.md)
|
- How to create endpoints for [storefront](../endpoints/add-storefront.md) and [admin](../endpoints/add-admin.md)
|
||||||
- How to [create a service](../services/create-service.md)
|
- How to [create a service](../services/create-service.md)
|
||||||
- How to [create a subscriber](../subscribers/create-subscriber.md)
|
- How to [create a subscriber](../subscribers/create-subscriber.md)
|
||||||
- How to create an entity
|
- How to [create an entity](./../entities/index.md)
|
||||||
- How to [create a migration](../migrations/index.md)
|
- How to [create a migration](../migrations/index.md)
|
||||||
|
|
||||||
## Add Plugin Configuration
|
## Add Plugin Configuration
|
||||||
@@ -301,9 +331,9 @@ rm -rf node_modules
|
|||||||
cd <SERVER_PATH>/node_modules/<PLUGIN_NAME>
|
cd <SERVER_PATH>/node_modules/<PLUGIN_NAME>
|
||||||
npm install
|
npm install
|
||||||
cd <PLUGIN_PATH>
|
cd <PLUGIN_PATH>
|
||||||
npm build
|
npm run build
|
||||||
cd <SERVER_PATH>
|
cd <SERVER_PATH>
|
||||||
npm start
|
npm run start
|
||||||
```
|
```
|
||||||
|
|
||||||
Where `<SERVER_PATH>` is the path to your Medusa server, `<PLUGIN_PATH>` is the path to your plugin and `<PLUGIN_NAME>` is the name of your plugin as it is in your plugin `package.json` file.
|
Where `<SERVER_PATH>` is the path to your Medusa server, `<PLUGIN_PATH>` is the path to your plugin and `<PLUGIN_NAME>` is the name of your plugin as it is in your plugin `package.json` file.
|
||||||
@@ -318,7 +348,7 @@ It is safe to ignore any `cross-env: command not found` error you may receive.
|
|||||||
|
|
||||||
Not all files that you use while developing your plugin are necessary to be published.
|
Not all files that you use while developing your plugin are necessary to be published.
|
||||||
|
|
||||||
For example, the files you add in the `src` directory are compiled to a `dist` directory before publishing. Then, when a developer installs your plugin, they’ll just be using the files under the `dist` directory.
|
For example, the files you add in the `src` directory are compiled to the root of the plugin directory before publishing. Then, when a developer installs your plugin, they’ll just be using the files in the root.
|
||||||
|
|
||||||
So, you can ignore files and directories like `src` from the final published NPM package.
|
So, you can ignore files and directories like `src` from the final published NPM package.
|
||||||
|
|
||||||
@@ -353,6 +383,14 @@ Once you’re done developing your plugin you can publish the package on NPM’s
|
|||||||
|
|
||||||
Before you publish a plugin, you must [create an account on NPM](https://www.npmjs.com/signup).
|
Before you publish a plugin, you must [create an account on NPM](https://www.npmjs.com/signup).
|
||||||
|
|
||||||
|
### Prepare Plugin
|
||||||
|
|
||||||
|
Before you publish or update your plugin, make sure to run the `prepare` command [defined earlier](#recommended-change-scripts):
|
||||||
|
|
||||||
|
```bash npm2yarn
|
||||||
|
npm run prepare
|
||||||
|
```
|
||||||
|
|
||||||
### Login
|
### Login
|
||||||
|
|
||||||
In your terminal, log in with your NPM account:
|
In your terminal, log in with your NPM account:
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ Plugins run within the same process as the core Medusa server eliminating the ne
|
|||||||
|
|
||||||
### Official Plugins
|
### Official Plugins
|
||||||
|
|
||||||
Medusa has official plugins that cover different aspects and functionalities such as payment, CMS, fulfillment, and notifications. You can check out the available plugins under the [packages directory in the Medusa repository on GitHub](https://github.com/medusajs/medusa/tree/master/packages).
|
Medusa has official plugins that cover different aspects and functionalities such as payment, Content Management System (CMS), fulfillment, and notifications. You can check out the available plugins under the [packages directory in the Medusa repository on GitHub](https://github.com/medusajs/medusa/tree/master/packages).
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,87 @@
|
|||||||
|
# Price Lists
|
||||||
|
|
||||||
|
In this document, you’ll learn what price lists are and how they work.
|
||||||
|
|
||||||
|
## What are Price Lists
|
||||||
|
|
||||||
|
Price lists can be used to override products’ prices based on different conditions. Each price list you create can have its own options and conditions. A price list must override at least one product variant’s prices.
|
||||||
|
|
||||||
|
### Example Use Cases
|
||||||
|
|
||||||
|
Price lists can be used for a variety of use cases including:
|
||||||
|
|
||||||
|
- Setting different prices for VIP customers.
|
||||||
|
- Creating sales that run through a specific period of time.
|
||||||
|
- Implement Buy X for Price Y sale model. In other words, buy X quantity of a product at the price of Y.
|
||||||
|
|
||||||
|
### Price List Entity Overview
|
||||||
|
|
||||||
|
A price list is stored in the database as a [PriceList](../../../references/entities/classes/PriceList.md) entity. Some of its important attributes are:
|
||||||
|
|
||||||
|
- `type`: The price list's type. Can be either a `sale` or an `override`.
|
||||||
|
- `status`: The status of the price list. Can be `active` or `draft`. If a price list is a `draft`, its prices won't be applied even if its conditions are met.
|
||||||
|
- `starts_at`: The date to start applying the price list.
|
||||||
|
- `ends_at`: The date to stop applying the price list.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Price List Conditions
|
||||||
|
|
||||||
|
You can control when a price list is applied using a set of conditions. Only when these conditions are met can the price list be applied.
|
||||||
|
|
||||||
|
You can use any of the following conditions:
|
||||||
|
|
||||||
|
- **Start and/or expiry date**: You can set a start date, an end date, or both to define when the prices in the list should be applied.
|
||||||
|
- **Customer group:** You can choose a customer group to apply the prices for. Customers that belong to this group will see the prices you set in the list, which customers that don’t belong to the group can’t see.
|
||||||
|
- **Minimum and/or maximum quantity:** You can specify the minimum quantity, the maximum quantity, or both minimum and maximum quantities of a product variant required to be in the customer’s cart to apply a price in a price list.
|
||||||
|
- **Region:** You can specify a specific region where a price in the price list is available in. Only customers accessing your store from that region can see these prices.
|
||||||
|
- **Currency Code:** You can specify a currency code where a price in the price list is available in. Only customers accessing your store from regions that use this currency can see these prices.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How are Price Lists Applied
|
||||||
|
|
||||||
|
When a product or a line item is retrieved or manipulated on the storefront, Medusa determines its price using a Price Selection Strategy. The price selection strategy determines the best price to apply in a given [context](../price-selection-strategy/index.md#context-object). Part of determining the price depends on the price list.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
This section explains how the price selection strategy uses price lists when it determines the price of a product variant. If you want full details on how the price selection strategy works, check out this documentation instead.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Product Variants
|
||||||
|
|
||||||
|
When the strategy calculates the prices of a product variant, it retrieves both the original and the calculated prices of the variant.
|
||||||
|
|
||||||
|
The original price depends on the selected region or currency code in the current context, where the region has higher precedence.
|
||||||
|
|
||||||
|
The calculated price is the lowest price among all retrieved prices. Retrieved prices can include the original price and the price lists that can be applied. Prices are retrieved based on the [context](../price-selection-strategy/index.md#context-object).
|
||||||
|
|
||||||
|
In the [Get Product](https://docs.medusajs.com/api/store/#tag/Product/operation/GetProductsProduct) and [List Product](https://docs.medusajs.com/api/store/#tag/Product/operation/GetProducts) endpoints, you must pass either the `region_id` or `currency_code` to retrieve the correct prices, as they are part of the price selection strategy context.
|
||||||
|
|
||||||
|
Each variant in the response has the following properties:
|
||||||
|
|
||||||
|
- `original_price`: The price based on the region or currency selected. You can also retrieve the original price with tax from the `original_price_incl_tax` property.
|
||||||
|
- `calculated_price`: The price retrieved from a price list, if there are any. If no price list matches the current context, `calculated_price` will have the same value as `original_price`. You can also retrieve the calculated price with tax from the `calculated_price_incl_tax` property.
|
||||||
|
|
||||||
|
If both the `region_id` and `currency_code` aren’t passed to the request, the values of these properties will be `null`.
|
||||||
|
|
||||||
|
### Line Items
|
||||||
|
|
||||||
|
The total of a line item depends on the price of a product variant. When the line item is created, the price of its underlying product variant is retrieved using the same process detailed in the previous section.
|
||||||
|
|
||||||
|
Then, the `unit_price` of the line item is set to the `calculated_price` property of the product variant.
|
||||||
|
|
||||||
|
When creating, retrieving, or updating the line item using the API endpoints, the line item’s totals are calculated. The following properties are returned as part of the endpoints’ responses:
|
||||||
|
|
||||||
|
- `unit_price`: The product variant’s calculated price.
|
||||||
|
- `subtotal`: The `unit_price` multiplied by the quantity of the line item.
|
||||||
|
|
||||||
|
Since the line item belongs to a cart, there’s no need to pass the `region_id` or `currency_code` to the requests. The cart’s region and currency are used to determine the context of the price selection.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn more about [price selection strategies](../price-selection-strategy/index.md).
|
||||||
|
- Learn [how to use the PriceList Admin APIs](./use-api.mdx).
|
||||||
@@ -0,0 +1,472 @@
|
|||||||
|
import Tabs from '@theme/Tabs';
|
||||||
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
|
# Use PriceList API
|
||||||
|
|
||||||
|
In this document, you’ll learn how to use the PriceList Admin APIs to create, update, and manage prices in a price list.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
This document doesn't cover what price lists are and their basics. If you’re interested to learn about that, check out [this documentation](./index.md) instead.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
### Medusa Components
|
||||||
|
|
||||||
|
It is assumed that you already have a Medusa server installed and set up. If not, you can follow our [quickstart guide](../../../quickstart/quick-start.md) to get started.
|
||||||
|
|
||||||
|
### JS Client
|
||||||
|
|
||||||
|
This guide includes code snippets to send requests to your Medusa server using Medusa’s JS Client, JavaScript’s Fetch API, or cURL.
|
||||||
|
|
||||||
|
If you follow the JS Client code blocks, it’s assumed you already have [Medusa’s JS Client](../../../js-client/overview.md) installed and [have created an instance of the client](../../../js-client/overview.md#configuration).
|
||||||
|
|
||||||
|
### Authenticated Admin User
|
||||||
|
|
||||||
|
You must be an authenticated admin user before following along with the steps in the tutorial.
|
||||||
|
|
||||||
|
You can learn more about [authenticating as an admin user in the API reference](https://docs.medusajs.com/api/admin/#section/Authentication).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Create Price List
|
||||||
|
|
||||||
|
When you create a price list, you can specify different conditions to control when the price list can be applied.
|
||||||
|
|
||||||
|
In the body of your request, aside from the required fields, you can send the following fields to apply different conditions:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
prices: [
|
||||||
|
{
|
||||||
|
region_id,
|
||||||
|
currency_code,
|
||||||
|
min_quantity,
|
||||||
|
max_quantity
|
||||||
|
}
|
||||||
|
],
|
||||||
|
customer_groups: [
|
||||||
|
{
|
||||||
|
id
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
You can learn more about what the conditions you can apply on a price list and its prices in this documentation.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
For example, sending the following request creates a price list with two prices: one that is applied when the maximum quantity of the product variant in the cart is 3; another is applied when the minimum quantity of the same variant in the cart is 4:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
import { PriceListType } from "@medusajs/medusa"
|
||||||
|
|
||||||
|
medusa.admin.priceLists.create({
|
||||||
|
name: 'New Price List',
|
||||||
|
description: 'A new price list',
|
||||||
|
type: PriceListType.SALE,
|
||||||
|
status: 'active',
|
||||||
|
prices: [
|
||||||
|
{
|
||||||
|
amount: 1000,
|
||||||
|
variant_id,
|
||||||
|
currency_code: 'eur',
|
||||||
|
max_quantity: 3
|
||||||
|
},
|
||||||
|
{
|
||||||
|
amount: 1500,
|
||||||
|
variant_id,
|
||||||
|
currency_code: 'eur',
|
||||||
|
min_quantity: 4
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
name: 'New Price List',
|
||||||
|
description: 'A new price list',
|
||||||
|
type: 'sale',
|
||||||
|
status: 'active',
|
||||||
|
prices: [
|
||||||
|
{
|
||||||
|
amount: 1000,
|
||||||
|
variant_id,
|
||||||
|
currency_code: 'eur',
|
||||||
|
max_quantity: 3
|
||||||
|
},
|
||||||
|
{
|
||||||
|
amount: 1500,
|
||||||
|
variant_id,
|
||||||
|
currency_code: 'eur',
|
||||||
|
min_quantity: 4
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl --location --request POST '<YOUR_SERVER_URL>/admin/price-lists' \
|
||||||
|
--header 'Authorization: Bearer {api_token}' \
|
||||||
|
--header 'Content-Type: application/json' \
|
||||||
|
--data-raw '{
|
||||||
|
"name": "New Price List",
|
||||||
|
"description": "A new price list",
|
||||||
|
"type": "sale",
|
||||||
|
"status": "active",
|
||||||
|
"prices": [
|
||||||
|
{
|
||||||
|
"amount": 1500,
|
||||||
|
"variant_id": "<VARIANT_ID>",
|
||||||
|
"max_quantity": 3,
|
||||||
|
"currency_code": "eur"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"amount": 1000,
|
||||||
|
"variant_id": "<VARIANT_ID>",
|
||||||
|
"currency_code": "eur",
|
||||||
|
"min_quantity": 4
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
This request returns the created price list.
|
||||||
|
|
||||||
|
You can check the full list of request body parameters in the [API reference](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceList).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Get Price List’s Details
|
||||||
|
|
||||||
|
You can retrieve all of a price list’s details using the Get a Price List endpoint:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
medusa.admin.priceLists.retrieve(priceListId)
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists/${priceListId}`)
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
curl --location --request GET '<SERVER_URL>/admin/price-lists/{id}' \
|
||||||
|
--header 'Authorization: Bearer {api_token}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Update a Price List
|
||||||
|
|
||||||
|
After creating a price list, you can update all of its fields including its status, prices, and more using the [Update Price List](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceListPriceList) endpoint.
|
||||||
|
|
||||||
|
For example, by sending the following request the end date of the price list will be updated:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
medusa.admin.priceLists.update(priceListId, {
|
||||||
|
ends_at: '2022-10-11'
|
||||||
|
})
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists/${priceListId}`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
ends_at: '2022-10-11'
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl --location --request POST '<SERVER_URL>/admin/price-lists/<PRICE_LIST_ID>' \
|
||||||
|
--header 'Authorization: Bearer {api_token}' \
|
||||||
|
--header 'Content-Type: application/json' \
|
||||||
|
--data-raw '{
|
||||||
|
"ends_at": "2022-10-11"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
This request returns the updated price list.
|
||||||
|
|
||||||
|
For a full list of request body parameters, check out the [API reference](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceListPriceList).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Manage Prices
|
||||||
|
|
||||||
|
### Add Prices
|
||||||
|
|
||||||
|
You can add prices to your price list after creating it using the [Update Prices](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceListPricesBatch) endpoint.
|
||||||
|
|
||||||
|
You can also set the `override` request body parameter to `true` to replace the existing prices in the price list.
|
||||||
|
|
||||||
|
For example, sending the following request adds a new price to the price list:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
medusa.admin.priceLists.addPrices(priceListId, {
|
||||||
|
prices: [
|
||||||
|
{
|
||||||
|
amount: 1200,
|
||||||
|
variant_id,
|
||||||
|
currency_code: 'eur'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists/${priceListId}/prices/batch`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
prices: [
|
||||||
|
{
|
||||||
|
amount: 1200,
|
||||||
|
variant_id,
|
||||||
|
currency_code: 'eur'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ price_list }) => {
|
||||||
|
console.log(price_list.id)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl --location --request POST '<SERVER_URL>/admin/price-lists/<PRICE_LIST_ID>' \
|
||||||
|
--header 'Authorization: Bearer {api_token}' \
|
||||||
|
--header 'Content-Type: application/json' \
|
||||||
|
--data-raw '{
|
||||||
|
"prices": [
|
||||||
|
{
|
||||||
|
"amount": 1200,
|
||||||
|
"variant_id": "<VARIANT_ID>",
|
||||||
|
"currency_code": "eur"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
This request returns the price list with the updated prices.
|
||||||
|
|
||||||
|
For a full list of request body parameters, check out the [API reference](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/PostPriceListsPriceListPricesBatch).
|
||||||
|
|
||||||
|
### Delete a Product’s Prices
|
||||||
|
|
||||||
|
You can delete all the prices of a product’s variants using the [Delete Product Prices](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/DeletePriceListsPriceListProductsProductPrices) endpoint:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
medusa.admin.priceLists.deleteProductPrices(priceListId, productId)
|
||||||
|
.then(({ ids, object, deleted }) => {
|
||||||
|
console.log(ids.length);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists/${priceListId}/products/${productId}/prices`, {
|
||||||
|
method: 'DELETE'
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ ids, object, deleted }) => {
|
||||||
|
console.log(ids.length)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl --location --request DELETE '<SERVER_URL>/admin/price-lists/<PRICE_LIST_ID>/products/<PRODUCT_ID>/prices' \
|
||||||
|
--header 'Authorization: Bearer {api_token}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
This request returns the IDs of the deleted prices.
|
||||||
|
|
||||||
|
### Delete a Variant’s Prices
|
||||||
|
|
||||||
|
You can delete all the prices of a variant using the [Delete Variant Prices](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/DeletePriceListsPriceListVariantsVariantPrices) endpoint:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
medusa.admin.priceLists.deleteVariantPrices(priceListId, variantId)
|
||||||
|
.then(({ ids, object, deleted }) => {
|
||||||
|
console.log(ids);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists/${priceListId}/variants/${variantId}/prices`, {
|
||||||
|
method: 'DELETE'
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ ids, object, deleted }) => {
|
||||||
|
console.log(ids.length)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
curl --location --request DELETE '<SERVER_URL>/admin/price-lists/<PRICE_LIST_ID>/variants/<VARIANT_ID>/prices' \
|
||||||
|
--header 'Authorization: Bearer {api_token}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
This request returns the IDs of the deleted prices.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Delete Price List
|
||||||
|
|
||||||
|
You can delete a price list, and subsequently all prices defined in it, using the [Delete Price List](https://docs.medusajs.com/api/admin/#tag/Price-List/operation/DeletePriceListsPriceList) endpoint:
|
||||||
|
|
||||||
|
<Tabs groupId="request-type">
|
||||||
|
<TabItem value="client" label="Medusa JS Client" default>
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
medusa.admin.priceLists.delete(priceListId)
|
||||||
|
.then(({ id, object, deleted }) => {
|
||||||
|
console.log(id);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="fetch" label="Fetch API">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fetch(`<SERVER_URL>/admin/price-lists/${priceListId}`, {
|
||||||
|
method: 'DELETE'
|
||||||
|
})
|
||||||
|
.then((response) => response.json())
|
||||||
|
.then(({ id, object, deleted }) => {
|
||||||
|
console.log(id)
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
<TabItem value="curl" label="cURL">
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
curl --location --request DELETE '<SERVER_URL>/admin/price-lists/<PRICE_LIST_ID>' \
|
||||||
|
--header 'Authorization: Bearer {api_token}'
|
||||||
|
```
|
||||||
|
|
||||||
|
</TabItem>
|
||||||
|
</Tabs>
|
||||||
|
|
||||||
|
This request returns the ID of the deleted price list.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn more about [price lists](./index.md).
|
||||||
|
- Learn how the [price selection strategy works](../price-selection-strategy/index.md).
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
# Price Selection Strategy
|
||||||
|
|
||||||
|
In this document, you’ll learn what a price selection strategy is.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
If you’re interested to learn how to override the price selection strategy, check out [this documentation](./override.md) instead.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## What's a Price Selection Strategy
|
||||||
|
|
||||||
|
Medusa provides many features and different ways to control the price of a product variant. This includes price lists and their different conditions, products’ original prices, and taxes.
|
||||||
|
|
||||||
|
Medusa uses the `PriceSelectionStrategy` class to retrieve the best price for a product variant for a specific context. This strategy is used whenever products and line items are retrieved or manipulated on the storefront.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## PriceSelectionStrategy Overview
|
||||||
|
|
||||||
|
The `PriceSelectionStrategy` class extends the `AbstractPriceSelectionStrategy` class. Its main method is the `calculateVariantPrice` which is used to retrieve a product variant’s price in a given context.
|
||||||
|
|
||||||
|
### calculateVariantPrice Method
|
||||||
|
|
||||||
|
Medusa uses this method to retrieve a product variant’s price when a product variant or line item is retrieved or manipulated. This includes when other entities that product variants and line items belong to are retrieved, such as products and carts respectively.
|
||||||
|
|
||||||
|
This method accepts two parameters:
|
||||||
|
|
||||||
|
1. The ID of the variant.
|
||||||
|
2. A [context](#context-object) object.
|
||||||
|
|
||||||
|
The method retrieves all the available prices of the variant based on the conditions in the context object.
|
||||||
|
|
||||||
|
It returns an object with the following properties:
|
||||||
|
|
||||||
|
1. `originalPrice`: The original price of the variant which depends on the selected region or currency code in the context object. If both region ID and currency code are available in the context object, the region has higher precedence.
|
||||||
|
2. `originalPriceIncludesTax`: A boolean value indicating whether the original price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md).
|
||||||
|
3. `calculatedPrice`: The lowest price among the prices of the product variant retrieved using the context object.
|
||||||
|
4. `calculatedPriceIncludesTax`: A boolean value indicating whether the calculated price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md).
|
||||||
|
5. `calculatedPriceType`: Either `default` if the `calculatedPrice` is the original price, or the type of the price list applied.
|
||||||
|
6. `prices`: an array of all the prices of the variant retrieved using the context object. It can include its original price and its price lists if there are any.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
You can learn more about price lists and how they’re used in [this documentation](../price-lists/index.md).
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Context Object
|
||||||
|
|
||||||
|
The context that is passed to the `calculateVariantPrice` method is an object that has the following optional properties:
|
||||||
|
|
||||||
|
- `cart_id`: The ID of the customer’s cart. This is used when the prices are being retrieved for the variant of a line item, as it is used to determine the current region and currency code of the context.
|
||||||
|
- `customer_id`: The ID of the customer. This is used to filter out price lists for a customer group that this customer doesn’t belong to.
|
||||||
|
- `quantity`: The quantity of the item in the cart. This is used to filter out price lists that have `min_quantity` or `max_quantity` conditions set.
|
||||||
|
- `region_id`: The ID of the region the customer is using.
|
||||||
|
- `currency_code`: The currency code the customer is using.
|
||||||
|
- `include_discount_prices`: A boolean value indicating whether price list prices should be retrieved or not.
|
||||||
|
- `tax_rates`: The tax rates to be applied. This is only used for [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn [how to override the price selection strategy](./override.md).
|
||||||
|
- Learn more about [price lists](./../price-lists/index.md).
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
# Override Price Selection Strategy
|
||||||
|
|
||||||
|
In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
If you’re interested in learning what a price selection strategy is and how it works, check out [this documentation](./index.md) instead.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## 1. Create Class
|
||||||
|
|
||||||
|
Create a TypeScript or JavaScript file in `src/strategies` of your Medusa server project with a class that extends the `AbstractPriceSelectionStrategy` class:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AbstractPriceSelectionStrategy, IPriceSelectionStrategy, PriceSelectionContext, PriceSelectionResult } from "@medusajs/medusa";
|
||||||
|
|
||||||
|
import { EntityManager } from "typeorm";
|
||||||
|
|
||||||
|
export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy {
|
||||||
|
|
||||||
|
withTransaction(manager: EntityManager): IPriceSelectionStrategy {
|
||||||
|
if (!manager) {
|
||||||
|
return this
|
||||||
|
}
|
||||||
|
|
||||||
|
return new MyPriceListStrategy()
|
||||||
|
}
|
||||||
|
|
||||||
|
async calculateVariantPrice(
|
||||||
|
variant_id: string,
|
||||||
|
context: PriceSelectionContext
|
||||||
|
): Promise<PriceSelectionResult> {
|
||||||
|
//TODO
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
You can use services or repositories in the strategy by adding them to the constructor and updating the parameters passed to the `MyPriceListStrategy` constructor in `withTransaction`. For example:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
export default class MyPriceListStrategy extends AbstractPriceSelectionStrategy {
|
||||||
|
private productsService: ProductService
|
||||||
|
|
||||||
|
constructor({
|
||||||
|
productsService
|
||||||
|
}) {
|
||||||
|
super()
|
||||||
|
this.productsService = productsService
|
||||||
|
}
|
||||||
|
|
||||||
|
withTransaction(manager: EntityManager): IPriceSelectionStrategy {
|
||||||
|
if (!manager) {
|
||||||
|
return this
|
||||||
|
}
|
||||||
|
|
||||||
|
return new MyPriceListStrategy({
|
||||||
|
productsService: this.productsService
|
||||||
|
})
|
||||||
|
}
|
||||||
|
//...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Implement calculateVariantPrice
|
||||||
|
|
||||||
|
Implement the price selection strategy you want inside the `calculateVariantPrice` method.
|
||||||
|
|
||||||
|
This method accepts the variant ID as a first parameter and the [context](./index.md#context-object) object as a second parameter.
|
||||||
|
|
||||||
|
This method must return an object having the following fields:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
originalPrice, //number | null
|
||||||
|
calculatedPrice, //number | null
|
||||||
|
prices // MoneyAmount[]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
You can learn more about optional properties and the meaning behind every property [here](./index.md#calculatevariantprice-method).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Run Build Command
|
||||||
|
|
||||||
|
In your terminal, run the build command to transpile the files in the `src` directory into the `dist` directory:
|
||||||
|
|
||||||
|
```bash npm2yarn
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Test it Out
|
||||||
|
|
||||||
|
Run your server to test it out:
|
||||||
|
|
||||||
|
```bash npm2yarn
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, try out your strategy using any of the [Products](https://docs.medusajs.com/api/store/#tag/Product) or [Carts](https://docs.medusajs.com/api/store/#tag/Cart) endpoints which include retrieving product variants and line items respectively. You should then see the prices in the response based on your implemented strategy.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn more about [price list selection strategy](./index.md).
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
In this document, you'll learn about what Services are in Medusa.
|
In this document, you'll learn about what Services are in Medusa.
|
||||||
|
|
||||||
## What are Services?
|
## What are Services
|
||||||
|
|
||||||
Services in Medusa represent bundled helper methods that you want to use across your server. By convention, they represent a certain entity or functionality in your server.
|
Services in Medusa represent bundled helper methods that you want to use across your server. By convention, they represent a certain entity or functionality in your server.
|
||||||
|
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ constructor({}, options) {
|
|||||||
|
|
||||||
When the admin is creating shipping options available for customers during checkout, they choose one of the fulfillment options provided by underlying fulfillment providers.
|
When the admin is creating shipping options available for customers during checkout, they choose one of the fulfillment options provided by underlying fulfillment providers.
|
||||||
|
|
||||||
For example, if you’re integrating UPS as a fulfillment provider, you might support 2 fulfillment options: UPS Express Shipping and UPS Access Point.
|
For example, if you’re integrating UPS as a fulfillment provider, you might support two fulfillment options: UPS Express Shipping and UPS Access Point.
|
||||||
|
|
||||||
These fulfillment options are defined in the `getFulfillmentOptions` method. This method should return an array of options.
|
These fulfillment options are defined in the `getFulfillmentOptions` method. This method should return an array of options.
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ When the customer chooses a shipping option on checkout, the shipping option and
|
|||||||
|
|
||||||
`validateFulfillmentOption` is called when a `POST` request is sent to [`/carts/:id/shipping-methods`](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod).
|
`validateFulfillmentOption` is called when a `POST` request is sent to [`/carts/:id/shipping-methods`](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod).
|
||||||
|
|
||||||
This method accepts 3 parameters:
|
This method accepts three parameters:
|
||||||
|
|
||||||
1. The shipping option data.
|
1. The shipping option data.
|
||||||
2. The `data` object passed in the body of the request.
|
2. The `data` object passed in the body of the request.
|
||||||
@@ -156,7 +156,7 @@ After an order is placed, it can be fulfilled either manually by the admin or us
|
|||||||
|
|
||||||
This method gives you access to the fulfillment being created as well as other details in case you need to perform any additional actions with the third-party provider.
|
This method gives you access to the fulfillment being created as well as other details in case you need to perform any additional actions with the third-party provider.
|
||||||
|
|
||||||
This method accepts 4 parameters:
|
This method accepts four parameters:
|
||||||
|
|
||||||
1. The data of the shipping method associated with the order.
|
1. The data of the shipping method associated with the order.
|
||||||
2. An array of items in the order to be fulfilled. The admin can choose all or some of the items to fulfill.
|
2. An array of items in the order to be fulfilled. The admin can choose all or some of the items to fulfill.
|
||||||
@@ -210,7 +210,7 @@ canCalculate(data) {
|
|||||||
|
|
||||||
This method is called on checkout when the shipping method is being created if the `price_type` of the selected shipping option is `calculated`.
|
This method is called on checkout when the shipping method is being created if the `price_type` of the selected shipping option is `calculated`.
|
||||||
|
|
||||||
This method receives 3 parameters:
|
This method receives three parameters:
|
||||||
|
|
||||||
1. The `data` parameter of the selected shipping option.
|
1. The `data` parameter of the selected shipping option.
|
||||||
2. The `data` parameter sent with [the request](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod).
|
2. The `data` parameter sent with [the request](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod).
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
# Shipping Architecture Overview
|
# Shipping Architecture Overview
|
||||||
|
|
||||||
This document gives an overview of the shipping architecture and its 4 most important components.
|
This document gives an overview of the shipping architecture and its four most important components.
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
In Medusa, the Shipping architecture relies on 4 components: **Fulfillment Provider**, **Shipping Profiles**, **Shipping Options**, and **Shipping Methods**.
|
In Medusa, the Shipping architecture relies on 4 components: **Fulfillment Provider**, **Shipping Profiles**, **Shipping Options**, and **Shipping Methods**.
|
||||||
|
|
||||||
The distinction between the 4 is important. It has been carefully planned and put together to support all the different ecommerce use cases and shipping providers that can be integrated.
|
The distinction between the four is important. It has been carefully planned and put together to support all the different ecommerce use cases and shipping providers that can be integrated.
|
||||||
|
|
||||||
It’s also constructed to support multiple regions, provide different shipment configurations and options for different product types, provide promotional shipments for your customers, and much more.
|
It’s also constructed to support multiple regions, provide different shipment configurations and options for different product types, provide promotional shipments for your customers, and much more.
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ It is assumed you’re already familiar with [Subscribers in Medusa and how to l
|
|||||||
|
|
||||||
## Legend
|
## Legend
|
||||||
|
|
||||||
Events in this document are listed under the entity they’re associated with. They’re listed in a table of 3 columns:
|
Events in this document are listed under the entity they’re associated with. They’re listed in a table of three columns:
|
||||||
|
|
||||||
1. **Event Name:** The name you use to subscribe a handler for the event.
|
1. **Event Name:** The name you use to subscribe a handler for the event.
|
||||||
2. **Description:** When this event is triggered.
|
2. **Description:** When this event is triggered.
|
||||||
@@ -1687,13 +1687,12 @@ This section holds all events related to sales channels.
|
|||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
As of Medusa v1.3.5, Sales Channels are available but guarded by a feature flag. To use Sales Channels, add the following environment variable:
|
As of Medusa v1.3.5, Sales Channels are available but guarded by a feature flag. To use Sales Channels either:
|
||||||
|
|
||||||
```bash
|
1. Enable the `MEDUSA_FF_SALES_CHANNELS` environment variable;
|
||||||
MEDUSA_FF_SALES_CHANNELS=true
|
2. Or enable the `sales_channels` key in the Medusa server's settings.
|
||||||
```
|
|
||||||
|
|
||||||
Then, run the [migrations](../migrations/overview.md#how-to-run-migrations).
|
You can learn more about enabling it in the [feature flags](../feature-flags/toggle.md) documentation.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
In this document, you'll learn what Subscribers are in Medusa.
|
In this document, you'll learn what Subscribers are in Medusa.
|
||||||
|
|
||||||
## What are Events?
|
## What are Events
|
||||||
|
|
||||||
In Medusa, there are events that are emitted when a certain action occurs. For example, if a customer places an order, the `order.placed` event is emitted with the order data.
|
In Medusa, there are events that are emitted when a certain action occurs. For example, if a customer places an order, the `order.placed` event is emitted with the order data.
|
||||||
|
|
||||||
@@ -10,7 +10,7 @@ The purpose of these events is to allow other parts of the platform, or third-pa
|
|||||||
|
|
||||||
Medusa's queuing and events system is handled by Redis. So, you must have [Redis configured](../../../tutorial/0-set-up-your-development-environment.mdx#redis) on your server to use subscribers.
|
Medusa's queuing and events system is handled by Redis. So, you must have [Redis configured](../../../tutorial/0-set-up-your-development-environment.mdx#redis) on your server to use subscribers.
|
||||||
|
|
||||||
## What are Subscribers?
|
## What are Subscribers
|
||||||
|
|
||||||
Subscribers register handlers for an events and allows you to perform an action when that event occurs. For example, if you want to send your customer an email when they place an order, then you can listen to the `order.placed` event and send the email when the event is emitted.
|
Subscribers register handlers for an events and allows you to perform an action when that event occurs. For example, if you want to send your customer an email when they place an order, then you can listen to the `order.placed` event and send the email when the event is emitted.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,193 @@
|
|||||||
|
# Tax Inclusive Pricing
|
||||||
|
|
||||||
|
In this document, you’ll learn how tax-inclusive pricing works in Medusa.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
Tax Inclusive Pricing is currently in beta mode and guarded by a feature flag. To use Tax-Inclusive Pricing either:
|
||||||
|
|
||||||
|
1. Enable the `MEDUSA_FF_TAX_INCLUSIVE_PRICING` environment variable;
|
||||||
|
2. Or enable the `tax_inclusive_pricing` key in the Medusa server's settings.
|
||||||
|
|
||||||
|
You can learn more about enabling it in the [feature flags](../feature-flags/toggle.md) documentation.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
Tax Inclusive pricing allows you to set the final prices for products and shipping options regardless of the customer's applicable tax rates. When tax-inclusive prices are used, Medusa automatically calculates the tax amount for a given price.
|
||||||
|
|
||||||
|
This can be useful when some countries have the same currency but have different tax rates. If you want your prices to be the same across these countries, you have to manage two price lists to account for the tax differences. Using tax-inclusive pricing you only have to specify the price once.
|
||||||
|
|
||||||
|
Then, Medusa handles calculating the tax amount using the tax rate and the tax-inclusive price. This is managed in the backend and relayed to accounting and analytics tools.
|
||||||
|
|
||||||
|
## How is Tax Inclusivity Defined
|
||||||
|
|
||||||
|
Tax inclusivity can be toggled for regions, currencies, price lists, and shipping options either during creation or while editing. This is represented by the boolean attribute `includes_tax` available in the entities `Region`, `Currency`, `PriceList`, and `ShippingOption`. By default, this attribute is set to `false`.
|
||||||
|
|
||||||
|
If you want to enable or disable this attribute for any of these entities, you can use the create or update endpoints related to these entities as shown in the [Admin API reference](https://docs.medusajs.com/api/admin/).
|
||||||
|
|
||||||
|
The value set for these entities can affect whether line items and shipping methods are tax inclusive or not.
|
||||||
|
|
||||||
|
### How is Tax Inclusivity Defined for Line Items
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
When a product is added to the cart, a line item is created to represent that product in the cart.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
The `LineItem` entity also has the `includes_tax` attribute. The value of this flag is set to `true` if:
|
||||||
|
|
||||||
|
- The region of the line item has the `includes_tax` attribute set to `true`;
|
||||||
|
- Or the currency of the line item has the `includes_tax` attribute set to `true`;
|
||||||
|
- Or a price list that includes the product variant associated with the line item has the `includes_tax` attribute set to `true`, and the tax-inclusive amount of one of the variant’s prices in the price list is less than the original price of the variant;
|
||||||
|
- Or one of the variant’s prices in the price list uses a currency or region that has the `includes_tax` attribute set to `true`, and the tax-inclusive amount of the price is less than the original price of the variant.
|
||||||
|
|
||||||
|
### How is Tax Inclusivity Defined for Shipping Methods
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
When a shipping option is selected, a shipping method is created based on that shipping option. You can learn more about this in the [Shipping Architecture documentation](../shipping/overview.md).
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
The `ShippingMethod` entity also has the `includes_tax` attribute. Its value is the same as the value of `includes_tax` of the shipping option the method is associated with.
|
||||||
|
|
||||||
|
## Tax Amount Calculation Formula
|
||||||
|
|
||||||
|
When a price is tax-inclusive, the tax amount is calculated using the following formula:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
const taxAmount = (taxRate * taxInclusivePrice) / (1 + taxRate)
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `taxRate` is the tax rate to be applied to the price, and `taxInclusivePrice` is the price entered by the store operator.
|
||||||
|
|
||||||
|
For example, if the tax rate is `0.25` and the price of a product is `100`, the resulting tax amount calculated by Medusa will be `0.25 * 100 / 1.25 = 20`.
|
||||||
|
|
||||||
|
## Retrieving Tax Amounts
|
||||||
|
|
||||||
|
This section covers at which point tax amounts are calculated for different entities, how they are calculated when the price is tax inclusive, and what fields can be returned in the endpoints relative to each of the entities.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
If you have disabled the automatic calculation of taxes in a region, you must [manually calculate the taxes of the line items and the cart](manual-calculation.md). Otherwise, taxes will not be calculated or retrieved during checkout for each entity mentioned here.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Products
|
||||||
|
|
||||||
|
Taxes are calculated for each product variant either when a [single product is retrieved](https://docs.medusajs.com/api/store/#tag/Product/operation/GetProductsProduct) or a [list of products is retrieved](https://docs.medusajs.com/api/store/#tag/Product/operation/GetProducts).
|
||||||
|
|
||||||
|
Among the pricing fields retrieved for each variant, the following fields are relevant to taxes:
|
||||||
|
|
||||||
|
- `original_price`: The original price of the variant.
|
||||||
|
- `calculated_price`: The calculated price, which can be based on prices defined in a price list.
|
||||||
|
- `original_tax`: The tax amount applied to the original price.
|
||||||
|
- `calculated_tax`: The tax amount applied to the calculated price.
|
||||||
|
- `original_price_incl_tax`: The price after applying the tax amount on the original price.
|
||||||
|
- `calculated_price_incl_tax`: The price after applying the tax amount on the calculated price
|
||||||
|
- `original_price_includes_tax`: a boolean value indicating whether the amount in `original_price` includes the tax amount by default or not.
|
||||||
|
- `calculated_price_includes_tax`: a boolean value indicating whether the amount in `calculated_price` includes the tax amount by default or not.
|
||||||
|
|
||||||
|
If tax inclusivity is enabled for the current region or currency (based on whether the default price is specified for the region or currency, with region taking a higher precedence):
|
||||||
|
|
||||||
|
- `original_price` will include the tax amount by default.
|
||||||
|
- `original_price_includes_tax` will be set to `true`.
|
||||||
|
- `original_price_incl_tax` will have the same amount as `original_price`.
|
||||||
|
- `original_tax` is automatically calculated by Medusa.
|
||||||
|
|
||||||
|
Also, for each of the product variant’s prices in a price list, if tax inclusivity is enabled (either if the price list itself has the `includes_tax` attribute set to `true`, or the variant’s price in the price list uses a currency or region that has the `includes_tax` attribute set to `true`), and the amount of the price is less than the original price of the variant:
|
||||||
|
|
||||||
|
- `calculated_tax` will include the tax amount by default.
|
||||||
|
- `calculated_price_includes_tax` will be set to `true`.
|
||||||
|
- `calculated_price_incl_tax` will have the same amount as `calculated_price`.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
Price lists include a list of prices that can be used to override the original price of a product’s variants.
|
||||||
|
|
||||||
|
Each variant’s price in the price list is compared to the variant’s original price using the following condition:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
amount < (1 + taxRate) * calculatedPrice
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `amount` is the amount of the variant’s price in the price list, `taxRate` is the applied rate, and `calculatedPrice` is the original price of the variant.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
Here is an example of these fields when tax inclusivity is enabled for both the currency and the price list:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
{
|
||||||
|
original_price: 110,
|
||||||
|
calculated_price: 100,
|
||||||
|
calculated_price_type: "sale",
|
||||||
|
original_price_includes_tax: true,
|
||||||
|
calculated_price_includes_tax: true,
|
||||||
|
calculated_price_incl_tax: 100,
|
||||||
|
calculated_tax: 20,
|
||||||
|
original_price_incl_tax: 110,
|
||||||
|
original_tax: 22,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Line Item
|
||||||
|
|
||||||
|
The taxes of line items are calculated and retrieved whenever the [cart is retrieved or updated](https://docs.medusajs.com/api/store/#tag/Cart).
|
||||||
|
|
||||||
|
Each line item returned in any of the cart’s requests has total fields related to the price of the line item and its taxes. Among those fields, the following are relevant to tax-inclusive pricing:
|
||||||
|
|
||||||
|
- `unit_price`: The original price of the variant associated with the line item.
|
||||||
|
- `tax_total`: The total tax amount applied on the original price taking into account any applied discounts as well.
|
||||||
|
- `original_tax_total`: The total tax amount applied on the original price without taking into account any applied discounts.
|
||||||
|
- `subtotal`: The total of the line item’s price subtracting the amount in `original_tax_total`.
|
||||||
|
- `origial_total`: The `subtotal` including the `original_tax_total` amount.
|
||||||
|
|
||||||
|
If tax inclusivity is enabled for the line item, `unit_price` will include the tax amount. The tax amount, which will also be the value of `tax_total`, is calculated using [Medusa’s formula for tax inclusive pricing](#tax-amount-calculation-formula) based on the line item’s tax rates. The calculation takes into account any discounts applied on the item, which means the discount amount is deducted from the original price.
|
||||||
|
|
||||||
|
Then, the `subtotal` is calculated by subtracting the `tax_total` from the total of the line item’s price. `original_total` has the same value as `subtotal`.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
|
||||||
|
The total of the line item’s price is the variant’s `unit_price` multiplied by its quantity in the cart.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
Finally, `original_tax_total` undergoes the same `tax_total` calculation, however, any discounts applied on the line item are not taken into account. This means the discount amount is not deducted from the original price.
|
||||||
|
|
||||||
|
### Shipping Options
|
||||||
|
|
||||||
|
Taxes for Shipping Options are calculated and retrieved when the [list of shipping options is retrieved](https://docs.medusajs.com/api/store/#tag/Shipping-Option).
|
||||||
|
|
||||||
|
Among the returned fields for each shipping option, the following are relevant to each of their pricing and taxes:
|
||||||
|
|
||||||
|
- `amount`: The original price of the shipping option.
|
||||||
|
- `price_incl_tax`: The price of the shipping option with tax included.
|
||||||
|
- `tax_amount`: The tax amount applied to the shipping option.
|
||||||
|
|
||||||
|
If tax inclusivity is enabled for the shipping option, `amount` and `price_incl_tax` have the same value. Also, the value of `tax_amount` is calculated using [Medusa’s formula for tax inclusive pricing](#tax-amount-calculation-formula).
|
||||||
|
|
||||||
|
### Carts and Orders
|
||||||
|
|
||||||
|
Carts and Orders have the same total fields relevant for taxes.
|
||||||
|
|
||||||
|
A cart’s totals, including its taxes, are calculated and retrieved whenever the cart is [updated or retrieved](https://docs.medusajs.com/api/store/#tag/Cart).
|
||||||
|
|
||||||
|
An order’s totals, including its taxes, are calculated and retrieved whenever the order is retrieved both on the [storefront](https://docs.medusajs.com/api/store/#tag/Order) and on the [admin](https://docs.medusajs.com/api/admin/#tag/Order).
|
||||||
|
|
||||||
|
The relevant fields are:
|
||||||
|
|
||||||
|
- `shipping_total`: The total tax-exclusive price of the shipping methods used in the cart or order without any applied taxes.
|
||||||
|
- `tax_total`: The total of the taxes applied on the cart or order, including taxes applied on line items and shipping methods.
|
||||||
|
- `subtotal`: The subtotal of line items including taxes, but without shipping total.
|
||||||
|
- `total`: The total of the cart or order, including the subtotal, shipping total, and taxes applied.
|
||||||
|
|
||||||
|
During the calculation of the totals of different components of the cart or order, such as shipping or line items, if tax inclusivity is enabled on that component, a process similar to those explained above will be applied to retrieve the total.
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn how to [calculate taxes manually](manual-calculation.md).
|
||||||
|
- [Check out the API reference](https://docs.medusajs.com/api/store/).
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
# Calculate Taxes Manually in Checkout
|
||||||
|
|
||||||
|
In this document, you’ll learn how to manually calculate taxes during checkout if you have automatic tax calculation disabled in a region.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
By default, taxes are automatically calculated by Medusa during checkout. This behavior can be disabled for a region using the Admin APIs or the Medusa admin to limit the requests being sent to a tax provider.
|
||||||
|
|
||||||
|
If you disable this behavior, you must manually trigger taxes calculation. When taxes are calculated, this means that requests will be sent to the tax provider to retrieve the tax rates.
|
||||||
|
|
||||||
|
## How to Manually Calculate Taxes in Checkout
|
||||||
|
|
||||||
|
This section explores different ways you can calculate taxes based on your purpose.
|
||||||
|
|
||||||
|
### Use Calculate Cart Taxes Endpoint
|
||||||
|
|
||||||
|
The [Calculate Cart Taxes](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartTaxes) endpoint forces the calculation of taxes for a cart during checkout. This bypasses the option set in admin to not calculate taxes automatically, which results in sending requests to the tax provider.
|
||||||
|
|
||||||
|
This calculates and retrieves the taxes on the cart and each of the line items in that cart.
|
||||||
|
|
||||||
|
### Use CartService
|
||||||
|
|
||||||
|
The `CartService` class has a method `retrieve` that gets a cart by ID. In that method, taxes are calculated only if automatic taxes calculation is enabled for the region the cart belongs to.
|
||||||
|
|
||||||
|
You can, however, force calculating the taxes of the cart by passing in the third parameter an option containing the key `force_taxes` with its value set to `true`.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
cartService.retrieve('cart_01G8Z...', { }, { force_taxes: true });
|
||||||
|
```
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
You can learn how to [retrieve and use services](../services/create-service.md#using-your-custom-service) in this documentation.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Use decorateLineItemsWithTotals function in Endpoints
|
||||||
|
|
||||||
|
If you want to calculate the taxes of line items on the storefront in an endpoint and return the necessary fields in the result, you can use the `decorateLineItemsWithTotals` method in your endpoint:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
//at the beginning of the file
|
||||||
|
import { decorateLineItemsWithTotals } from "@medusajs/medusa/dist/api/routes/store/carts/decorate-line-items-with-totals"
|
||||||
|
|
||||||
|
export default () => {
|
||||||
|
//...
|
||||||
|
|
||||||
|
router.get("/store/line-taxes", async (req, res) => {
|
||||||
|
//example of retrieving cart
|
||||||
|
const cartService = req.scope.resolve("cartService");
|
||||||
|
const cart = await cartService.retrieve(cart_id)
|
||||||
|
|
||||||
|
//...
|
||||||
|
//retrieve taxes of line items
|
||||||
|
const data = await decorateLineItemsWithTotals(cart, req, {
|
||||||
|
force_taxes: true
|
||||||
|
});
|
||||||
|
|
||||||
|
return res.status(200).json({ cart: data });
|
||||||
|
})
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `decorateLineItemsWithTotals` method accepts an options object as a third parameter. If you set `force_taxes` to `true` in that object, the totals of the line items can be retrieved regardless of whether the automatic calculation is enabled in the line item’s region.
|
||||||
|
|
||||||
|
### Use TotalsService
|
||||||
|
|
||||||
|
You can calculate and retrieve taxes of line items using the `getLineItemTotals` method available in the `TotalService` class. All you need to do is pass in the third argument to that method an options object with the key `include_tax` set to true:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
const itemTotals = await totalsService
|
||||||
|
.getLineItemTotals(item, cart, {
|
||||||
|
include_tax: true
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
You can learn how to [retrieve and use services](../services/create-service.md#using-your-custom-service) in this documentation.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## What’s Next 🚀
|
||||||
|
|
||||||
|
- Learn about [tax-inclusive pricing](inclusive-pricing.md).
|
||||||
|
- Learn about available methods in [CartsService](../../../references/services/classes/CartService.md) and [TotalsService](../../../references/services/classes/TotalsService.md).
|
||||||
@@ -4,7 +4,7 @@ Following the addition of feature flags in version v1.3.3 and the addition of th
|
|||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
In version 1.3.6, Sales Channels are available but hidden behind feature flags. If you don’t have Sales Channels enabled, you don’t need to follow the steps detailed in this migration script.
|
In version 1.3.6, Sales Channels are available but guraded by [feature flags](../feature-flags/toggle.md). If you don’t have Sales Channels enabled, you don’t need to follow the steps detailed in this migration script.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@ These environment variables are used in the data migration scripts in this upgra
|
|||||||
|
|
||||||
## Sales Channels
|
## Sales Channels
|
||||||
|
|
||||||
Sales Channels were introduced in v1.3.5 behind a feature flag. By enabling Sales Channels, developers and users can associate products and other entities with a specific Sales Channel.
|
Sales Channels were introduced in v1.3.5 guarded by a [feature flag](../feature-flags/toggle.md). By enabling Sales Channels, developers and users can associate products and other entities with a specific Sales Channel.
|
||||||
|
|
||||||
However, if you upgraded Medusa to v1.3.5 and enabled Sales Channels, you must add every product to at least one Sales Channel manually. Otherwise, products can’t be added to carts in different Sales Channels.
|
However, if you upgraded Medusa to v1.3.5 and enabled Sales Channels, you must add every product to at least one Sales Channel manually. Otherwise, products can’t be added to carts in different Sales Channels.
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ Updating your medusa server to version `1.3.8` may cause issues when using NPM.
|
|||||||
|
|
||||||
## Update Using Yarn
|
## Update Using Yarn
|
||||||
|
|
||||||
We highly recommend using [yarn](https://yarnpkg.com/) when working with Medusa. Updating with yarn should resolve any issues you might run into during the update.
|
It's highly recommended to use [yarn](https://yarnpkg.com/) when working with Medusa. Updating with yarn should resolve any issues you might run into during the update.
|
||||||
|
|
||||||
## Resolving Update Issues with NPM
|
## Resolving Update Issues with NPM
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ This document will guide you through the steps needed to implement the checkout
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
A checkout flow is composed of the necessary steps to allow a customer to perform a successful checkout. It’s generally made up of 2 primary steps: the shipping and payment steps.
|
A checkout flow is composed of the necessary steps to allow a customer to perform a successful checkout. It’s generally made up of two primary steps: the shipping and payment steps.
|
||||||
|
|
||||||
This document will take you through the general process of a checkout flow. You should follow along with this document if you’re creating a custom storefront, if you’re adding a custom payment provider, or if you’re just interested in learning more about how checkout works in Medusa.
|
This document will take you through the general process of a checkout flow. You should follow along with this document if you’re creating a custom storefront, if you’re adding a custom payment provider, or if you’re just interested in learning more about how checkout works in Medusa.
|
||||||
|
|
||||||
|
|||||||
@@ -41,20 +41,28 @@ If you’re fixing errors in an existing documentation page, you can scroll down
|
|||||||
|
|
||||||
If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done creating a PR in the Medusa repository.
|
If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done creating a PR in the Medusa repository.
|
||||||
|
|
||||||
For more details on how to contribute, check out [the contribution guidelines on our repository](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md).
|
For more details on how to contribute, check out [the contribution guidelines in the Medusa repository](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md).
|
||||||
|
|
||||||
### Branch Name
|
### Base Branch
|
||||||
|
|
||||||
When you make edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch.
|
When you make edit to an existing documentation page or fork the repository to make changes to the documentation, you have to create a new branch.
|
||||||
|
|
||||||
|
Documentation contributions always use `master` as the base branch.
|
||||||
|
|
||||||
|
### Branch Name
|
||||||
|
|
||||||
Make sure that the branch name starts with `docs/`. For example, `docs/fix-services`.
|
Make sure that the branch name starts with `docs/`. For example, `docs/fix-services`.
|
||||||
|
|
||||||
### Pull Request Conventions
|
### Pull Request Conventions
|
||||||
|
|
||||||
When you create a pull request, prefix the title with “docs:”. Make sure to keep “docs” in small letters.
|
When you create a pull request, prefix the title with “docs:”. Make sure to keep “docs” in small letters.
|
||||||
|
|
||||||
|
<!-- vale off -->
|
||||||
|
|
||||||
In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, “Closes #1333”.
|
In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, “Closes #1333”.
|
||||||
|
|
||||||
|
<!-- vale on -->
|
||||||
|
|
||||||
## Sidebar
|
## Sidebar
|
||||||
|
|
||||||
When you add a new page to the documentation, you must add the new page in `www/docs/sidebars.js` under the `docsSidebar`. You can learn more about the syntax used [here](https://docusaurus.io/docs/sidebar/items).
|
When you add a new page to the documentation, you must add the new page in `www/docs/sidebars.js` under the `docsSidebar`. You can learn more about the syntax used [here](https://docusaurus.io/docs/sidebar/items).
|
||||||
@@ -101,14 +109,22 @@ The code snippet must be written using NPM, and the `npm2yarn` plugin will autom
|
|||||||
|
|
||||||
### Expand Commands
|
### Expand Commands
|
||||||
|
|
||||||
|
<!-- vale off -->
|
||||||
|
|
||||||
Don't use commands in their abbrivated terms. For example, instead of `npm i` use `npm install`.
|
Don't use commands in their abbrivated terms. For example, instead of `npm i` use `npm install`.
|
||||||
|
|
||||||
|
<!-- vale on -->
|
||||||
|
|
||||||
### Run Command
|
### Run Command
|
||||||
|
|
||||||
Make sure to always use the `run` command when the command runs a script.
|
Make sure to always use the `run` command when the command runs a script.
|
||||||
|
|
||||||
|
<!-- vale off -->
|
||||||
|
|
||||||
For example, even though you can run the `start` script using NPM with `npm start`, however, to make sure it’s transformed properly to a Yarn command, you must add the `run` keyword before `start`.
|
For example, even though you can run the `start` script using NPM with `npm start`, however, to make sure it’s transformed properly to a Yarn command, you must add the `run` keyword before `start`.
|
||||||
|
|
||||||
|
<!-- vale on -->
|
||||||
|
|
||||||
### Global Option
|
### Global Option
|
||||||
|
|
||||||
When a command uses the global option `-g`, add it at the end of the NPM command to ensure that it’s transformed to a Yarn command properly. For example:
|
When a command uses the global option `-g`, add it at the end of the NPM command to ensure that it’s transformed to a Yarn command properly. For example:
|
||||||
@@ -117,6 +133,59 @@ When a command uses the global option `-g`, add it at the end of the NPM command
|
|||||||
npm install @medusajs/medusa-cli -g
|
npm install @medusajs/medusa-cli -g
|
||||||
```
|
```
|
||||||
|
|
||||||
## Need Additional Help?
|
## Linting with Vale
|
||||||
|
|
||||||
If you need any additional help while contributing, you can join our [Discord server](https://discord.gg/medusajs) and ask Medusa’s core team as well as the community any questions.
|
Medusa uses Vale to lint documentation pages and perform checks on incoming PRs into the repository.
|
||||||
|
|
||||||
|
### Result of PR Checks
|
||||||
|
|
||||||
|
You can check the result of running the "lint" action on your PR by clicking the Details link next to it. You can find there all errors that you need to fix.
|
||||||
|
|
||||||
|
### Run Vale Locally
|
||||||
|
|
||||||
|
If you want to check your work locally, you can do that by:
|
||||||
|
|
||||||
|
1. [Installing Vale](https://vale.sh/docs/vale-cli/installation/) on your machine.
|
||||||
|
2. Change to the `docs` directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd docs
|
||||||
|
```
|
||||||
|
|
||||||
|
3\. Run the `run-vale` script:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./run-vale.sh error
|
||||||
|
```
|
||||||
|
|
||||||
|
### VS Code Extension
|
||||||
|
|
||||||
|
To facilitate writing documentation, you can optionally use the [Vale VS Code extension](https://github.com/errata-ai/vale-vscode). This will show you any errors in your documentation while writing it.
|
||||||
|
|
||||||
|
### Linter Exceptions
|
||||||
|
|
||||||
|
If it's needed to break some style guide rules in a document, you can wrap the parts that the linter shouldn't scan with the following comments in the `md` or `mdx` files:
|
||||||
|
|
||||||
|
```md
|
||||||
|
<!-- vale off -->
|
||||||
|
|
||||||
|
content that shouldn't be scanned for errors here...
|
||||||
|
|
||||||
|
<!-- vale on -->
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also disable specific rules. For example:
|
||||||
|
|
||||||
|
```md
|
||||||
|
<!-- vale docs.Numbers = NO -->
|
||||||
|
|
||||||
|
Medusa supports Node versions 14 and 16.
|
||||||
|
|
||||||
|
<!-- vale docs.Numbers = YES -->
|
||||||
|
```
|
||||||
|
|
||||||
|
If you use this in your PR, you must justify its usage.
|
||||||
|
|
||||||
|
## Need Additional Help
|
||||||
|
|
||||||
|
If you need any additional help while contributing, you can join Medusa's [Discord server](https://discord.gg/medusajs) and ask Medusa’s core team as well as the community any questions.
|
||||||
@@ -98,7 +98,7 @@ In the form that shows, keep all fields the same and click on the “Show advanc
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Under the “Advanced build settings” section click on the “New variable” button. This will show 2 inputs for the key and value of the environment variable.
|
Under the “Advanced build settings” section click on the “New variable” button. This will show two inputs for the key and value of the environment variable.
|
||||||
|
|
||||||
For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server.
|
For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server.
|
||||||
|
|
||||||
@@ -128,7 +128,7 @@ If you click on it, you’ll be redirected to the deployed admin website.
|
|||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. Follow along in the [Configure CORS on the Medusa Server](#configure-cors-variable-on-the-medusa-server) section.
|
Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. Follow along in the [Configure Cross-Origin Resource Sharing (CORS) on the Medusa Server](#configure-cors-variable-on-the-medusa-server) section.
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@@ -168,7 +168,7 @@ In your terminal, run the following command:
|
|||||||
netlify init
|
netlify init
|
||||||
```
|
```
|
||||||
|
|
||||||
You’ll have to follow 5 steps for the initialization:
|
You’ll have to follow five steps for the initialization:
|
||||||
|
|
||||||
##### **Step 1: Create Netlify Website**
|
##### **Step 1: Create Netlify Website**
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ DigitalOcean is a reliable hosting provider that provides different ways to host
|
|||||||
|
|
||||||
### Medusa Server
|
### Medusa Server
|
||||||
|
|
||||||
It is assumed that you already have a Medusa server installed locally. If you don’t, please follow our [quickstart guide](../../quickstart/quick-start.md).
|
It is assumed that you already have a Medusa server installed locally. If you don’t, please follow the [quickstart guide](../../quickstart/quick-start.md).
|
||||||
|
|
||||||
Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.
|
Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.
|
||||||
|
|
||||||
@@ -163,7 +163,7 @@ Once you’re done, click Next to move on to the next step.
|
|||||||
|
|
||||||
In this section, you’ll add environment variables that are essential to your Medusa server.
|
In this section, you’ll add environment variables that are essential to your Medusa server.
|
||||||
|
|
||||||
You should see 2 ways to add environment variables: Global or specific to the Web Service.
|
You should see two ways to add environment variables: Global or specific to the Web Service.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -263,7 +263,7 @@ Make sure to replace `<EMAIL>` and `<PASSWORD>` with the credentials you want to
|
|||||||
|
|
||||||
## Add Environment Variables
|
## Add Environment Variables
|
||||||
|
|
||||||
You’ll likely need to add environment variables later such as Admin CORS and Store CORS variables.
|
You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.
|
||||||
|
|
||||||
To add environment variables, on the App’s page click on Settings and choose the Web Service component.
|
To add environment variables, on the App’s page click on Settings and choose the Web Service component.
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ Alternatively, you can use this button to deploy the Medusa server to Heroku dir
|
|||||||
|
|
||||||
### Medusa Server
|
### Medusa Server
|
||||||
|
|
||||||
It is assumed that you already have a Medusa server installed locally. If you don’t, please follow our [quickstart guide](../../quickstart/quick-start.md).
|
It is assumed that you already have a Medusa server installed locally. If you don’t, please follow the [quickstart guide](../../quickstart/quick-start.md).
|
||||||
|
|
||||||
Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.
|
Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.
|
||||||
|
|
||||||
@@ -135,7 +135,7 @@ heroku buildpacks:set heroku/nodejs
|
|||||||
|
|
||||||
Upstash adds the Redis URL under the environment variable `UPSTASH_REDIS_URL`. However, Medusa looks for the `REDIS_URL` environment variable when initializing the connection with Redis.
|
Upstash adds the Redis URL under the environment variable `UPSTASH_REDIS_URL`. However, Medusa looks for the `REDIS_URL` environment variable when initializing the connection with Redis.
|
||||||
|
|
||||||
So, retrieve the value of `UPSTASH_REDIS_URL` with the following command:
|
Retrieve the value of `UPSTASH_REDIS_URL` with the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
heroku config:get UPSTASH_REDIS_URL
|
heroku config:get UPSTASH_REDIS_URL
|
||||||
@@ -153,7 +153,7 @@ Where `<YOUR_REDIS_URL>` is the value you received from the previous command.
|
|||||||
|
|
||||||
#### Configure the PostgreSQL Database URL
|
#### Configure the PostgreSQL Database URL
|
||||||
|
|
||||||
If you're using the Heroku PostgreSQL Add-on, it should configure the environment variable `DATABASE_URL`. So, you don't need to perform any additional actions.
|
If you're using the Heroku PostgreSQL Add-on, it should configure the environment variable `DATABASE_URL`. In that case, you don't need to perform any additional actions.
|
||||||
|
|
||||||
However, if you use another add-on, make sure to set the environment variable `DATABASE_URL` to the PostgreSQL Database URL.
|
However, if you use another add-on, make sure to set the environment variable `DATABASE_URL` to the PostgreSQL Database URL.
|
||||||
|
|
||||||
@@ -270,7 +270,7 @@ Where `<APP_NAME>` is the name of your Heroku app, and `<EMAIL>` and `<PASSWORD>
|
|||||||
|
|
||||||
## Add Environment Variables
|
## Add Environment Variables
|
||||||
|
|
||||||
You’ll likely need to add environment variables later such as Admin CORS and Store CORS variables.
|
You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.
|
||||||
|
|
||||||
To set or change an environment variable's value, you can use the following command:
|
To set or change an environment variable's value, you can use the following command:
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
In this document, you'll learn how to deploy your Medusa server on Qovery with the help of Terraform.
|
In this document, you'll learn how to deploy your Medusa server on Qovery with the help of Terraform.
|
||||||
|
|
||||||
[Qovery](https://www.qovery.com/) is a Continuous Deployment Platform that provides you with the developer experience of Heroku on top of your cloud provider (e.g. AWS, DigitalOcean).
|
[Qovery](https://www.qovery.com/) is a Continuous Deployment Platform that provides you with the developer experience of Heroku on top of your cloud provider (For example, AWS, DigitalOcean).
|
||||||
|
|
||||||
[Terraform](https://www.terraform.io/) is an open source infrastructure as code software (IaC) tool that allows you to easily deploy apps like Medusa and the resources it needs to Qovery using a single script.
|
[Terraform](https://www.terraform.io/) is an open source infrastructure as code software (IaC) tool that allows you to easily deploy apps like Medusa and the resources it needs to Qovery using a single script.
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ This tutorial explains how to deploy Medusa to a Qovery organization with an AWS
|
|||||||
|
|
||||||
### Medusa Server
|
### Medusa Server
|
||||||
|
|
||||||
It is assumed that you already have a Medusa server installed locally. If you don’t, please follow our [quickstart guide](../../quickstart/quick-start.md).
|
It is assumed that you already have a Medusa server installed locally. If you don’t, please follow the [quickstart guide](../../quickstart/quick-start.md).
|
||||||
|
|
||||||
Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.
|
Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.
|
||||||
|
|
||||||
@@ -240,7 +240,7 @@ Here’s an explanation of each of the variables and how to retrieve their varia
|
|||||||
- `qovery_create_cluster`: A boolean value indicating whether a new cluster should be created or not. If you already have a cluster that you want to use, you can set the value to `false` and set the value of `qovery_cluster_id`. Otherwise, set the value to `true` and set the values of `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`.
|
- `qovery_create_cluster`: A boolean value indicating whether a new cluster should be created or not. If you already have a cluster that you want to use, you can set the value to `false` and set the value of `qovery_cluster_id`. Otherwise, set the value to `true` and set the values of `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`.
|
||||||
- `qovery_cluster_id`: The ID of the existing cluster to use (if `qovery_create_cluster` is set to `false`). You can use [Qovery’s REST API](https://api-doc.qovery.com/#tag/Clusters/operation/listOrganizationCluster) to retrieve the cluster ID. You can use the token you generated earlier for the Bearer authorization token as explained [here](https://hub.qovery.com/docs/using-qovery/interface/cli/#generate-api-token).
|
- `qovery_cluster_id`: The ID of the existing cluster to use (if `qovery_create_cluster` is set to `false`). You can use [Qovery’s REST API](https://api-doc.qovery.com/#tag/Clusters/operation/listOrganizationCluster) to retrieve the cluster ID. You can use the token you generated earlier for the Bearer authorization token as explained [here](https://hub.qovery.com/docs/using-qovery/interface/cli/#generate-api-token).
|
||||||
- `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`: The credentials used to create the cluster (if `qovery_create_cluster` is set to `true`). You can refer to [this guide](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) to learn how to retrieve the `aws_access_key_id` and `aws_secret_access_key`.
|
- `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`: The credentials used to create the cluster (if `qovery_create_cluster` is set to `true`). You can refer to [this guide](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) to learn how to retrieve the `aws_access_key_id` and `aws_secret_access_key`.
|
||||||
- `medusa_jwt_secret`: The value of the JWT Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
|
- `medusa_jwt_secret`: The value of the JSON Web Token (JWT) Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
|
||||||
- `medusa_cookie_secret`: The value of the Cookie Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
|
- `medusa_cookie_secret`: The value of the Cookie Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
|
||||||
- `git_url`: The URL of the Git repository you created earlier. Make sure it ends with `.git`.
|
- `git_url`: The URL of the Git repository you created earlier. Make sure it ends with `.git`.
|
||||||
- `git_branch`: The branch to use in the GitHub repo. By default it’s `master`.
|
- `git_branch`: The branch to use in the GitHub repo. By default it’s `master`.
|
||||||
@@ -461,7 +461,7 @@ terraform apply
|
|||||||
|
|
||||||
You’ll be asked to confirm creating all the necessary resources in Qovery. Enter `yes` and the deployment will start.
|
You’ll be asked to confirm creating all the necessary resources in Qovery. Enter `yes` and the deployment will start.
|
||||||
|
|
||||||
The deployment can take up to 30 minutes to finish. You’ll be able to track its status both in your terminal and in the [Qovery Console](https://console.qovery.com/).
|
The deployment can take up to thirty minutes to finish. You’ll be able to track its status both in your terminal and in the [Qovery Console](https://console.qovery.com/).
|
||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
@@ -496,7 +496,7 @@ medusa user --email <EMAIL> --password <PASSWORD>
|
|||||||
|
|
||||||
## Add Environment Variables
|
## Add Environment Variables
|
||||||
|
|
||||||
You’ll likely need to add environment variables later such as Admin CORS and Store CORS variables.
|
You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.
|
||||||
|
|
||||||
To add environment variables, in your [Qovery Console](https://console.qovery.com/) go to the Medusa app and choose Environment Variables from the sidebar. You can add environment variables here at any point later on.
|
To add environment variables, in your [Qovery Console](https://console.qovery.com/) go to the Medusa app and choose Environment Variables from the sidebar. You can add environment variables here at any point later on.
|
||||||
|
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ In the form that shows, keep all fields the same and click on the “Show advanc
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Under the “Advanced build settings” section click on the “New variable” button. This will show 2 inputs for the key and value of the environment variable.
|
Under the “Advanced build settings” section click on the “New variable” button. This will show two inputs for the key and value of the environment variable.
|
||||||
|
|
||||||
For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server.
|
For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server.
|
||||||
|
|
||||||
@@ -146,7 +146,7 @@ If you click on it, you’ll be redirected to the deployed storefront website.
|
|||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
|
|
||||||
At this point, you will face errors related to CORS while using the storefront. Before you start using the storefront, follow along the [Configure CORS on the Medusa Server section](#configure-cors-variable-on-the-medusa-server).
|
At this point, you will face errors related to Cross-Origin Resource Sharing (CORS) while using the storefront. Before you start using the storefront, follow along the [Configure CORS on the Medusa Server section](#configure-cors-variable-on-the-medusa-server).
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@@ -186,7 +186,7 @@ In your terminal, run the following command:
|
|||||||
netlify init
|
netlify init
|
||||||
```
|
```
|
||||||
|
|
||||||
You’ll have to follow 5 steps for the initialization:
|
You’ll have to follow five steps for the initialization:
|
||||||
|
|
||||||
##### Step 1: Create Netlify Website
|
##### Step 1: Create Netlify Website
|
||||||
|
|
||||||
|
|||||||
@@ -1,174 +0,0 @@
|
|||||||
---
|
|
||||||
title: Create a file plugin
|
|
||||||
---
|
|
||||||
|
|
||||||
# File Plugin
|
|
||||||
|
|
||||||
This guide will give an introduction about the File Service and steps required to create a custom file uploader plugin for Medusa. It build on article about [creating custom plugins](../advanced/backend/payment/overview.md).
|
|
||||||
|
|
||||||
As an example, we will create a File plugin that uploads the product images to Cloudinary.
|
|
||||||
|
|
||||||
## The File API
|
|
||||||
|
|
||||||
The file api is used to upload and manage product images used in Medusa.
|
|
||||||
|
|
||||||
## Implementing the File Service
|
|
||||||
|
|
||||||
The File Service is an built in interface in Medusa Core. It has two methods which must be overidden by our custom implementation of the service: `upload` and `delete`.
|
|
||||||
|
|
||||||
As the names suggest, upload allows us to specify the logic for uploading the file/image to our service while delete is used for deleting the image.
|
|
||||||
|
|
||||||
Both of the methods must return an promise.
|
|
||||||
The upload method should return the url of uploaded image.
|
|
||||||
In case of any error uploading, both methods should reject the promise and return an appropriate error message.
|
|
||||||
|
|
||||||
Here is the implementation of the base file service that we will extend.
|
|
||||||
```javascript
|
|
||||||
/**
|
|
||||||
* Interface for file connectors
|
|
||||||
* @interface
|
|
||||||
*/
|
|
||||||
class BaseFileService extends BaseService {
|
|
||||||
constructor() {
|
|
||||||
super()
|
|
||||||
}
|
|
||||||
|
|
||||||
upload() {
|
|
||||||
throw Error("upload must be overridden by the child class")
|
|
||||||
}
|
|
||||||
|
|
||||||
delete() {
|
|
||||||
throw Error("delete must be overridden by the child class")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export default BaseFileService
|
|
||||||
```
|
|
||||||
|
|
||||||
See the example below for detailed usage.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
We will create an plugin for uploading product images to [Cloudinary](https://cloudinary.com/)
|
|
||||||
|
|
||||||
The first step is to create an account on Cloudinary and copy the credentials like given below.
|
|
||||||
|
|
||||||
```
|
|
||||||
cloud_name: "xx"
|
|
||||||
api_key: "xx"
|
|
||||||
api_secret: "xx"
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
The first step in creating a plugin is to initialize the Node.js project:
|
|
||||||
|
|
||||||
```bash npm2yarn
|
|
||||||
npm init
|
|
||||||
```
|
|
||||||
|
|
||||||
This command will ask you to fill out your project's metadata, which will eventually be used when publishing the package to NPM. After this command completes, you are ready to start implementing the functionality.
|
|
||||||
|
|
||||||
Next up, we need to install cloudinary's Node.js SDK.
|
|
||||||
|
|
||||||
```bash npm2yarn
|
|
||||||
npm install cloudinary
|
|
||||||
```
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
|
|
||||||
To quickly get started with the implementation, we advise you to copy `/services/`, `/api/`, `/subscribers/` and the config files from the tutorial and add them in `/src`. As a result, you should have the following folder structure:
|
|
||||||
|
|
||||||
```js
|
|
||||||
.
|
|
||||||
├── src
|
|
||||||
│ ├── api
|
|
||||||
│ └── services
|
|
||||||
│ └── subscribers
|
|
||||||
├── .babelrc
|
|
||||||
├── .gitignore
|
|
||||||
├── medusa-config.js
|
|
||||||
├── README.md
|
|
||||||
└── package.json
|
|
||||||
```
|
|
||||||
|
|
||||||
We will create a new file `cloudinary.js` in the `services` directory.
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
import fs from "fs";
|
|
||||||
|
|
||||||
import { v2 as cloudinary } from "cloudinary";
|
|
||||||
import { FileService } from "medusa-interfaces";
|
|
||||||
|
|
||||||
class CloudinaryService extends FileService {
|
|
||||||
constructor({}, options) {
|
|
||||||
super();
|
|
||||||
|
|
||||||
// Initialize the Cloudinary sdk
|
|
||||||
cloudinary.config({
|
|
||||||
cloud_name: options.cloud_name,
|
|
||||||
api_key: options.api_key,
|
|
||||||
api_secret: options.api_secret,
|
|
||||||
secure: options.secure,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// File upload
|
|
||||||
upload(file) {
|
|
||||||
console.log("Starting image upload");
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
// upload_stream allows to upload a file stream
|
|
||||||
var upload_stream = cloudinary.uploader.upload_stream(
|
|
||||||
{},
|
|
||||||
function (err, image) {
|
|
||||||
if (err) {
|
|
||||||
// Reject and return an error if the file upload failed
|
|
||||||
console.error(err);
|
|
||||||
reject(err);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Return the url of image uploaded
|
|
||||||
resolve({ url: image.url });
|
|
||||||
}
|
|
||||||
);
|
|
||||||
// Create a file stream from path and forward it to our uploader
|
|
||||||
fs.createReadStream(file.path).pipe(upload_stream);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
delete(file) {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
// Pass the name of file to be deleted
|
|
||||||
cloudinary.uploader.destroy(file, function (result) {
|
|
||||||
resolve(result);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export default CloudinaryService;
|
|
||||||
```
|
|
||||||
|
|
||||||
### Publishing
|
|
||||||
|
|
||||||
In order for your plugin to become a part of the Medusa plugin ecosystem, you need to publish it to NPM. Make sure that you've included the `package.json` file. NPM uses the details of this file to configure the publishing. Please include `medusa` and `medusa-plugin` and possibly more in the `keywords` field of the `package.json`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
{
|
|
||||||
"name": "medusa-file-cloudinary",
|
|
||||||
...
|
|
||||||
"keywords": [
|
|
||||||
"medusa",
|
|
||||||
"medusa-file",
|
|
||||||
"medusa-plugin"
|
|
||||||
],
|
|
||||||
"description": "Cloudinary File Plugin for Medusa Commerce",
|
|
||||||
...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Finally, you should add a README for the plugin, such that the community understands the purpose of the plugin and how to install it.
|
|
||||||
|
|
||||||
|
|
||||||
## Summary
|
|
||||||
|
|
||||||
As a result of following this guide, you should now be able to both implement a custom file plugin for your Medusa project.
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
---
|
|
||||||
title: Fulfillment API
|
|
||||||
---
|
|
||||||
|
|
||||||
## **Introduction**
|
|
||||||
|
|
||||||
This guide will give an overview of Medusa's Fulfillment API and how it can be implemented to work with different fulfillment providers. Before digging deeper into the API it should be clarified what is meant by a fulfillment provider; in Medusa a fulfillment provider is typically a 3rd party service that can handle order data for the purpose of shipping the items in the order to a customer. Examples of fulfillment providers are: a carrier like UPS, a logistics platform like ShipBob or a 3PL solution.
|
|
||||||
|
|
||||||
Implementations of the Fulfillment API can be distributed as npm packages for easy installation through the plugin system, there are already a couple of examples of fulfillment plugins in the Medusa monorepo, you can identify these by looking for `medusa-fulfillment-*`. For further details on building and publishing plugins [please check this guide](../advanced/backend/payment/overview.md).
|
|
||||||
|
|
||||||
## Fulfillment Service Interface
|
|
||||||
|
|
||||||
The fulfillment service interface can be found in the [`medusa-interfaces` package](https://github.com/medusajs/medusa/blob/master/packages/medusa-interfaces/src/fulfillment-service.js) where you can see the full list of methods that can be implemented. The methods in the interface allow you to implement plugins that can calculate shipping rates, create fulfillments in other systems, create return labels, retrieve customs documents and more.
|
|
||||||
|
|
||||||
In this guide we will focus on the methods involved in a typical fulfillment flow i.e. creating a shipping option, adding a shipping method to a cart, creating a fulfillment of items in a cart and finally marking the fulfillment as shipped. The methods involved in this flow are:
|
|
||||||
|
|
||||||
```jsx
|
|
||||||
getFulfillmentOptions()
|
|
||||||
validateOption(optionData)
|
|
||||||
validateFulfillmentData(fulfillmentData, cart)
|
|
||||||
createFulfillment(fulfillmentData, fulfillmentItems, order, fulfillment)
|
|
||||||
```
|
|
||||||
|
|
||||||
The figure below shows at what points in the flow the Fulfillment API is called.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
- **Get fulfillment options for Region**
|
|
||||||
|
|
||||||
In Medusa Shipping Options are defined and configured for each region - this allows store operators to granularly control how orders can be fulfilled in different countries. When creating a shipping option on a Region the Fulfillment API calls `getFulfillmentOptions` which will return the ways in which a fulfillment provider can process an order. Let's imagine that you have built a UPS plugin that can be used to fulfill orders with UPS; in this case `getFulfillmentOptions` might respond with UPS Express Shipping and UPS Access Point.
|
|
||||||
|
|
||||||
- **Create Shipping Option**
|
|
||||||
|
|
||||||
When creating the Shipping Option in Medusa, a store operator selects which underlying fulfillment option will be used when customers create Orders with the Shipping Option. To build from the UPS example a store operator may select the UPS Access Point option from the list of fulfillment options, she will then add an appropriate name for the Shipping Option, set the Shipping Option's price and if needed adjust the requirements that must be met for the Shipping Option to be active (e.g. minimum cart subtotal). Before the Shipping Option is created, `validateOption` will be called to ensure that the selected fulfillment option is in fact valid and correctly formatted. `validateOption` should respond with the validated fulfillment option; this also provides a point at which you may add additional details to the fulfillment data before the Shipping Option is created.
|
|
||||||
|
|
||||||
- **Get Shipping Options for Cart**
|
|
||||||
|
|
||||||
Moving to the customer perspective it is assumed that a cart has been created, items have been added to the cart and the customer is now looking towards selecting the Shipping Option they wish to have their Order fulfilled with. The first step from the storefront perspective is to retrieve the list of Shipping Options that are available for the Cart; these will be filtered based on the Region the Cart belongs to and the items that are in the cart. There are no calls to the Fulfillment API associated with the retrieval.
|
|
||||||
|
|
||||||
- **Add Shipping Method to Cart**
|
|
||||||
|
|
||||||
At this point the customer has selected a Shipping Option and may have configured additional details about the fulfillment. For example, building on the UPS example, the customer may have selected a Shipping Option that uses the UPS Access Point fulfillment option; in this case the customer sends an `access_point_id` in the `data` object of the `POST /store/carts/:id/shipping-methods` payload. At this point the Shipping Option becomes a Shipping Method, the distinction between the two is that a Shipping Option is a template for how a cart may be shipped whereas a Shipping Method is the instantiated way that the cart will be shipped (which may include specific details like the `access_point_id`). In order to ensure that the details that the customer selects are valid the Fulfillment API's `validateFulfillmentData` is called, this is where a fulfillment implementation may check that the `access_point_id` is in fact a valid value, etc.
|
|
||||||
|
|
||||||
- **Create Fulfillment**
|
|
||||||
|
|
||||||
It is now assumed that the customer has completed their purchase with a given Shipping Method and the order has been confirmed. At this point we are ready to create the fulfillment in the 3rd party system. When a store operator (or an automation) attempts to fulfill an order the `createFulfillment` method will be called in the Fulfillment API, in our UPS example this method should then book a shipment via UPS's API.
|
|
||||||
Note: in Medusa you can make partial fulfillments of an order it is therefore important that the id sent to the 3rd party is unique by fulfillment and not only order.
|
|
||||||
|
|
||||||
- **Mark as shipped**
|
|
||||||
|
|
||||||
The final step of the fulfillment process is to mark the fulfillment as shipped. It is also at this stage that you would record a tracking number that can be shared with the customer. This step typically happens asynchronously through a webhook.
|
|
||||||
|
|
||||||
## Other useful methods
|
|
||||||
|
|
||||||
The flow above describes the Fulfillment API in high level terms; check out the `[medusa-fulfillment-webshipper](https://github.com/medusajs/medusa/blob/master/packages/medusa-fulfillment-webshipper/src/services/webshipper-fulfillment.js)` plugin for a full implementation of the Fulfillment API. In the implementation you will find examples of all the method described above.
|
|
||||||
|
|
||||||
### `createReturn`
|
|
||||||
|
|
||||||
You will find that the Webshipper plugin has an implementation for `createReturn` which allows fulfillment providers to implement a way for generating return labels. When implemented this can be used to allow customers to create self managed returns or to integrate automatic return label generation in the admin dashboard.
|
|
||||||
|
|
||||||
### `canCalculate(fulfillmentOption)`
|
|
||||||
|
|
||||||
If implemented this method can be used to dynamically calculate prices based on a cart's contents or details. The method returns a boolean value indicating if a given fulfillment option can have a dynamically calculated price or not.
|
|
||||||
|
|
||||||
### `calculatePrice(fulfillmentOption, fulfillmentData, cart)`
|
|
||||||
|
|
||||||
If the shipping option is configured to dynamically calculate the price of the this method will be called when Shipping Options are fetched for the Cart and when Shipping Methods are created on a Cart.
|
|
||||||
|
|
||||||
## What's next?
|
|
||||||
|
|
||||||
Now that you have an overview of the Fulfillment API you can start developing your own fulfillment plugin. For a guide on how to create plugins [check this guide](../advanced/backend/payment/overview.md). If you have questions or issues please feel free to [join our Discord server](https://discord.gg/medusajs) for direct access to the engineering team.
|
|
||||||
@@ -12,7 +12,7 @@ Medusa is an open-source headless commerce engine that enables developers to cre
|
|||||||
|
|
||||||
:::tip
|
:::tip
|
||||||
|
|
||||||
Get started with Medusa in a few minutes with our [Quickstart guide](./quickstart/quick-start.md)!
|
Get started with Medusa in a few minutes with the [Quickstart guide](./quickstart/quick-start.md)!
|
||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
@@ -25,11 +25,11 @@ Medusa comes with a set of building blocks that allow you to create unique digit
|
|||||||
- **Orders** come with all the functionality necessary to perform powerful customer service operations with ease.
|
- **Orders** come with all the functionality necessary to perform powerful customer service operations with ease.
|
||||||
- **Carts** allow customers to collect products for purchase, add shipping details, and complete payments.
|
- **Carts** allow customers to collect products for purchase, add shipping details, and complete payments.
|
||||||
- **Products** come with relevant fields for customs, stock keeping, and sales. Medusa supports multiple options and unlimited variants.
|
- **Products** come with relevant fields for customs, stock keeping, and sales. Medusa supports multiple options and unlimited variants.
|
||||||
- **Swaps** allow customers to exchange products after purchase (e.g. for incorrect sizes). Accounting, payment, and fulfillment plugins handle all the tedious work for you for automated customer service.
|
- **Swaps** allow customers to exchange products after purchase (for example, for incorrect sizes). Accounting, payment, and fulfillment plugins handle all the tedious work for you for automated customer service.
|
||||||
- **Claims** can be created if customers experience problems with one of their products. Plugins make sure to automate sending out replacements, handling refunds, and collecting valuable data for analysis.
|
- **Claims** can be created if customers experience problems with one of their products. Plugins make sure to automate sending out replacements, handling refunds, and collecting valuable data for analysis.
|
||||||
- **Returns** allow customers to send back products and can be configured to function in 100% automated flow-through accounting and payment plugins.
|
- **Returns** allow customers to send back products and can be configured to function in 100% automated flow-through accounting and payment plugins.
|
||||||
- **Fulfillment API** makes it easy to integrate with any fulfillment provider by creating fulfillment plugins.
|
- **Fulfillment API** makes it easy to integrate with any fulfillment provider by creating fulfillment plugins.
|
||||||
- **Payments API** makes it easy to integrate with any payment provider by creating payment plugins, we already support Stripe, Paypal, and Klarna.
|
- **Payments API** makes it easy to integrate with any payment provider by creating payment plugins, Medusa already supports Stripe, Paypal, and Klarna.
|
||||||
- **Notification API** allows integrations with email providers, chatbots, Slack channels, etc.
|
- **Notification API** allows integrations with email providers, chatbots, Slack channels, etc.
|
||||||
- **Customer Login** gives customers a way of managing their data, viewing their orders, and saving payment details.
|
- **Customer Login** gives customers a way of managing their data, viewing their orders, and saving payment details.
|
||||||
- **Shipping Options & Profiles** enable powerful rules for free shipping limits, multiple fulfillment methods, and more.
|
- **Shipping Options & Profiles** enable powerful rules for free shipping limits, multiple fulfillment methods, and more.
|
||||||
@@ -40,7 +40,7 @@ Medusa comes with a set of building blocks that allow you to create unique digit
|
|||||||
|
|
||||||
### The Medusa Server
|
### The Medusa Server
|
||||||
|
|
||||||
You can follow our [quickstart guide](quickstart/quick-start.md) to install and run a Medusa server.
|
You can follow the [quickstart guide](quickstart/quick-start.md) to install and run a Medusa server.
|
||||||
|
|
||||||
It's also recommended to learn how to [set up your development environment](tutorial/set-up-your-development-environment) with the required tools and services to run a Medusa server, then [configure your Medusa server](usage/configurations.md).
|
It's also recommended to learn how to [set up your development environment](tutorial/set-up-your-development-environment) with the required tools and services to run a Medusa server, then [configure your Medusa server](usage/configurations.md).
|
||||||
|
|
||||||
@@ -48,13 +48,13 @@ It's also recommended to learn how to [set up your development environment](tuto
|
|||||||
|
|
||||||
The Medusa Admin provides you with a lot of functionalities and configurations such as Product Management, Order Management, Discounts and Promotions, and more.
|
The Medusa Admin provides you with a lot of functionalities and configurations such as Product Management, Order Management, Discounts and Promotions, and more.
|
||||||
|
|
||||||
You can install the Medusa admin in 2 steps by following our [Medusa Admin quickstart guide](admin/quickstart.md).
|
You can install the Medusa admin in two steps by following the [Medusa Admin quickstart guide](admin/quickstart.md).
|
||||||
|
|
||||||
### The Storefront
|
### The Storefront
|
||||||
|
|
||||||
The final step is to set up a storefront to sell your products.
|
The final step is to set up a storefront to sell your products.
|
||||||
|
|
||||||
Medusa provides 2 starter storefronts, one built with [Next.js](./starters/nextjs-medusa-starter.md) and one with [Gatsby](./starters/gatsby-medusa-starter.md), that you can use to quickly set up your store and start selling.
|
Medusa provides two starter storefronts, one built with [Next.js](./starters/nextjs-medusa-starter.md) and one with [Gatsby](./starters/gatsby-medusa-starter.md), that you can use to quickly set up your store and start selling.
|
||||||
|
|
||||||
Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store).
|
Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store).
|
||||||
|
|
||||||
@@ -76,6 +76,6 @@ You can find more details about contributing in [CONTRIBUTING.md](https://github
|
|||||||
|
|
||||||
## Community & Support
|
## Community & Support
|
||||||
|
|
||||||
If you need any support during your development with Medusa, you can join our [Discord Server](https://discord.gg/medusajs). You will get help directly from our core team as well as our community.
|
If you need any support during your development with Medusa, you can join Medusa's [Discord Server](https://discord.gg/medusajs). You will get help directly from Medusa's core team as well as the community.
|
||||||
|
|
||||||
By joining our Discord Server, you’ll also have the chance to participate in many events such as Bug Hunts and showcase your work with Medusa.
|
By joining the Discord Server, you’ll also have the chance to participate in many events such as Bug Hunts and showcase your work with Medusa.
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
# Uploading images to MinIO
|
|
||||||
|
|
||||||
In order to work with images in Medusa, you need a file service plugin responsible for hosting. Following this guide will allow you to upload images to MinIO bucket.
|
|
||||||
|
|
||||||
### Before you start
|
|
||||||
|
|
||||||
At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusajs.com/tutorial/set-up-your-development-environment) for setting up your local environment.
|
|
||||||
|
|
||||||
### Set up MinIO
|
|
||||||
|
|
||||||
#### Create an MinIO bucket
|
|
||||||
|
|
||||||
In the MinIO console create a new bucket, then click into that bucket and change the `Access Policy` to `public`.
|
|
||||||
|
|
||||||
Be aware, that this will allow for anyone to acces your bucket. Avoid storing sensitive data.
|
|
||||||
|
|
||||||
#### Generate access keys
|
|
||||||
|
|
||||||
Navigate to users and perform the following steps:
|
|
||||||
|
|
||||||
- Enter new `Access Key` and `Secret Key`
|
|
||||||
- Select readwrite policy
|
|
||||||
- Submit the details
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
First, install the plugin using your preferred package manager:
|
|
||||||
|
|
||||||
```bash npm2yarn
|
|
||||||
npm install medusa-file-minio
|
|
||||||
```
|
|
||||||
|
|
||||||
Then configure your `medusa-config.js` to include the plugin alongside the required options:
|
|
||||||
|
|
||||||
```=javascript
|
|
||||||
{
|
|
||||||
resolve: `medusa-file-minio`,
|
|
||||||
options: {
|
|
||||||
endpoint: "minio.server.com",
|
|
||||||
bucket: "test",
|
|
||||||
access_key_id: "YOUR-ACCESS-KEY",
|
|
||||||
secret_access_key: "YOUR-SECRET-KEY",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
The two access keys in the options are the ones created in the previous section.
|
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
Make sure to use an environment variable for the secret key in a live environment.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Try it out
|
|
||||||
|
|
||||||
Finally, run your Medusa server alongside our admin system to try out your new file service. Upon editing or creating products, you can now upload thumbnails and images, that are stored in an MinIO server.
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
# Uploading images to S3
|
|
||||||
|
|
||||||
In order to work with images in Medusa, you need a file service plugin responsible for hosting. Following this guide will allow you to upload images to AWS S3.
|
|
||||||
|
|
||||||
### Before you start
|
|
||||||
|
|
||||||
At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusajs.com/tutorial/set-up-your-development-environment) for setting up your local environment.
|
|
||||||
|
|
||||||
### Set up AWS
|
|
||||||
|
|
||||||
#### Create an S3 bucket
|
|
||||||
|
|
||||||
In the AWS console navigate to S3 and create a bucket for your images. Make sure to uncheck "Block _all_ public access".
|
|
||||||
|
|
||||||
Additionally, you need to add a policy to your bucket, that will allow public access to objects that are uploaded. Navigate to the permissions tab of your bucket and add the following policy:
|
|
||||||
|
|
||||||
```shell=
|
|
||||||
{
|
|
||||||
"Id": "Policy1397632521960",
|
|
||||||
"Statement": [
|
|
||||||
{
|
|
||||||
"Sid": "Stmt1397633323327",
|
|
||||||
"Action": [
|
|
||||||
"s3:GetObject"
|
|
||||||
],
|
|
||||||
"Effect": "Allow",
|
|
||||||
"Resource": "arn:aws:s3:::YOUR-BUCKET-NAME/*",
|
|
||||||
"Principal": {
|
|
||||||
"AWS": [
|
|
||||||
"*"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Be aware, that this will allow for anyone to acces your bucket. Avoid storing sensitive data.
|
|
||||||
|
|
||||||
#### Generate access keys
|
|
||||||
|
|
||||||
Navigate to the IAM section of your AWS console and perform the following steps:
|
|
||||||
|
|
||||||
- Add a new user with programmatic access
|
|
||||||
- Add the existing **AmazonS3FullAccess** policy to the user
|
|
||||||
- Submit the details
|
|
||||||
|
|
||||||
Upon successful creation of the user, you are presented with an **Access key ID** and a **Secret access key**. Note both of them down for later use.
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
First, install the plugin using your preferred package manager:
|
|
||||||
|
|
||||||
```bash npm2yarn
|
|
||||||
npm install medusa-file-s3
|
|
||||||
```
|
|
||||||
|
|
||||||
Then configure your `medusa-config.js` to include the plugin alongside the required options:
|
|
||||||
|
|
||||||
```=javascript
|
|
||||||
{
|
|
||||||
resolve: `medusa-file-s3`,
|
|
||||||
options: {
|
|
||||||
s3_url: "https://s3-guide-test.s3.eu-west-1.amazonaws.com",
|
|
||||||
bucket: "test",
|
|
||||||
region: "eu-west-1"
|
|
||||||
access_key_id: "YOUR-ACCESS-KEY",
|
|
||||||
secret_access_key: "YOUR-SECRET-KEY",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
In the above options, an `s3_url` is included. The url has the following format:
|
|
||||||
|
|
||||||
```shell=
|
|
||||||
https://[bucket].s3.[region].amazonaws.com
|
|
||||||
```
|
|
||||||
|
|
||||||
The two access keys in the options are the ones created in the previous section.
|
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
Make sure to use an environment variable for the secret key in a live environment.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Try it out
|
|
||||||
|
|
||||||
Finally, run your Medusa server alongside our admin system to try out your new file service. Upon editing or creating products, you can now upload thumbnails and images, that are stored in an AWS S3 bucket.
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
# Uploading images to Spaces
|
|
||||||
|
|
||||||
In order to work with images in Medusa, you need a file service plugin responsible for hosting. Following this guide will allow you to upload images to DigitalOcean Spaces.
|
|
||||||
|
|
||||||
### Before you start
|
|
||||||
|
|
||||||
At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusajs.com/tutorial/set-up-your-development-environment) for setting up your local environment.
|
|
||||||
|
|
||||||
### Set up DigitalOcean
|
|
||||||
|
|
||||||
#### Create a Space
|
|
||||||
|
|
||||||
Create an account on DigitalOcean and navigate to Spaces. Create a new Space with the default settings.
|
|
||||||
|
|
||||||
#### Generate access keys
|
|
||||||
|
|
||||||
Navigate to API in the left sidebar. Generate a new Spaces access key. This should provide you with an access key id and a secret key. Note them both down.
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
First, install the plugin using your preferred package manager:
|
|
||||||
|
|
||||||
```bash npm2yarn
|
|
||||||
npm install medusa-file-spaces
|
|
||||||
```
|
|
||||||
|
|
||||||
Then configure your `medusa-config.js` to include the plugin alongside the required options:
|
|
||||||
|
|
||||||
```=javascript
|
|
||||||
{
|
|
||||||
resolve: `medusa-file-spaces`,
|
|
||||||
options: {
|
|
||||||
spaces_url: "https://test.fra1.digitaloceanspaces.com",
|
|
||||||
bucket: "test",
|
|
||||||
endpoint: "fra1.digitaloceanspaces.com",
|
|
||||||
access_key_id: "YOUR-ACCESS-KEY",
|
|
||||||
secret_access_key: "YOUR-SECRET-KEY",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
In the above options, a `spaces_url` is included. This can be found in your Space overview. The `bucket` should point to the name you gave your Space. The `endpoint` identifies the region in which you created the Space. And finally the two keys are the ones created in the previous section.
|
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
Make sure to use an environment variable for the secret key in a live environment.
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Try it out!
|
|
||||||
|
|
||||||
Finally, run your Medusa server alongside our admin system to try out your new file service. Upon editing or creating products, you can now upload thumbnails and images, that are stored in DigitalOcean Spaces.
|
|
||||||
@@ -1,27 +1,27 @@
|
|||||||
---
|
---
|
||||||
title: Introduction
|
title: Architecture Overview
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture overview
|
# Architecture Overview
|
||||||
|
|
||||||
Medusa is composed of 3 components: The headless backend, the admin dashboard, and the storefront.
|
Medusa is composed of three components: The headless backend, the admin dashboard, and the storefront.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### Headless Backend
|
## Headless Backend
|
||||||
|
|
||||||
This is the main component that holds all the logic and data of the store. Your admin dashboard and storefront interact with the backend to retrieve, create, and modify data through REST APIs.
|
This is the main component that holds all the logic and data of the store. Your admin dashboard and storefront interact with the backend to retrieve, create, and modify data through REST APIs.
|
||||||
|
|
||||||
Your Medusa server will include all functionalities related to your store’s checkout workflow. That includes cart management, shipping and payment providers, user management, and more. It also allows you to configure your store including your store’s region, tax rules, discounts, gift cards, and more.
|
Your Medusa server will include all functionalities related to your store’s checkout workflow. That includes cart management, shipping and payment providers, user management, and more. It also allows you to configure your store including your store’s region, tax rules, discounts, gift cards, and more.
|
||||||
|
|
||||||
### Admin Dashboard
|
## Admin Dashboard
|
||||||
|
|
||||||
The admin dashboard is accessible by store operators. Store operators can use the admin dashboard to view, create, and modify data such as orders and products.
|
The admin dashboard is accessible by store operators. Store operators can use the admin dashboard to view, create, and modify data such as orders and products.
|
||||||
|
|
||||||
Medusa provides a beautiful [admin dashboard](https://demo.medusajs.com) that you can use right off the bat. Our admin dashboard provides a lot of functionalities to manage your store including Order management, Product management, User management, and more.
|
Medusa provides a beautiful [admin dashboard](https://demo.medusajs.com) that you can use right off the bat. Medusa's admin dashboard provides a lot of functionalities to manage your store including Order management, Product management, User management, and more.
|
||||||
|
|
||||||
You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin).
|
You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin).
|
||||||
|
|
||||||
### Storefront
|
## Storefront
|
||||||
|
|
||||||
Your customers use the Storefront to view products and make orders. Medusa provides 2 storefronts, one built with [Next.js](https://docs.medusajs.com/starters/nextjs-medusa-starter) and one with [Gatsby](https://docs.medusajs.com/starters/gatsby-medusa-starter). You are also free to create your own storefront using the [Storefront REST APIs](https://docs.medusajs.com/api/store/).
|
Your customers use the Storefront to view products and make orders. Medusa provides two storefronts, one built with [Next.js](https://docs.medusajs.com/starters/nextjs-medusa-starter) and one with [Gatsby](https://docs.medusajs.com/starters/gatsby-medusa-starter). You are also free to create your own storefront using the [Storefront REST APIs](https://docs.medusajs.com/api/store/).
|
||||||
@@ -1,86 +1,106 @@
|
|||||||
# Quickstart w. Docker
|
# Quickstart using Docker
|
||||||
|
|
||||||
This quick start is intended for developers, that have already configured their local development environment and familiarised them selves with all the technologies and frameworks used throughout the Medusa eco-system.
|
In this document you will learn how to make a container of Medusa's app on Docker. Docker is an open source platform for building, deploying, and managing containerized applications.
|
||||||
|
|
||||||
If this is not the case, please head over to our Getting Started tutorial for a thorough walkthrough.
|
## Prerequisites
|
||||||
|
|
||||||
## Introduction
|
### Node.js
|
||||||
|
Medusa supports Node versions 14 and 16. You can check which version of Node you have by running the following command:
|
||||||
|
|
||||||
With all the tools and technologies in place, let's get started by setting up a default project. Our starter is shipped with a very basic configuration, that includes the following plugins:
|
```bash
|
||||||
|
node -v
|
||||||
|
```
|
||||||
|
|
||||||
- Stripe as payment provider
|
You can install Node from the [official website](https://nodejs.org/en/).
|
||||||
- SendGrid as email notification provider
|
|
||||||
- Manual fulfilment as fulfilment provider
|
|
||||||
|
|
||||||
Additionally, we will spin up a PostgreSQL database and a Redis server, both required for Medusa to run. In this quick start, we will use docker to seamlessly set up these resources.
|
### Docker Desktop
|
||||||
|
|
||||||
## Get started
|
It is assumed that you have Docker installed on your system. You can install it from [Docker's website](https://docs.docker.com/get-docker/).
|
||||||
|
|
||||||
1. Clone our starter project from Github
|
## Create Medusa Server with Docker
|
||||||
|
|
||||||
|
### 1. Clone Medusa's starter project from Github
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/medusajs/medusa-starter-default.git my-medusa-starter
|
git clone https://github.com/medusajs/medusa-starter-default.git my-medusa-starter
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Once cloned, we will jump into our project directory and get started with our configuration.
|
### 2. Change to the newly created project directory
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd my-medusa-starter
|
cd my-medusa-starter
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Get your environment variables ready using our template
|
### 3. Rename the environment variables(.env) file
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mv .env.template .env
|
mv .env.template .env
|
||||||
```
|
```
|
||||||
|
|
||||||
4. Setup accounts for included plugins. This step is optional but required for placing orders.
|
### 4. Start your server
|
||||||
|
|
||||||
Create a Stripe account and add your API key and webhook secret to `.env`
|
Make sure the Docker Desktop app is running. Then, run the following command:
|
||||||
Create a SendGrid account and add your API key to `.env`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
...
|
|
||||||
STRIPE_API_KEY="some_stripe_key"
|
|
||||||
STRIPE_WEBHOOK_SECRET="some_webhook_secret"
|
|
||||||
SENDGRID_API_KEY="some_sendgrid_key"
|
|
||||||
..
|
|
||||||
```
|
|
||||||
|
|
||||||
5. Start your server
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose up --build
|
docker-compose up --build
|
||||||
```
|
```
|
||||||
|
|
||||||
We will use docker-compose and Docker to start up our development environment. Running the above command will do the following:
|
:::note
|
||||||
|
|
||||||
1. Build images for our Medusa project, a PostgreSQL database and a Redis server
|
If you get the error `ERROR: for postgres Cannot start service postgres: Ports are not available`, change the ports used for PostgreSQL in `docker-compose.yml` to something like this:
|
||||||
2. Run migrations for our newly created database
|
|
||||||
3. Seed our database with some entities, that will allow us to easily get started.
|
|
||||||
|
|
||||||
These include:
|
```yml
|
||||||
|
postgres:
|
||||||
|
ports:
|
||||||
|
- "5433:5433"
|
||||||
|
```
|
||||||
|
|
||||||
- A user with email `admin@medusa-test.com` and password `supersecret`
|
:::
|
||||||
- A region called Default Region with a small subset of countries
|
|
||||||
- A shipping option called Standard Shipping, that costs 10 EUR
|
|
||||||
- A product called Cool Test Product
|
|
||||||
- A variant of that product that costs 195 EUR
|
|
||||||
|
|
||||||
Once done, our server will be accessible at `http://localhost:9000`.
|
Running the above command does the following:
|
||||||
|
|
||||||
## Try it out
|
1. Build images for your Medusa project, a PostgreSQL database and a Redis server
|
||||||
|
2. Run migrations for your newly created database
|
||||||
|
|
||||||
Let's try out our Medusa server by fetching some products.
|
|
||||||
|
## Test Your Server
|
||||||
|
|
||||||
|
Once done, your server will be accessible at `http://localhost:9000`.
|
||||||
|
|
||||||
|
You can test out your server using tools like Postman or by sending a cURL request:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -X GET localhost:9000/store/products | python -m json.tool
|
curl -X GET localhost:9000/store/products | python -m json.tool
|
||||||
```
|
```
|
||||||
|
|
||||||
## What's next?
|
:::note
|
||||||
|
|
||||||
Add custom endpoint to your Medusa project
|
This command uses Python to format the result of the request better in your command line. If you don't want to use Python you can simply send a request without the formatting:
|
||||||
|
|
||||||
Install and configure additional plugins
|
```bash
|
||||||
|
curl localhost:9000/store/products
|
||||||
|
```
|
||||||
|
|
||||||
Build a storefront using our [Gatsby Starter](https://github.com/medusajs/gatsby-starter-medusa)
|
:::
|
||||||
|
|
||||||
|
## Additional steps
|
||||||
|
|
||||||
|
### File Service Plugin
|
||||||
|
|
||||||
|
To upload product images to your Medusa server, you must install and configure one of the following file service plugins:
|
||||||
|
|
||||||
|
- [MinIO](../add-plugins/minio.md) (Recommended for local development)
|
||||||
|
- [S3](../add-plugins/s3.md)
|
||||||
|
- [DigitalOcean Spaces](../add-plugins/spaces.md)
|
||||||
|
|
||||||
|
### Server Configurations
|
||||||
|
|
||||||
|
It's important to configure your Medusa server properly and learn how environment variables are loaded.
|
||||||
|
|
||||||
|
You can learn more about configuring your server and loading environment variables in the [Configure your Server documentation](../usage/configurations.md).
|
||||||
|
|
||||||
|
## What's next :rocket:
|
||||||
|
|
||||||
|
- Install the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts to set up your ecommerce storefront quickly.
|
||||||
|
- Install the [Medusa Admin](../admin/quickstart.md) to supercharge your ecommerce experience with easy access to configurations and features.
|
||||||
|
- Check out the [API reference](https://docs.medusajs.com/api/store) to learn more about available endpoints available on your Medusa server.
|
||||||
|
- Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, Notifications, among other features.
|
||||||
@@ -2,16 +2,6 @@
|
|||||||
|
|
||||||
This document will guide you through setting up your Medusa server in a few minutes.
|
This document will guide you through setting up your Medusa server in a few minutes.
|
||||||
|
|
||||||
:::tip
|
|
||||||
|
|
||||||
For a more detailed guide on how to set up your local environment to work with Medusa, check out the documentation on [how to set up your development environment](/tutorial/set-up-your-development-environment).
|
|
||||||
|
|
||||||
:::
|
|
||||||
|
|
||||||
Alternatively, you can use this button to deploy the Medusa server to Heroku directly:
|
|
||||||
|
|
||||||
[](https://heroku.com/deploy?template=https://github.com/medusajs/medusa-starter-default/tree/feat/deploy-heroku)
|
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Medusa supports Node versions 14 and 16. You can check which version of Node you have by running the following command:
|
Medusa supports Node versions 14 and 16. You can check which version of Node you have by running the following command:
|
||||||
@@ -30,6 +20,12 @@ You can install Node from the [official website](https://nodejs.org/en/).
|
|||||||
npm install @medusajs/medusa-cli -g
|
npm install @medusajs/medusa-cli -g
|
||||||
```
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
If you get a permission error when using NPM, check out [NPM's documentation for a solution](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
### 2. Create a new Medusa project
|
### 2. Create a new Medusa project
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -45,7 +41,7 @@ You can install Node from the [official website](https://nodejs.org/en/).
|
|||||||
|
|
||||||
### Test Your Server
|
### Test Your Server
|
||||||
|
|
||||||
After these 3 steps and in only a couple of minutes, you now have a complete commerce engine running locally. You can test it out by sending a request using a tool like Postman or through the command line:
|
After these three steps and in only a couple of minutes, you now have a complete commerce engine running locally. You can test it out by sending a request using a tool like Postman or through the command line:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl localhost:9000/store/products | python -m json.tool
|
curl localhost:9000/store/products | python -m json.tool
|
||||||
@@ -63,6 +59,18 @@ curl localhost:9000/store/products
|
|||||||
|
|
||||||
## Additional Steps
|
## Additional Steps
|
||||||
|
|
||||||
|
### Set Up Development Environment
|
||||||
|
|
||||||
|
For an optimal experience developing with Medusa and to make sure you can use its advanced functionalities, you'll need to install more tools such as Redis or PostgreSQL.
|
||||||
|
|
||||||
|
Follow [this documentation to learn how to set up your development environment](../tutorial/0-set-up-your-development-environment.mdx).
|
||||||
|
|
||||||
|
### Server Configurations
|
||||||
|
|
||||||
|
It's important to configure your Medusa server properly and learn how environment variables are loaded.
|
||||||
|
|
||||||
|
You can learn more about configuring your server and loading environment variables in the [Configure your Server documentation](../usage/configurations.md).
|
||||||
|
|
||||||
### File Service Plugin
|
### File Service Plugin
|
||||||
|
|
||||||
To upload product images to your Medusa server, you must install and configure one of the following file service plugins:
|
To upload product images to your Medusa server, you must install and configure one of the following file service plugins:
|
||||||
@@ -71,15 +79,9 @@ To upload product images to your Medusa server, you must install and configure o
|
|||||||
- [S3](../add-plugins/s3.md)
|
- [S3](../add-plugins/s3.md)
|
||||||
- [DigitalOcean Spaces](../add-plugins/spaces.md)
|
- [DigitalOcean Spaces](../add-plugins/spaces.md)
|
||||||
|
|
||||||
### Server Configurations
|
|
||||||
|
|
||||||
It's important to configure your Medusa server properly and learn how environment variables are loaded.
|
|
||||||
|
|
||||||
You can learn more about configuring your server and loading environment variables in the [Configure your Server documentation](../usage/configurations.md).
|
|
||||||
|
|
||||||
## What's next :rocket:
|
## What's next :rocket:
|
||||||
|
|
||||||
- Install our [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts to set up your ecommerce storefront quickly.
|
- Install the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts to set up your ecommerce storefront.
|
||||||
- Install the [Medusa Admin](../admin/quickstart.md) to supercharge your ecommerce experience with easy access to configurations and features.
|
- Install the [Medusa Admin](../admin/quickstart.md) to supercharge your ecommerce experience with easy access to configurations and features.
|
||||||
- Check out the [API reference](https://docs.medusajs.com/api/store) to learn more about available endpoints available on your Medusa server.
|
- Check out the [API reference](https://docs.medusajs.com/api/store) to learn more about available endpoints available on your Medusa server.
|
||||||
- Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, Notifications, among other features.
|
- Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, Notifications, among other features.
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:120](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L120)
|
[models/address.ts:120](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L120)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:123](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L123)
|
[models/address.ts:123](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L123)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:126](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L126)
|
[models/address.ts:126](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L126)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:111](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L111)
|
[models/address.ts:111](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L111)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:133](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L133)
|
[models/address.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L133)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:129](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L129)
|
[models/address.ts:129](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L129)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:108](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L108)
|
[models/address.ts:108](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L108)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:104](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L104)
|
[models/address.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L104)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:114](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L114)
|
[models/address.ts:114](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L114)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:117](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L117)
|
[models/address.ts:117](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L117)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:145](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L145)
|
[models/address.ts:145](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L145)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:142](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L142)
|
[models/address.ts:142](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L142)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:139](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L139)
|
[models/address.ts:139](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L139)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -200,7 +200,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:136](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L136)
|
[models/address.ts:136](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L136)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -228,4 +228,4 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/address.ts:147](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/address.ts#L147)
|
[models/address.ts:147](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/address.ts#L147)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L62)
|
[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L62)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L59)
|
[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L59)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L56)
|
[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L56)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L33)
|
[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L26)
|
[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L30)
|
[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L30)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L47)
|
[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L47)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L65)
|
[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L65)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L50)
|
[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L50)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L53)
|
[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L53)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L36)
|
[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L36)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L67)
|
[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L67)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L23)
|
[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -204,7 +204,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -218,7 +218,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L94)
|
[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L94)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -232,7 +232,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L69)
|
[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -246,4 +246,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/batch-job.ts#L99)
|
[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/batch-job.ts#L99)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:226](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L226)
|
[models/cart.ts:226](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L226)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:220](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L220)
|
[models/cart.ts:220](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L220)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:311](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L311)
|
[models/cart.ts:311](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L311)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:320](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L320)
|
[models/cart.ts:320](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L320)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:285](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L285)
|
[models/cart.ts:285](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L285)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:281](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L281)
|
[models/cart.ts:281](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L281)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:335](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L335)
|
[models/cart.ts:335](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L335)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:263](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L263)
|
[models/cart.ts:263](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L263)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:216](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L216)
|
[models/cart.ts:216](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L216)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -146,7 +146,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:342](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L342)
|
[models/cart.ts:342](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L342)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -156,7 +156,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:341](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L341)
|
[models/cart.ts:341](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L341)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -166,7 +166,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:277](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L277)
|
[models/cart.ts:277](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L277)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:317](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L317)
|
[models/cart.ts:317](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L317)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -200,7 +200,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:241](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L241)
|
[models/cart.ts:241](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L241)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -210,7 +210,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:323](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L323)
|
[models/cart.ts:323](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L323)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:213](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L213)
|
[models/cart.ts:213](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L213)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -230,7 +230,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:300](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L300)
|
[models/cart.ts:300](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L300)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -240,7 +240,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:314](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L314)
|
[models/cart.ts:314](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L314)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -250,7 +250,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:296](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L296)
|
[models/cart.ts:296](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L296)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -260,7 +260,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:287](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L287)
|
[models/cart.ts:287](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L287)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -270,7 +270,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:292](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L292)
|
[models/cart.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L292)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -280,7 +280,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:340](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L340)
|
[models/cart.ts:340](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L340)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -290,7 +290,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:337](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L337)
|
[models/cart.ts:337](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L337)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -300,7 +300,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:249](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L249)
|
[models/cart.ts:249](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L249)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -310,7 +310,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:245](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L245)
|
[models/cart.ts:245](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L245)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -320,7 +320,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:332](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L332)
|
[models/cart.ts:332](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L332)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -330,7 +330,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:326](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L326)
|
[models/cart.ts:326](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L326)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -340,7 +340,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:236](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L236)
|
[models/cart.ts:236](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L236)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -350,7 +350,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:230](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L230)
|
[models/cart.ts:230](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L230)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -360,7 +360,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:305](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L305)
|
[models/cart.ts:305](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L305)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -370,7 +370,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:334](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L334)
|
[models/cart.ts:334](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L334)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -380,7 +380,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:339](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L339)
|
[models/cart.ts:339](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L339)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -390,7 +390,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:336](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L336)
|
[models/cart.ts:336](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L336)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -400,7 +400,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:338](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L338)
|
[models/cart.ts:338](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L338)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -410,7 +410,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:308](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L308)
|
[models/cart.ts:308](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L308)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -424,7 +424,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -438,7 +438,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:344](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L344)
|
[models/cart.ts:344](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L344)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -452,4 +452,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/cart.ts:351](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/cart.ts#L351)
|
[models/cart.ts:351](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/cart.ts#L351)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-image.ts#L23)
|
[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-image.ts#L19)
|
[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-image.ts#L29)
|
[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -104,7 +104,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-image.ts#L26)
|
[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L26)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -128,4 +128,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-image.ts#L31)
|
[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-image.ts#L31)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L42)
|
[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L42)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L38)
|
[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L38)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L34)
|
[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L50)
|
[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L50)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L46)
|
[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L46)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L84)
|
[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L84)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L64)
|
[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L64)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L67)
|
[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L67)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L61)
|
[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L61)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L81)
|
[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L81)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -184,7 +184,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L58)
|
[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L58)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L54)
|
[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L54)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -208,4 +208,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-item.ts#L86)
|
[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-item.ts#L86)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L69)
|
[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L107)
|
[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L107)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L66)
|
[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L66)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L110)
|
[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L110)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L116)
|
[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L116)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L63)
|
[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L63)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L101)
|
[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L101)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L125)
|
[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L125)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L122)
|
[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L122)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L119)
|
[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L119)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L80)
|
[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L80)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L76)
|
[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L76)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L56)
|
[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L56)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L104)
|
[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L104)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L83)
|
[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L83)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -200,7 +200,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L91)
|
[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L91)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -210,7 +210,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L87)
|
[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L87)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -220,7 +220,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L96)
|
[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L96)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -230,7 +230,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L72)
|
[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L72)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -244,7 +244,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L113)
|
[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L113)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -258,4 +258,4 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-order.ts#L127)
|
[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-order.ts#L127)
|
||||||
@@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -60,7 +60,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-tag.ts#L14)
|
[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-tag.ts#L14)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-tag.ts#L11)
|
[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-tag.ts#L11)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/claim-tag.ts#L16)
|
[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/claim-tag.ts#L16)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L31)
|
[models/country.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:15](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L15)
|
[models/country.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L15)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L19)
|
[models/country.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:22](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L22)
|
[models/country.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L22)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L28)
|
[models/country.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:25](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L25)
|
[models/country.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:39](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L39)
|
[models/country.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L39)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -88,4 +88,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/country.ts:35](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/country.ts#L35)
|
[models/country.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/country.ts#L35)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/currency.ts:8](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/currency.ts#L8)
|
[models/currency.ts:8](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L8)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/currency.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/currency.ts#L20)
|
[models/currency.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/currency.ts:17](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/currency.ts#L17)
|
[models/currency.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/currency.ts:11](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/currency.ts#L11)
|
[models/currency.ts:11](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L11)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,4 +58,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/currency.ts:14](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/currency.ts#L14)
|
[models/currency.ts:14](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/currency.ts#L14)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L37)
|
[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L33)
|
[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L40)
|
[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L40)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L21)
|
[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L21)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L29)
|
[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L25)
|
[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -134,7 +134,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -148,4 +148,4 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/custom-shipping-option.ts#L42)
|
[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/custom-shipping-option.ts#L42)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:38](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L38)
|
[models/customer.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L38)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L34)
|
[models/customer.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L24)
|
[models/customer.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:27](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L27)
|
[models/customer.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L27)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:69](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L69)
|
[models/customer.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:50](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L50)
|
[models/customer.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L50)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:30](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L30)
|
[models/customer.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L30)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:72](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L72)
|
[models/customer.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L72)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:53](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L53)
|
[models/customer.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L53)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:44](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L44)
|
[models/customer.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L44)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:47](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L47)
|
[models/customer.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L47)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -180,7 +180,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:41](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L41)
|
[models/customer.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -208,4 +208,4 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer.ts:74](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer.ts#L74)
|
[models/customer.ts:74](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer.ts#L74)
|
||||||
@@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer-group.ts#L18)
|
[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L18)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer-group.ts#L26)
|
[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer-group.ts#L13)
|
[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer-group.ts#L23)
|
[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -114,7 +114,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -128,4 +128,4 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/customer-group.ts#L28)
|
[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/customer-group.ts#L28)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:22](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L22)
|
[models/discount.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L22)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:52](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L52)
|
[models/discount.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L52)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:36](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L36)
|
[models/discount.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L36)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:25](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L25)
|
[models/discount.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:78](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L78)
|
[models/discount.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L78)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:43](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L43)
|
[models/discount.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L43)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:39](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L39)
|
[models/discount.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L39)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:69](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L69)
|
[models/discount.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L33)
|
[models/discount.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L29)
|
[models/discount.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:49](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L49)
|
[models/discount.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L49)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -184,7 +184,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -194,7 +194,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:75](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L75)
|
[models/discount.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L75)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -204,7 +204,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:72](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L72)
|
[models/discount.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L72)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -214,7 +214,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:55](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L55)
|
[models/discount.ts:55](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L55)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -228,4 +228,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount.ts:80](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount.ts#L80)
|
[models/discount.ts:80](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount.ts#L80)
|
||||||
@@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L127)
|
[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L127)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L57)
|
[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L57)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L53)
|
[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L53)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L130)
|
[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L130)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L49)
|
[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L49)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L113)
|
[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L113)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L99)
|
[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L99)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L85)
|
[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L85)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L71)
|
[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L71)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -160,7 +160,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L43)
|
[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L43)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -188,4 +188,4 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition.ts#L132)
|
[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition.ts#L132)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L20)
|
[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L31)
|
[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L24)
|
[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L17)
|
[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L28)
|
[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L37)
|
[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,4 +78,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-customer-group.ts#L34)
|
[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-customer-group.ts#L34)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L20)
|
[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L31)
|
[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L28)
|
[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L37)
|
[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L24)
|
[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L17)
|
[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,4 +78,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product.ts#L34)
|
[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product.ts#L34)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L20)
|
[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L31)
|
[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L28)
|
[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L37)
|
[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L24)
|
[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L17)
|
[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,4 +78,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-collection.ts#L34)
|
[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-collection.ts#L34)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L20)
|
[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L31)
|
[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L28)
|
[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L37)
|
[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L24)
|
[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L17)
|
[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,4 +78,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-tag.ts#L34)
|
[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-tag.ts#L34)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L20)
|
[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L31)
|
[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L28)
|
[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L37)
|
[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L24)
|
[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L17)
|
[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L17)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,4 +78,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-condition-product-type.ts#L34)
|
[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-condition-product-type.ts#L34)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L38)
|
[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L38)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L41)
|
[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L22)
|
[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L22)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L44)
|
[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L44)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L28)
|
[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L28)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -134,7 +134,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L31)
|
[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L31)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -148,4 +148,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/discount-rule.ts#L46)
|
[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/discount-rule.ts#L46)
|
||||||
@@ -28,7 +28,7 @@ BaseEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L54)
|
[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L54)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L43)
|
[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L43)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L39)
|
[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L39)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L57)
|
[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L57)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ BaseEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L35)
|
[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ BaseEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L66)
|
[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L66)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L63)
|
[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L63)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L60)
|
[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L60)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L51)
|
[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L51)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -146,7 +146,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L47)
|
[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L47)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -156,7 +156,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L30)
|
[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L30)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -170,7 +170,7 @@ BaseEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -184,4 +184,4 @@ BaseEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/draft-order.ts#L68)
|
[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/draft-order.ts#L68)
|
||||||
@@ -28,7 +28,7 @@ BaseEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L79)
|
[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L79)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L29)
|
[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L25)
|
[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ BaseEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L73)
|
[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L73)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ BaseEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -96,7 +96,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L85)
|
[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L85)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -106,7 +106,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L62)
|
[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L62)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -116,7 +116,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L82)
|
[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L82)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -126,7 +126,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L48)
|
[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L48)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L45)
|
[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -146,7 +146,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L41)
|
[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -156,7 +156,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L56)
|
[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L56)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -166,7 +166,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L52)
|
[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L52)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -176,7 +176,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L76)
|
[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L76)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -186,7 +186,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L37)
|
[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -196,7 +196,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L33)
|
[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -206,7 +206,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L67)
|
[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L67)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -216,7 +216,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L70)
|
[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L70)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -230,7 +230,7 @@ BaseEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -244,4 +244,4 @@ BaseEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment.ts#L87)
|
[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment.ts#L87)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-item.ts#L16)
|
[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-item.ts#L9)
|
[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L9)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-item.ts#L20)
|
[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-item.ts#L12)
|
[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L12)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,4 +58,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-item.ts#L23)
|
[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-item.ts#L23)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-provider.ts#L6)
|
[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-provider.ts#L6)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,4 +28,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/fulfillment-provider.ts#L9)
|
[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/fulfillment-provider.ts#L9)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L26)
|
[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L20)
|
[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L51)
|
[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L51)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L45)
|
[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L54)
|
[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L54)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L42)
|
[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L42)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L38)
|
[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L38)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L34)
|
[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L30)
|
[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L30)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L23)
|
[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L23)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -188,4 +188,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card.ts#L56)
|
[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card.ts#L56)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L40)
|
[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L40)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L43)
|
[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L43)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L29)
|
[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L25)
|
[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L25)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L22)
|
[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L22)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L46)
|
[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L46)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L37)
|
[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L33)
|
[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -98,7 +98,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L49)
|
[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L49)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -112,4 +112,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/gift-card-transaction.ts#L51)
|
[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/gift-card-transaction.ts#L51)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L23)
|
[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L16)
|
[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L20)
|
[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L26)
|
[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L44)
|
[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L44)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L29)
|
[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L32)
|
[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L35)
|
[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L35)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -98,7 +98,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L41)
|
[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L38)
|
[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L38)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -122,4 +122,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/idempotency-key.ts#L46)
|
[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/idempotency-key.ts#L46)
|
||||||
@@ -32,7 +32,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -60,7 +60,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/image.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/image.ts#L13)
|
[models/image.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/image.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -84,7 +84,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/image.ts:10](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/image.ts#L10)
|
[models/image.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/image.ts#L10)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -108,4 +108,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/image.ts:15](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/image.ts#L15)
|
[models/image.ts:15](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/image.ts#L15)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L23)
|
[models/invite.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,7 +56,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -66,7 +66,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:29](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L29)
|
[models/invite.ts:29](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L29)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:32](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L32)
|
[models/invite.ts:32](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L32)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L20)
|
[models/invite.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L26)
|
[models/invite.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L26)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -124,7 +124,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -134,7 +134,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:12](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L12)
|
[models/invite.ts:12](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L12)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -148,4 +148,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/invite.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/invite.ts#L34)
|
[models/invite.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/invite.ts#L34)
|
||||||
@@ -28,7 +28,7 @@ BaseEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L69)
|
[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L69)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:90](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L90)
|
[models/line-item.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L90)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:37](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L37)
|
[models/line-item.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L37)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L33)
|
[models/line-item.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L61)
|
[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L61)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L57)
|
[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L57)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ BaseEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -102,7 +102,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:75](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L75)
|
[models/line-item.ts:75](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L75)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -112,7 +112,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:130](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L130)
|
[models/line-item.ts:130](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L130)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:110](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L110)
|
[models/line-item.ts:110](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L110)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -132,7 +132,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:131](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L131)
|
[models/line-item.ts:131](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L131)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -142,7 +142,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:93](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L93)
|
[models/line-item.ts:93](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L93)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -156,7 +156,7 @@ BaseEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -166,7 +166,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L122)
|
[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L122)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -176,7 +176,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:84](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L84)
|
[models/line-item.ts:84](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L84)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -186,7 +186,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:81](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L81)
|
[models/line-item.ts:81](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L81)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -196,7 +196,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L119)
|
[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L119)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -206,7 +206,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:45](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L45)
|
[models/line-item.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -216,7 +216,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:41](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L41)
|
[models/line-item.ts:41](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L41)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -226,7 +226,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:129](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L129)
|
[models/line-item.ts:129](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L129)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -236,7 +236,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L128)
|
[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L128)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -246,7 +246,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:107](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L107)
|
[models/line-item.ts:107](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L107)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -256,7 +256,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L124)
|
[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L124)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -266,7 +266,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:113](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L113)
|
[models/line-item.ts:113](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L113)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -276,7 +276,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:116](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L116)
|
[models/line-item.ts:116](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L116)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -286,7 +286,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:87](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L87)
|
[models/line-item.ts:87](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L87)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -296,7 +296,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L125)
|
[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L125)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -306,7 +306,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L53)
|
[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L53)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -316,7 +316,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L49)
|
[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L49)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -326,7 +326,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:64](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L64)
|
[models/line-item.ts:64](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L64)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -336,7 +336,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L126)
|
[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L126)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -346,7 +346,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:78](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L78)
|
[models/line-item.ts:78](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L78)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -356,7 +356,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:72](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L72)
|
[models/line-item.ts:72](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L72)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -366,7 +366,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:127](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L127)
|
[models/line-item.ts:127](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L127)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -376,7 +376,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:96](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L96)
|
[models/line-item.ts:96](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L96)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -390,7 +390,7 @@ BaseEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -400,7 +400,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:104](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L104)
|
[models/line-item.ts:104](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L104)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -410,7 +410,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:100](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L100)
|
[models/line-item.ts:100](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L100)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -424,4 +424,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item.ts:133](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item.ts#L133)
|
[models/line-item.ts:133](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item.ts#L133)
|
||||||
@@ -18,7 +18,7 @@ displayed_sidebar: entitiesSidebar
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L45)
|
[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L45)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -28,7 +28,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L34)
|
[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L34)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -38,7 +38,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L38)
|
[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L38)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L42)
|
[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L42)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -58,7 +58,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L23)
|
[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L23)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -68,7 +68,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L31)
|
[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L31)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -78,7 +78,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L27)
|
[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L27)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -88,7 +88,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L48)
|
[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L48)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -102,4 +102,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-adjustment.ts#L50)
|
[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-adjustment.ts#L50)
|
||||||
@@ -32,7 +32,7 @@ TaxLine.code
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/tax-line.ts#L13)
|
[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ TaxLine.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -60,7 +60,7 @@ TaxLine.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -70,7 +70,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-tax-line.ts#L24)
|
[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-tax-line.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -80,7 +80,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-tax-line.ts#L20)
|
[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-tax-line.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -94,7 +94,7 @@ TaxLine.metadata
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/tax-line.ts#L16)
|
[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -108,7 +108,7 @@ TaxLine.name
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/tax-line.ts#L10)
|
[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L10)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -122,7 +122,7 @@ TaxLine.rate
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/tax-line.ts#L7)
|
[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/tax-line.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -136,7 +136,7 @@ TaxLine.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -150,4 +150,4 @@ TaxLine.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/line-item-tax-line.ts#L26)
|
[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/line-item-tax-line.ts#L26)
|
||||||
@@ -28,7 +28,7 @@ SoftDeletableEntity.constructor
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L27)
|
[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L27)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -42,7 +42,7 @@ SoftDeletableEntity.created\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L24)
|
[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L24)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -62,7 +62,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L20)
|
[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L20)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -76,7 +76,7 @@ SoftDeletableEntity.deleted\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -90,7 +90,7 @@ SoftDeletableEntity.id
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -100,7 +100,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L33)
|
[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L33)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -110,7 +110,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L30)
|
[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L30)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -120,7 +120,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L43)
|
[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L43)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -130,7 +130,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L36)
|
[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L36)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -140,7 +140,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L61)
|
[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L61)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -150,7 +150,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L57)
|
[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L57)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -164,7 +164,7 @@ SoftDeletableEntity.updated\_at
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -174,7 +174,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L53)
|
[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L53)
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -184,7 +184,7 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L47)
|
[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L47)
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
|
||||||
@@ -198,4 +198,4 @@ ___
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/7c6521101/packages/medusa/src/models/money-amount.ts#L63)
|
[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/models/money-amount.ts#L63)
|
||||||
Loaded 100 of 301 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user