asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Merge branch 'master' into develop

Browse Source
This commit is contained in:
olivermrbl committed 2022-08-24 12:30:33 +02:00
2 parents bda83a84bc 690ca9e89a
commit b7b0a7d3a4
160 files changed
+17116 -3239
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/content/add-plugins/minio.md
+68
View File
@@ -117,6 +117,74 @@ Run your Medusa server alongside the [Medusa Admin](../admin/quickstart.md) to t
![Image Uploaded on Admin](https://i.imgur.com/alabX2i.png)
## Additional Configuration for Exports
Medusa v1.3.3 introduced the Export API. For example, you can now export your products from the Medusa Admin on the Products page.
![Export button in Products page in Medusa Admin](https://i.imgur.com/uyK4id8.png)
:::note
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).
:::
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.
Then, add the following environment variable on your Medusa server:
```bash
MINIO_PRIVATE_BUCKET=exports
```
Finally, add a new option to the plugin’s options in `medusa-config.js`:
```jsx
{
resolve: `medusa-file-minio`,
options: {
//...
private_bucket: process.env.MINIO_PRIVATE_BUCKET
},
},
```
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.
![Export is available for download on the Medusa Admin](https://i.imgur.com/Xc61Wg1.png)
:::tip
If you face any errors, make sure you have the latest version of the plugin installed.
:::
### 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 want to use different keys, set the following environment variables:
```bash
MINIO_PRIVATE_ACCESS_KEY=<YOUR_PRIVATE_ACCESS_KEY>
MINIO_PRIVATE_SECRET_KEY=<YOUR_PRIVATE_SECRET_KEY>
```
Where `<YOUR_PRIVATE_ACCESS_KEY>` and `<YOUR_PRIVATE_SECRET_KEY>` are the access key and secret access key that have access to the private MinIO bucket.
Then, add two new options to the plugin’s options in `medusa-config.js`:
```jsx
{
resolve: `medusa-file-minio`,
options: {
//...
private_access_key_id: process.env.MINIO_PRIVATE_ACCESS_KEY,
private_secret_access_key: process.env.MINIO_PRIVATE_SECRET_KEY
},
},
```
## Next.js Storefront Configuration
If you’re using a [Next.js](../starters/nextjs-medusa-starter.md) storefront, you need to add an additional configuration that adds the MinIO domain name into the configured images domain names. This is because all URLs of product images will be from the MinIO server.
docs/content/add-plugins/paypal.md
+6 -6
View File
@@ -20,7 +20,7 @@ Webhooks are used in scenarios where the customer might leave the page during th
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.
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/auth).
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).
## Medusa Server
@@ -256,8 +256,8 @@ Here’s briefly what this code snippet does:
1. This component renders a PayPal button to initialize the payment using PayPal. You use the components from the PayPal React components library to render the button and you pass the `PayPalScriptProvider` component the Client ID.
2. When the button is clicked, the `handlePayment` function is executed. In this method, you initialize the payment authorization using `actions.order.authorize()`. It takes the customer to another page to log in with PayPal and authorize the payment.
3. After the payment is authorized successfully on PayPal’s portal, the fulfillment function passed to `actions.order.authorize().then` will be executed which calls the `completeOrder` function.
4. In `completeOrder`, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/cart/select-a-payment-session). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) data with the authorization data received from PayPal.
5. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/cart/complete-a-cart). If that is done successfully, you navigate to the `/order-confirmed` page.
4. In `completeOrder`, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) data with the authorization data received from PayPal.
5. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete). If that is done successfully, you navigate to the `/order-confirmed` page.
The last step is to add this component as the component to render when PayPal is available as a payment provider.
@@ -385,8 +385,8 @@ Here’s briefly what this code snippet does:
3. This component renders a PayPal button to initialize the payment using PayPal. You use the components from the PayPal React components library to render the button and you pass the `PayPalScriptProvider` component the Client ID. Make sure to replace `<CLIENT_ID>` with the environment variable you added.
4. When the button is clicked, the `handlePayment` function is executed. In this method, you initialize the payment authorization using `actions.order.authorize()`. It takes the customer to another page to log in with PayPal and authorize the payment.
5. After the payment is authorized successfully on PayPal’s portal, the fulfillment function passed to `actions.order.authorize().then` will be executed.
6. In the fulfillment function, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/cart/select-a-payment-session). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) data with the authorization data received from PayPal.
7. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/cart/complete-a-cart). If that is done successfully, you just show a success alert. You can change this based on the behavior you want in your storefront.
6. In the fulfillment function, you first ensure that the payment session for the PayPal payment provider is set as the [selected Payment Session in the cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession). Then, you send a request to the server to [update the payment session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) data with the authorization data received from PayPal.
7. You then [complete the cart and place the order](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete). If that is done successfully, you just show a success alert. You can change this based on the behavior you want in your storefront.
You can then import this component where you want to show it in your storefront.
@@ -406,4 +406,4 @@ Refunding or Capturing payments is reflected in your PayPal dashboard as well.
## What's Next 🚀
- Check out [more plugins](https://github.com/medusajs/medusa/tree/master/packages) you can add to your store.
- Check out [more plugins](https://github.com/medusajs/medusa/tree/master/packages) you can add to your store.
docs/content/add-plugins/s3.md
+1 -1
View File
@@ -150,7 +150,7 @@ You can also check that the image was uploaded on the S3 bucket’s page.
## Next.js Storefront Configuration
If you’re using a [Next.js](../starters/nextjs-medusa-starter.md storefront, you need to add an additional configuration that adds the S3 bucket domain name into the configured images’ domain names. This is because all URLs of product images will be from the S3 bucket.
If you’re using a [Next.js](../starters/nextjs-medusa-starter.md) storefront, you need to add an additional configuration that adds the S3 bucket domain name into the configured images’ domain names. This is because all URLs of product images will be from the S3 bucket.
If this configuration is not added, you’ll receive the error ["next/image Un-configured Host”](https://nextjs.org/docs/messages/next-image-unconfigured-host).
docs/content/add-plugins/stripe.md
+3 -3
View File
@@ -171,10 +171,10 @@ This section will go over how to add Stripe into a React-based framework. The in
The integration with stripe must have the following workflow:
1. During checkout when the user reaches the payment section, you should [create payment sessions](https://docs.medusajs.com/api/store/cart/initialize-payment-sessions). This will initialize the `payment_sessions` array in the `cart` object received. The `payment_sessions` is an array of available payment providers.
2. If Stripe is available as a payment provider, you should select Stripe as [the payment session](https://docs.medusajs.com/api/store/cart/select-a-payment-session) for the current cart. This will initialize the `payment_session` object in the `cart` object to include data related to Stripe and the current payment session. This includes the payment intent and client secret.
1. During checkout when the user reaches the payment section, you should [create payment sessions](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessions). This will initialize the `payment_sessions` array in the `cart` object received. The `payment_sessions` is an array of available payment providers.
2. If Stripe is available as a payment provider, you should select Stripe as [the payment session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession) for the current cart. This will initialize the `payment_session` object in the `cart` object to include data related to Stripe and the current payment session. This includes the payment intent and client secret.
3. After the user enters their card details and submits the form, confirm the payment with Stripe.
4. If the payment is confirmed successfully, [complete the order](https://docs.medusajs.com/api/store/cart/complete-a-cart) in Medusa. Otherwise show an error.
4. If the payment is confirmed successfully, [complete the order](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete) in Medusa. Otherwise show an error.
#### Install Dependencies
docs/content/advanced/backend/entities.md
+3 -3
View File
@@ -112,7 +112,7 @@ npm run build
You can access your custom entity data in the database in services or subscribers using the repository. For example, here’s a service that lists all posts:
```tsx
import { TransactionBaseService } from "medusa-interfaces";
import { TransactionBaseService } from '@medusajs/medusa';
class PostService extends TransactionBaseService {
constructor({ postRepository, manager }) {
@@ -155,6 +155,6 @@ await postRepository.softDelete(post.id);
## What’s Next 🚀
- Check out Medusa's entities in the [Entities' reference](../../references/entities/classes/Address.md).
- Learn about [migrations](migrations.md).
- Learn more about [Services](services/create-service.md) and how to use them.
- Learn how to create an endpoint for [storefront](endpoints/add-storefront.md) and [admin](endpoints/add-admin.md).
- Learn about [migrations](migrations.md).
docs/content/advanced/backend/notification/how-to-create-notification-provider.md
+5 -5
View File
@@ -154,7 +154,7 @@ The `to` and `data` properties are used in the `NotificationService` in Medusa
### resendNotification
Using the [Resend Notification endpoint](https://docs.medusajs.com/api/admin/notification/resend-notification), 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:
@@ -236,7 +236,7 @@ Then, start by running your Medusa server:
npm run start
```
Then, place an order either using the [REST APIs](https://docs.medusajs.com/api/store/auth) or using the storefront.
Then, place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the storefront.
:::tip
@@ -248,17 +248,17 @@ After placing an order, you can see in your console the message “Notification
## Test Resending Notifications with your Notification Provider
To test resending a notification, first, retrieve the ID of the notification you just sent using the [List Notifications admin endpoint](https://docs.medusajs.com/api/admin/notification/list-notifications). You can pass as a body parameter the `to` or `event_name` parameters to filter out the notification you just sent.
To test resending a notification, first, retrieve the ID of the notification you just sent using the [List Notifications admin endpoint](https://docs.medusajs.com/api/admin/#tag/Notification/operation/GetNotifications). You can pass as a body parameter the `to` or `event_name` parameters to filter out the notification you just sent.
:::tip
You must be authenticated as an admin user before sending this request. You can use the [Authenticate a User](https://docs.medusajs.com/api/admin/auth/) endpoint to get authenticated.
You must be authenticated as an admin user before sending this request. You can use the [Authenticate a User](https://docs.medusajs.com/api/admin) endpoint to get authenticated.
:::
![List Notifications Request](https://i.imgur.com/iF1rZX1.png)
Then, send a request to the [Resend Notification](https://docs.medusajs.com/api/admin/notification/resend-notification) endpoint using the ID retrieved from the previous request. You can pass the `to` parameter in the body to change the receiver of the notification. You should see the message “Notification Resent” in your console and if you implemented your own logic for resending the notification it will be resent.
Then, send a request to the [Resend Notification](https://docs.medusajs.com/api/admin/#tag/Notification/operation/PostNotificationsNotificationResend) endpoint using the ID retrieved from the previous request. You can pass the `to` parameter in the body to change the receiver of the notification. You should see the message “Notification Resent” in your console and if you implemented your own logic for resending the notification it will be resent.
![Resend Notifications Request](https://i.imgur.com/0zFfPed.png)
docs/content/advanced/backend/payment/how-to-create-payment-provider.md
+9 -9
View File
@@ -24,7 +24,7 @@ The Payment Provider service is also required to implement the following methods
2. `retrievePayment`: Used to retrieve payment data from the third-party provider, if there’s any.
3. `getStatus`: Used to get the status of a Payment or Payment Session.
4. `updatePayment`: Used to update the Payment Session whenever the cart and its related data are updated.
5. `updatePaymentData`: Used to update the `data` field of Payment Sessions. Specifically called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) endpoint.
5. `updatePaymentData`: Used to update the `data` field of Payment Sessions. Specifically called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) endpoint.
6. `deletePayment`: Used to perform any action necessary before a Payment Session is deleted.
7. `authorizePayment`: Used to authorize the payment amount of the cart before the order or swap is created.
8. `getPaymentData`: Used to retrieve the data that should be stored in the `data` field of a new Payment instance after the payment amount has been authorized.
@@ -72,7 +72,7 @@ As mentioned in the overview, Payment Providers should have a static `identifie
The `PaymentProvider` entity has 2 properties: `identifier` and `is_installed`. The value of the `identifier` property in the class will be used when the Payment Provider is created in the database.
The value of this property will also be used to reference the Payment Provider throughout the Medusa server. For example, the identifier is used when a [Payment Session in a cart is selected on checkout](https://docs.medusajs.com/api/store/cart/select-a-payment-session).
The value of this property will also be used to reference the Payment Provider throughout the Medusa server. For example, the identifier is used when a [Payment Session in a cart is selected on checkout](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession).
### constructor
@@ -90,7 +90,7 @@ constructor({}, options) {
### createPayment
This method is called during checkout when [Payment Sessions are initialized](https://docs.medusajs.com/api/store/cart/initialize-payment-sessions) to present payment options to the customer. It is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to initialize a Payment Intent for the customer.
This method is called during checkout when [Payment Sessions are initialized](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessions) to present payment options to the customer. It is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to initialize a Payment Intent for the customer.
The method receives the cart as an object for its first parameter. It holds all the necessary information you need to know about the cart and the customer that owns this cart.
@@ -155,7 +155,7 @@ This code block assumes the status is stored in the `data` field as demonstrated
### updatePayment
This method is used to perform any necessary updates on the payment. This method is called whenever the cart or any of its related data is updated. For example, when a [line item is added to the cart](https://docs.medusajs.com/api/store/cart/add-a-line-item) or when a [shipping method is selected](https://docs.medusajs.com/api/store/cart/add-a-shipping-method).
This method is used to perform any necessary updates on the payment. This method is called whenever the cart or any of its related data is updated. For example, when a [line item is added to the cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartLineItems) or when a [shipping method is selected](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod).
:::tip
@@ -179,7 +179,7 @@ async updatePayment(sessionData, cart) {
### updatePaymentData
This method is used to update the `data` field of a Payment Session. Particularly, it is called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) endpoint. This endpoint receives a `data` object in the body of the request that should be used to update the existing `data` field of the Payment Session.
This method is used to update the `data` field of a Payment Session. Particularly, it is called when a request is sent to the [Update Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) endpoint. This endpoint receives a `data` object in the body of the request that should be used to update the existing `data` field of the Payment Session.
This method accepts the current `data` field of the Payment Session as the first parameter, and the new `data` field sent in the body request as the second parameter.
@@ -199,8 +199,8 @@ async updatePaymentData(sessionData, updatedData) {
This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases:
1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store/cart/delete-a-payment-session).
2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store/cart/refresh-a-payment-session). The Payment Session is deleted so that a newer one is initialized instead.
1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/DeleteCartsCartPaymentSessionsSession).
2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionsSession). The Payment Session is deleted so that a newer one is initialized instead.
3. When the Payment Provider is no longer available. This generally happens when the store operator removes it from the available Payment Provider in the admin.
4. When the region of the store is changed based on the cart information and the Payment Provider is not available in the new region.
@@ -218,7 +218,7 @@ async deletePayment(paymentSession) {
### authorizePayment
This method is used to authorize payment using the Payment Session for an order. This is called when the [cart is completed](https://docs.medusajs.com/api/store/cart/complete-a-cart) and before the order is created.
This method is used to authorize payment using the Payment Session for an order. This is called when the [cart is completed](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete) and before the order is created.
This method is also used for authorizing payments of a swap of an order.
@@ -347,7 +347,7 @@ async cancelPayment(payment) {
This method can be added to your Payment Provider service if your third-party provider supports saving the customer’s payment methods. Please note that in Medusa there is no way to save payment methods.
This method is called when a request is sent to [Retrieve Saved Payment Methods](https://docs.medusajs.com/api/store/customer/retrieve-saved-payment-methods).
This method is called when a request is sent to [Retrieve Saved Payment Methods](https://docs.medusajs.com/api/store/#tag/Customer/operation/GetCustomersCustomerPaymentMethods).
This method accepts the customer as an object for its first parameter.
docs/content/advanced/backend/services/create-service.md
+4 -4
View File
@@ -12,7 +12,7 @@ Services in Medusa represent bundled helper methods that you want to use across
For example, you can use Medusa’s `productService` to get the list of products, as well as perform other functionalities related to products. There’s also an `authService` that provides functionalities like authenticating customers and users.
Custom services reside in the `src/services` directory of your Medusa Server installation. Each service should be a class that extends the `BaseService` class from `medusa-interfaces`.
Custom services reside in the `src/services` directory of your Medusa Server installation. Each service should be a class that extends the `TransactionBaseService` class from the core Medusa package `@medusajs/medusa`.
Each file you create in `src/services` should hold one service and export it.
@@ -29,9 +29,9 @@ To create a service, you should create a JavaScript file in `src/services` to ho
For example, if you want to create a service `helloService`, create the file `hello.js` in `src/services` with the following content:
```js
import { BaseService } from "medusa-interfaces"
import { TransactionBaseService } from '@medusajs/medusa';
class HelloService extends BaseService {
class HelloService extends TransactionBaseService {
getMessage() {
return `Welcome to My Store!`
}
@@ -42,7 +42,7 @@ export default HelloService
## Service Constructor
As the service extends the `BaseService` class, all services in Medusa’s core, as well as all your custom services, will be available in your service’s constructor using dependency injection.
As the service extends the `TransactionBaseService` class, all services in Medusa’s core, as well as all your custom services, will be available in your service’s constructor using dependency injection.
So, if you want your service to use another service, simply add it as part of your constructor’s dependencies and set it to a field inside your service’s class:
docs/content/advanced/backend/shipping/add-fulfillment-provider.md
+7 -7
View File
@@ -47,7 +47,7 @@ As mentioned in the overview, fulfillment providers should have a static `identi
The `FulfillmentProvider` entity has 2 properties: `identifier` and `is_installed`. The `identifier` property in the class will be used when the fulfillment provider is created in the database.
The value of this property will also be used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin/region/add-fulfillment-provider) to a region.
The value of this property will also be used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin/#tag/Region/operation/PostRegionsRegionFulfillmentProviders) to a region.
```jsx
import { FulfillmentService } from "medusa-interfaces"
@@ -102,7 +102,7 @@ For that reason, the fulfillment option does not have any required structure and
### validateOption
Once the admin creates the shipping option, the data will be validated first using this method in the underlying fulfillment provider of that shipping option. This method is called when a `POST` request is sent to `[/admin/shipping-options](https://docs.medusajs.com/api/admin/shipping-option/create-shipping-option)`.
Once the admin creates the shipping option, the data will be validated first using this method in the underlying fulfillment provider of that shipping option. This method is called when a `POST` request is sent to [`/admin/shipping-options`](https://docs.medusajs.com/api/admin/#tag/Shipping-Option/operation/PostShippingOptions).
This method accepts the `data` object that is sent in the body of the request. You can use this data to validate the shipping option before it is saved.
@@ -122,7 +122,7 @@ If your fulfillment provider does not need to run any validation, you can simply
When the customer chooses a shipping option on checkout, the shipping option and its data are validated before the shipping method is created.
`validateFulfillmentOption` is called when a `POST` request is sent to `[/carts/:id/shipping-methods](https://docs.medusajs.com/api/store/cart/add-a-shipping-method)`.
`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:
@@ -196,7 +196,7 @@ If this method returns `true`, that means that the price should be calculated dy
If the method returns `false`, an error is thrown as it means the selected shipping option can only be chosen if the price type is set to `flat_rate`.
This method receives as a parameter the `data` object sent with the request that [creates the shipping option.](https://docs.medusajs.com/api/admin/shipping-option/create-shipping-option) You can use this data to determine whether the shipping option should be calculated or not. This is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options.
This method receives as a parameter the `data` object sent with the request that [creates the shipping option.](https://docs.medusajs.com/api/admin/#tag/Shipping-Option/operation/PostShippingOptions) You can use this data to determine whether the shipping option should be calculated or not. This is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options.
For example:
@@ -213,7 +213,7 @@ This method is called on checkout when the shipping method is being created if t
This method receives 3 parameters:
1. The `data` parameter of the selected shipping option.
2. The `data` parameter sent with [the request](https://docs.medusajs.com/api/store/cart/add-a-shipping-method).
2. The `data` parameter sent with [the request](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod).
3. The customer’s cart data.
If your fulfillment provider does not provide any dynamically calculated rates you can keep the function empty:
@@ -236,7 +236,7 @@ calculatePrice (optionData, data, cart) {
Fulfillment providers can also be used to return products. A shipping option can be used for returns if the `is_return` property is `true` or if an admin creates a Return Shipping Option from the settings.
This method is called when the admin [creates a return request](https://docs.medusajs.com/api/admin/order/request-a-return) for an order or when the customer [creates a return of their order](https://docs.medusajs.com/api/store/return/create-return).
This method is called when the admin [creates a return request](https://docs.medusajs.com/api/admin/#tag/Order/operation/PostOrdersOrderReturns) for an order or when the customer [creates a return of their order](https://docs.medusajs.com/api/store/#tag/Return/operation/PostReturns).
It gives you access to the return being created in case you need to perform any additional actions with the third-party provider.
@@ -269,4 +269,4 @@ cancelFulfillment(fulfillment) {
## What’s Next 🚀
- Check out the [Webshipper plugin](https://github.com/medusajs/medusa/tree/cab5821f55cfa448c575a20250c918b7fc6835c9/packages/medusa-fulfillment-webshipper) for an example of a fulfillment provider that interacts with a third-party providers.
- Check out the [manual fulfillment plugin](https://github.com/medusajs/medusa/tree/cab5821f55cfa448c575a20250c918b7fc6835c9/packages/medusa-payment-manual) for a basic implementation of a fulfillment provider.
- Check out the [manual fulfillment plugin](https://github.com/medusajs/medusa/tree/cab5821f55cfa448c575a20250c918b7fc6835c9/packages/medusa-payment-manual) for a basic implementation of a fulfillment provider.
docs/content/advanced/storefront/how-to-implement-checkout-flow.mdx
+13 -10
View File
@@ -16,7 +16,9 @@ It’s recommended to go through the [Shipping Architecture Overview](../backend
## Prerequisites
This document assumes you’ve already taken care of the add-to-cart flow. So, you should have a [cart created](https://docs.medusajs.com/api/store/cart/create-a-cart) for the customer with at least [one product in it](https://docs.medusajs.com/api/store/cart/add-a-line-item).
This document assumes you’ve already taken care of the add-to-cart flow. So, you should have a [cart created](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCart) for the customer with at least [one product in it](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartLineItems).
You can learn how to implement the cart flow using [this documentation](../../guides/carts-in-medusa.mdx).
To follow along with this tutorial, you can make use of the [Medusa JS Client](https://www.npmjs.com/package/@medusajs/medusa-js). You can install it with this command:
@@ -32,7 +34,7 @@ In this step, the customer generally enters their shipping info, then chooses th
### Add Shipping Address
After the customer enters their shipping address information, you must send a `POST` request to the [Update a Cart](https://docs.medusajs.com/api/store/cart/update-a-cart) API endpoint passing it the new shipping address:
After the customer enters their shipping address information, you must send a `POST` request to the [Update a Cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCart) API endpoint passing it the new shipping address:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
@@ -92,7 +94,7 @@ You can have access to the updated cart in `response.cart`, which now has the sh
### List Shipping Options
After updating the cart with the customer’s address, the list of available [shipping options](../backend/shipping/overview.md#shipping-option) for that cart might change. So, you should retrieve the updated list of options by sending a `GET` request to the [Retrieve Shipping Options for Cart API](https://docs.medusajs.com/api/store/shipping-option/retrieve-shipping-options-for-cart) endpoint:
After updating the cart with the customer’s address, the list of available [shipping options](../backend/shipping/overview.md#shipping-option) for that cart might change. So, you should retrieve the updated list of options by sending a `GET` request to the [Retrieve Shipping Options for Cart API](https://docs.medusajs.com/api/store/#tag/Shipping-Option/operation/GetShippingOptionsCartId) endpoint:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
@@ -118,13 +120,13 @@ fetch(`<SERVER_URL>/store/shipping-options/${cart.id}`)
</TabItem>
</Tabs>
You can access all shipping options available with their info in `response.shipping_options` which is an array of [shipping options](https://docs.medusajs.com/api/store/shipping-option). Typically you would display those options to the customer to choose from.
You can access all shipping options available with their info in `response.shipping_options` which is an array of [shipping options](https://docs.medusajs.com/api/store/#tag/Shipping-Option/operation/GetShippingOptions). Typically you would display those options to the customer to choose from.
### Choose Shipping Option
Once the customer chooses one of the available shipping options, send a `POST` request to the [Add a Shipping Method](https://docs.medusajs.com/api/store/cart/add-a-shipping-method) API endpoint. This will create a [shipping method](../backend/shipping/overview.md#shipping-method) based on the shipping option chosen and will associate it with the customer’s cart:
Once the customer chooses one of the available shipping options, send a `POST` request to the [Add a Shipping Method](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartShippingMethod) API endpoint. This will create a [shipping method](../backend/shipping/overview.md#shipping-method) based on the shipping option chosen and will associate it with the customer’s cart:
<Tabs groupId="request-tyoe">
<Tabs groupId="request-type">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
@@ -166,7 +168,7 @@ In this step, the customer generally chooses a payment method to complete their
When the page opens and before the payment providers are displayed to the customer to choose from, you must initialize the [payment sessions](./../backend/payment/overview.md#payment-session) for the current cart. Each payment provider will have a payment session associated with it. These payment sessions will be used later when the customer chooses the payment provider they want to complete their purchase with.
To initialize the payment sessions, send a `POST` request to the [Initialize Payment Sessions](https://docs.medusajs.com/api/store/cart/initialize-payment-sessions) API endpoint:
To initialize the payment sessions, send a `POST` request to the [Initialize Payment Sessions](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessions) API endpoint:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
@@ -197,7 +199,7 @@ You can then access the initialized payment sessions under the `payment_sessions
### Select Payment Session
When the customer chooses the payment provider they want to complete purchase with, you should select the payment session associated with that payment provider. To do that, send a `POST` request to the [Select a Payment Session](https://docs.medusajs.com/api/store/cart/select-a-payment-session) API endpoint:
When the customer chooses the payment provider they want to complete purchase with, you should select the payment session associated with that payment provider. To do that, send a `POST` request to the [Select a Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSession) API endpoint:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
@@ -243,7 +245,7 @@ If you have one payment provider or if only one payment provider is available fo
This step is optional and is only necessary for some payment providers. As mentioned in the [Payment Architecture](../backend/payment/overview.md#overview) documentation, the `PaymentSession` model has a `data` attribute that holds any data required for the Payment Provider to perform payment operations such as capturing payment.
If you need to update that data at any point before the purchase is made, send a request to [Update a Payment Session](https://docs.medusajs.com/api/store/cart/update-a-payment-session) API endpoint passing it the updated data object:
If you need to update that data at any point before the purchase is made, send a request to [Update a Payment Session](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartPaymentSessionUpdate) API endpoint passing it the updated data object:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
@@ -291,7 +293,7 @@ You can have access to the updated data in the payment session in `response.cart
The last step is to place the order by completing the cart. When you complete the cart, your Medusa server will try to authorize the payment first, then place the order if the authorization is successful. So, you should perform any necessary action with your payment provider first to make sure the authorization is successful when you send the request to complete the cart.
To complete a cart, send a `POST` request to the [Complete a Cart](https://docs.medusajs.com/api/store/cart/complete-a-cart) API endpoint:
To complete a cart, send a `POST` request to the [Complete a Cart](https://docs.medusajs.com/api/store/#tag/Cart/operation/PostCartsCartComplete) API endpoint:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
@@ -325,5 +327,6 @@ If the order is placed successfully, you can access the order data in `response.
## What’s Next 🚀
- Learn more about the [JS Client and how to use it](../../js-client/overview.md).
- Check out available plugins for popular payment providers such as [Stripe](../../add-plugins/stripe.md) and [PayPal](/add-plugins/paypal.md).
- Learn more about the [Payment](../backend/payment/overview.md) and [Shipping](../backend/shipping/overview.md) Architectures.
docs/content/guides/carts-in-medusa.md
-163
View File
@@ -1,163 +0,0 @@
---
title: Carts
---
# Carts
In Medusa a Cart serves the purpose of collecting the information needed to create an Order, including what products to purchase, what address to send the products to and which payment method the purchase will be processed by.
To create a cart using the `@medusajs/medusa-js` SDK you can use:
```javascript
const client = new Medusa({ baseUrl: "http://localhost:9000" })
const { cart } = await client.carts.create()
```
A Cart will always belong to a Region and you may provide a `region_id` upon Cart creation. If no `region_id` is specified Medusa will assign the Cart to a random Region. Regions specify information about how the Cart should be taxed, what currency the Cart should be paid with and what payment and fulfillment options will be available at checkout. Below are some of the properties that can be found on the Cart response. For a full example of a Cart response [check our fixtures](https://github.com/medusajs/medusa/blob/docs/api/docs/api/fixtures/store/GetCartsCart.json).
```json
"cart": {
"id": "cart_01FEWZSRFWT8QWMHJ7ZCPRP3BZ",
"email": null,
"billing_address": null,
"shipping_address": null,
"items": [ ... ],
"region": {
"id": "reg_01FEWZSRD7HVHBSQRC4KYMG5XM",
"name": "United States",
"currency_code": "usd",
"tax_rate": "0",
...
},
"discounts": [],
"gift_cards": [],
"customer_id": null,
"payment_sessions": [],
"payment": null,
"shipping_methods": [],
"type": "default",
"metadata": null,
"shipping_total": 0,
"discount_total": 0,
"tax_total": 0,
"gift_card_total": 0,
"subtotal": 1000,
"total": 1000,
...
}
```
## Adding products to the Cart
Customers can add products to the Cart in order to start gathering the items that will eventually be purchased. In Medusa adding a product to a Cart will result in a _Line Item_ being generated. To add a product using the SDK use:
```javascript
const { cart } = await client.carts.lineItems.create(cartId, {
variant_id: "[id-of-variant-to-add]",
quantity: 1,
})
```
The resulting response will look something like this:
```json
{
"cart": {
"id": "cart_01FEWZSRFWT8QWMHJ7ZCPRP3BZ",
"items": [
{
"id": "item_01FEWZSRMBAN85SKPCRMM30N6W",
"cart_id": "cart_01FEWZSRFWT8QWMHJ7ZCPRP3BZ",
"title": "Basic Tee",
"description": "Small",
"thumbnail": null,
"is_giftcard": false,
"should_merge": true,
"allow_discounts": true,
"has_shipping": false,
"unit_price": 1000,
"variant": {
"id": "variant_01FEWZSRDNWABVFZTZ21JWKHRG",
"title": "Small",
"product_id": "prod_01FEWZSRDHDDSHQV6ATG6MS2MF",
"sku": null,
"barcode": null,
"ean": null,
"upc": null,
"allow_backorder": false,
"hs_code": null,
"origin_country": null,
"mid_code": null,
"material": null,
"weight": null,
"length": null,
"height": null,
"width": null,
"metadata": null,
...
},
"quantity": 1,
"metadata": {},
...
}
],
...
}
}
```
The properties stored on a Line Item are useful for explaining and displaying the contents of the Cart. For example, Line Items can have a thumbnail assigned which can be used to display a pack shot of the product that is being purchased, a title to show name the products in the cart and a description to give further details about the product. By default the Line Item will be generated with properties inherited from the Product that is being added to the Cart, but the behaviour can be customized for other purposes as well.
## Adding Customer information to a Cart
After adding products to the Cart, you should gather information about where to send the products, this is done using the `update` method in the SDK.
```javascript
const { cart } = await client.carts.update(cartId, {
email: "jane.doe@mail.com",
shipping_address: {
first_name: "Jane",
last_name: "Doe",
address_1: "4242 Hollywood Dr",
postal_code: "12345",
country_code: "us",
city: "Los Angeles",
region: "CA",
},
})
```
Note that the country code in the shipping address must be the country code for one of the countries in a Region - otherwise this method will fail.
## Initializing Payment Sessions
In Medusa payments are handled through the long lived entities called _Payment Sessions_. Payment Sessions cary provider specific data that can later be used to authorize the payments, which is the step required before an order can be created. The SDK provides a `createPaymentSessions` method that can be used to initialize the payment sessions with the Payment Providers available in the Region.
```javascript
const { cart } = await client.carts.createPaymentSessions(cartId)
```
You can read more about Payment Sessions in our [guide to checkouts](https://docs.medusajs.com/guides/checkouts).
## Changing the Cart region
To update the Region that the cart belongs to you should also use the `update` method from the SDK.
```javascript
const { cart } = await client.carts.update(cartId, {
region_id: "[id-of-region-to-switch-to]",
})
```
When changing the Cart region you should be aware of a couple of things:
- If switching to a Region with a different currency the line item prices and cart totals will change
- If switching to a Region with a different tax rate prices and totals will change
- If switching to a Region serving only one country the `shipping_address.country_code` will automatically be set to that country
- If the Cart already has initialized payment sessions all of these will be canceled and a new call to `createPaymentSessions` will have to be made
## What's next?
Carts are at the core of the shopping process in Medusa and provide all the necessary functionality to gather products for purchase. If you want to read a more detailed guide about how to complete checkouts please go to our [Checkout Guide](https://docs.medusajs.com/guides/checkout).
If you have questions or issues feel free to reach out via our [Discord server](https://discord.gg/xpCwq3Kfn8) for direct access to the Medusa engineering team.
docs/content/guides/carts-in-medusa.mdx
+404
View File
@@ -0,0 +1,404 @@
# How to Add Cart Functionality
This document guides you through how you can add cart-related functionalities to your storefront. That includes creating and updating a cart and managing items in the cart.
## Overview
Carts are necessary for ecommerce platforms to allow customers to buy products. Each customer, whether logged in or as a guest, should have a cart associated with them. The customer can then add products to the cart.
This document helps you understand how to add the cart functionality to your storefront. This is helpful if you’re creating the storefront from scratch, or you want to understand how the process generally works in Medusa’s starter storefronts.
:::note
This document does not cover implementing the checkout flow. You can refer to [this documentation instead to learn how to implement the checkout flow](../advanced/storefront/how-to-implement-checkout-flow.mdx).
:::
### Glossary
- **Line Item**: When products are added to the cart in Medusa, they are referred to as line items. Line items have, by default, the same properties and attributes as a product. However, you can customize line items specifically for a cart if necessary.
## Prerequisites
It is assumed you already have a Medusa server installed before following along with this tutorial. If not, you can get started in minutes by following the [quickstart guide](../quickstart/quick-start.md).
It is also assumed you already have a storefront set up. It can be a custom storefront or one of Medusa’s storefronts. If you don’t have a storefront set up, you can install either the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
## Install the JS Client
It is recommended to use Medusa’s JS Client in your storefront. You can install it using the following command:
```bash npm2yarn
npm install @medusajs/medusa-js
```
:::note
This document alternatively shows code examples using [JavaScript’s Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch). Make sure to replace `<SERVER_URL>` in those examples with your server URL.
:::
Then, initialize the Medusa JS Client in a single file that all of your components can access:
```jsx
import Medusa from '@medusajs/medusa-js';
export const client = new Medusa({
baseUrl: '<SERVER_URL>',
maxRetries: 3
});
```
Where `<SERVER_URL>` is the URL of your server. If you’re using a local server, it runs on `http://localhost:9000` by default.
:::caution
Make sure to include `http://` in the URL when sending requests to the local server. Otherwise, all requests will fail.
:::
## Create a Cart
You can create a cart with the following code snippet:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.create()
.then(({cart}) => {
localStorage.setItem('cart_id', cart.id);
//assuming you have a state variable to store the cart
setCart(cart);
});
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts`, {
method: 'POST'
})
.then((response) => response.json())
.then(({cart}) => {
localStorage.setItem('cart_id', cart.id);
//assuming you have a state variable to store the cart
setCart(cart)
});
```
</TabItem>
</Tabs>
A cart will be created with a random region assigned to it.
:::note
The region a cart is associated with determines the currency the cart uses, the tax, payment, and fulfillment providers, and other details and options. So, make sure you use the correct region for a cart.
:::
Otherwise, you can assign it a specific region during creation:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.create({
region_id
})
.then(({cart}) => {
localStorage.setItem('cart_id', cart.id);
//assuming you have a state variable to store the cart
setCart(cart);
});
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
region_id
})
})
.then((response) => response.json())
.then(({cart}) => {
localStorage.setItem('cart_id', cart.id);
//assuming you have a state variable to store the cart
setCart(cart)
});
```
</TabItem>
</Tabs>
To learn about what parameters you can pass during the cart’s creation, check out the [JS Client Reference](../references/js-client/classes/CartsResource.md#create) or the [API Reference](/api/store#tag/Cart/operation/PostCart).
## Retrieve a Cart
Notice that in the previous code snippets, you set the cart’s ID in the local storage. This is helpful to persist the customer’s cart even when they leave the website and come back later.
You can retrieve the cart at any given point using its ID with the following code snippet:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
const id = localStorage.getItem('cart_id');
if (id) {
client.carts.retrieve(id)
.then(({cart}) => setCart(cart));
}
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
const id = localStorage.getItem('cart_id');
if (id) {
fetch(`<SERVER_URL>/store/carts/${id}`)
.then((response) => response.json())
.then(({cart}) => setCart(cart));
}
```
</TabItem>
</Tabs>
You can run this code snippet every time the storefront is opened. If a customer has a cart ID stored in their local storage, it’s loaded from the server.
:::tip
Make sure to remove the ID from the local storage after the customer places an order with this cart.
:::
## Update a Cart
A cart has different data associated with it including the region, email, address, customer, and more.
You can use the following snippet to update any of the cart’s data:
```jsx
client.carts.update(cart.id, {
region_id
})
.then(({cart}) => setCart(cart));
```
```jsx
fetch(`<SERVER_URL>/store/carts/${cart.id}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
region_id
})
})
.then((response) => response.json())
.then(({cart}) => setCart(cart));
```
This updates the region in the cart.
To find out what data you can update in the cart, check out the [JS Client reference](../references/js-client/classes/CartsResource.md#update) or the [API reference](/api/store/#tag/Cart/operation/PostCartsCart).
### Associate a Logged-In Customer with the Cart
A customer might add items to their cart, then creates an account or log in. In that case, you should ensure that the cart is associated with the logged-in customer moving forward.
This can be done using the same update operation:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.update(cart.id, {
customer_id
})
.then(({cart}) => setCart(cart));
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts/${cart.id}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
customer_id
})
})
.then((response) => response.json())
.then(({cart}) => setCart(cart));
```
</TabItem>
</Tabs>
This updates the `customer_id` associated with the cart to make sure it belongs to a specific customer.
### Associate Guest Customers with a Cart using Email
In case the customer does not want to use their own account, you must at least associate an email address with the cart before completing the cart and placing the order.
This can be done using the same update operation:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.update(cart.id, {
email: 'user@example.com'
})
.then(({cart}) => setCart(cart));
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts/${cart.id}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: 'user@example.com'
})
})
.then((response) => response.json())
.then(({cart}) => setCart(cart));
```
</TabItem>
</Tabs>
## Add Line Item to the Cart
To create a line item of a product and add it to a cart, you can use the following code snippet:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.lineItems.create(cart.id, {
variant_id,
quantity: 1
})
.then(({cart}) => setCart(cart));
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts/${cart.id}/line-items`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
variant_id,
quantity: 1
})
})
.then((response) => response.json())
.then(({cart}) => setCart(cart));
```
</TabItem>
</Tabs>
Where `variant_id` is the variant of the product you want to add to the cart.
:::note
If you’re using Sales Channels, make sure that the cart and the product belong to the same sales channel. You can update the cart’s sales channel by [updating the cart](#update-a-cart).
:::
This adds a new line item to the cart. Line items can be accessed using `cart.items` which is an array that holds all line items in the cart. You can learn more about what properties line items have in the [API reference](/api/store/#tag/Cart/operation/PostCartsCartLineItems).
## Update Line Item in the Cart
To update a line item in the cart, you can use the following code snippet:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.lineItems.update(cart.id, line_item_id, {
quantity: 3
})
.then(({cart}) => setCart(cart))
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts/${cart.id}/line-items/${line_item_id}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
quantity: 3
})
})
.then((response) => response.json())
.then(({cart}) => setCart(cart));
```
</TabItem>
</Tabs>
This updates the quantity of the line item in the cart using the item’s ID.
## Delete a Line Item from the Cart
To delete a line item from the cart, you can use the following code snippet:
<Tabs groupId="request-tyoe">
<TabItem value="client" label="Medusa JS Client" default>
```jsx
client.carts.lineItems.delete(cart.id, line_item_id)
.then(({cart}) => setCart(cart))
```
</TabItem>
<TabItem value="fetch" label="Fetch API">
```jsx
fetch(`<SERVER_URL>/store/carts/${cart.id}/line-items/${line_item_id}`, {
method: 'DELETE'
})
.then((response) => response.json())
.then(({cart}) => setCart(cart));
```
</TabItem>
</Tabs>
This deletes a line item from the cart using the item’s ID.
## What’s Next 🚀
- Learn [how to implement the checkout flow in your storefront](../advanced/storefront/how-to-implement-checkout-flow.mdx).
- Learn more about the [JS Client and how to use it](../js-client/overview.md).
docs/content/homepage.md
+1 -1
View File
@@ -56,7 +56,7 @@ 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.
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/collection).
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).
## What’s Next 🚀
docs/content/introduction.md
+2 -2
View File
@@ -20,8 +20,8 @@ The admin dashboard is accessible by store operators. Store operators can use th
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.
You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin/auth).
You can also create your own admin dashboard by utilizing the [Admin REST APIs](https://docs.medusajs.com/api/admin).
### 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/auth).
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/).
docs/content/quickstart/quick-start.md
+1 -1
View File
@@ -81,5 +81,5 @@ You can learn more about configuring your server and loading environment variabl
- Install our [Next.js](../starters/nextjs-medusa-starter) or [Gatsby](../starters/gatsby-medusa-starter) 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) 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.
docs/content/references/entities/.nojekyll
+1
View File
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
docs/content/references/entities/classes/Address.md
+231
View File
@@ -0,0 +1,231 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Address
## Hierarchy
- `SoftDeletableEntity`
↳ **`Address`**
## Constructors
### constructor
• **new Address**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### address\_1
• **address\_1**: ``null`` \| `string`
#### Defined in
[models/address.ts:120](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L120)
___
### address\_2
• **address\_2**: ``null`` \| `string`
#### Defined in
[models/address.ts:123](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L123)
___
### city
• **city**: ``null`` \| `string`
#### Defined in
[models/address.ts:126](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L126)
___
### company
• **company**: ``null`` \| `string`
#### Defined in
[models/address.ts:111](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L111)
___
### country
• **country**: ``null`` \| [`Country`](Country.md)
#### Defined in
[models/address.ts:133](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L133)
___
### country\_code
• **country\_code**: ``null`` \| `string`
#### Defined in
[models/address.ts:129](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L129)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### customer
• **customer**: ``null`` \| [`Customer`](Customer.md)
#### Defined in
[models/address.ts:108](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L108)
___
### customer\_id
• **customer\_id**: ``null`` \| `string`
#### Defined in
[models/address.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L104)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### first\_name
• **first\_name**: ``null`` \| `string`
#### Defined in
[models/address.ts:114](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L114)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### last\_name
• **last\_name**: ``null`` \| `string`
#### Defined in
[models/address.ts:117](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L117)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/address.ts:145](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L145)
___
### phone
• **phone**: ``null`` \| `string`
#### Defined in
[models/address.ts:142](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L142)
___
### postal\_code
• **postal\_code**: ``null`` \| `string`
#### Defined in
[models/address.ts:139](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L139)
___
### province
• **province**: ``null`` \| `string`
#### Defined in
[models/address.ts:136](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L136)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/address.ts:147](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/address.ts#L147)
docs/content/references/entities/classes/BatchJob.md
+249
View File
@@ -0,0 +1,249 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: BatchJob
## Hierarchy
- `SoftDeletableEntity`
↳ **`BatchJob`**
## Constructors
### constructor
• **new BatchJob**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### canceled\_at
• `Optional` **canceled\_at**: `Date`
#### Defined in
[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L62)
___
### completed\_at
• `Optional` **completed\_at**: `Date`
#### Defined in
[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L59)
___
### confirmed\_at
• `Optional` **confirmed\_at**: `Date`
#### Defined in
[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L56)
___
### context
• **context**: `Record`<`string`, `unknown`\>
#### Defined in
[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L33)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### created\_by
• **created\_by**: ``null`` \| `string`
#### Defined in
[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L26)
___
### created\_by\_user
• **created\_by\_user**: [`User`](User.md)
#### Defined in
[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L30)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### dry\_run
• **dry\_run**: `boolean` = `false`
#### Defined in
[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L47)
___
### failed\_at
• `Optional` **failed\_at**: `Date`
#### Defined in
[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L65)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### pre\_processed\_at
• `Optional` **pre\_processed\_at**: `Date`
#### Defined in
[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L50)
___
### processing\_at
• `Optional` **processing\_at**: `Date`
#### Defined in
[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L53)
___
### result
• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: `BatchJobResultError`[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & `Record`<`string`, `unknown`\>
#### Defined in
[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L36)
___
### status
• **status**: `BatchJobStatus`
#### Defined in
[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L67)
___
### type
• **type**: `string`
#### Defined in
[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L23)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/batch-job.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L94)
___
### loadStatus
▸ **loadStatus**(): `void`
#### Returns
`void`
#### Defined in
[models/batch-job.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L69)
___
### toJSON
▸ **toJSON**(): [`BatchJob`](BatchJob.md)
#### Returns
[`BatchJob`](BatchJob.md)
#### Defined in
[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/batch-job.ts#L99)
docs/content/references/entities/classes/Cart.md
+455
View File
@@ -0,0 +1,455 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Cart
## Hierarchy
- `SoftDeletableEntity`
↳ **`Cart`**
## Constructors
### constructor
• **new Cart**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### billing\_address
• **billing\_address**: [`Address`](Address.md)
#### Defined in
[models/cart.ts:226](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L226)
___
### billing\_address\_id
• **billing\_address\_id**: `string`
#### Defined in
[models/cart.ts:220](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L220)
___
### completed\_at
• **completed\_at**: `Date`
#### Defined in
[models/cart.ts:311](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L311)
___
### context
• **context**: `Record`<`string`, `unknown`\>
#### Defined in
[models/cart.ts:320](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L320)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### customer
• **customer**: [`Customer`](Customer.md)
#### Defined in
[models/cart.ts:285](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L285)
___
### customer\_id
• **customer\_id**: `string`
#### Defined in
[models/cart.ts:281](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L281)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### discount\_total
• `Optional` **discount\_total**: `number`
#### Defined in
[models/cart.ts:335](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L335)
___
### discounts
• **discounts**: [`Discount`](Discount.md)[]
#### Defined in
[models/cart.ts:263](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L263)
___
### email
• **email**: `string`
#### Defined in
[models/cart.ts:216](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L216)
___
### gift\_card\_tax\_total
• `Optional` **gift\_card\_tax\_total**: `number`
#### Defined in
[models/cart.ts:342](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L342)
___
### gift\_card\_total
• `Optional` **gift\_card\_total**: `number`
#### Defined in
[models/cart.ts:341](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L341)
___
### gift\_cards
• **gift\_cards**: [`GiftCard`](GiftCard.md)[]
#### Defined in
[models/cart.ts:277](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L277)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/cart.ts:317](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L317)
___
### items
• **items**: [`LineItem`](LineItem.md)[]
#### Defined in
[models/cart.ts:241](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L241)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/cart.ts:323](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L323)
___
### object
• `Readonly` **object**: ``"cart"``
#### Defined in
[models/cart.ts:213](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L213)
___
### payment
• **payment**: [`Payment`](Payment.md)
#### Defined in
[models/cart.ts:300](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L300)
___
### payment\_authorized\_at
• **payment\_authorized\_at**: `Date`
#### Defined in
[models/cart.ts:314](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L314)
___
### payment\_id
• **payment\_id**: `string`
#### Defined in
[models/cart.ts:296](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L296)
___
### payment\_session
• **payment\_session**: ``null`` \| [`PaymentSession`](PaymentSession.md)
#### Defined in
[models/cart.ts:287](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L287)
___
### payment\_sessions
• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[]
#### Defined in
[models/cart.ts:292](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L292)
___
### refundable\_amount
• `Optional` **refundable\_amount**: `number`
#### Defined in
[models/cart.ts:340](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L340)
___
### refunded\_total
• `Optional` **refunded\_total**: `number`
#### Defined in
[models/cart.ts:337](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L337)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/cart.ts:249](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L249)
___
### region\_id
• **region\_id**: `string`
#### Defined in
[models/cart.ts:245](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L245)
___
### sales\_channel
• **sales\_channel**: [`SalesChannel`](SalesChannel.md)
#### Defined in
[models/cart.ts:332](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L332)
___
### sales\_channel\_id
• **sales\_channel\_id**: ``null`` \| `string`
#### Defined in
[models/cart.ts:326](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L326)
___
### shipping\_address
• **shipping\_address**: ``null`` \| [`Address`](Address.md)
#### Defined in
[models/cart.ts:236](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L236)
___
### shipping\_address\_id
• **shipping\_address\_id**: `string`
#### Defined in
[models/cart.ts:230](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L230)
___
### shipping\_methods
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
#### Defined in
[models/cart.ts:305](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L305)
___
### shipping\_total
• `Optional` **shipping\_total**: `number`
#### Defined in
[models/cart.ts:334](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L334)
___
### subtotal
• `Optional` **subtotal**: `number`
#### Defined in
[models/cart.ts:339](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L339)
___
### tax\_total
• `Optional` **tax\_total**: ``null`` \| `number`
#### Defined in
[models/cart.ts:336](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L336)
___
### total
• `Optional` **total**: `number`
#### Defined in
[models/cart.ts:338](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L338)
___
### type
• **type**: [`CartType`](../enums/CartType.md)
#### Defined in
[models/cart.ts:308](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L308)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### afterLoad
▸ `Private` **afterLoad**(): `void`
#### Returns
`void`
#### Defined in
[models/cart.ts:344](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L344)
___
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/cart.ts:351](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L351)
docs/content/references/entities/classes/ClaimImage.md
+131
View File
@@ -0,0 +1,131 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ClaimImage
## Hierarchy
- `SoftDeletableEntity`
↳ **`ClaimImage`**
## Constructors
### constructor
• **new ClaimImage**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### claim\_item
• **claim\_item**: [`ClaimItem`](ClaimItem.md)
#### Defined in
[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L23)
___
### claim\_item\_id
• **claim\_item\_id**: `string`
#### Defined in
[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L19)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L29)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### url
• **url**: `string`
#### Defined in
[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L26)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/claim-image.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-image.ts#L31)
docs/content/references/entities/classes/ClaimItem.md
+211
View File
@@ -0,0 +1,211 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ClaimItem
## Hierarchy
- `SoftDeletableEntity`
↳ **`ClaimItem`**
## Constructors
### constructor
• **new ClaimItem**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### claim\_order
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
#### Defined in
[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L42)
___
### claim\_order\_id
• **claim\_order\_id**: `string`
#### Defined in
[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L38)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### images
• **images**: [`ClaimImage`](ClaimImage.md)[]
#### Defined in
[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L34)
___
### item
• **item**: [`LineItem`](LineItem.md)
#### Defined in
[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L50)
___
### item\_id
• **item\_id**: `string`
#### Defined in
[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L46)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L84)
___
### note
• **note**: `string`
#### Defined in
[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L64)
___
### quantity
• **quantity**: `number`
#### Defined in
[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L67)
___
### reason
• **reason**: [`ClaimReason`](../enums/ClaimReason.md)
#### Defined in
[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L61)
___
### tags
• **tags**: [`ClaimTag`](ClaimTag.md)[]
#### Defined in
[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L81)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### variant
• **variant**: [`ProductVariant`](ProductVariant.md)
#### Defined in
[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L58)
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L54)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/claim-item.ts:86](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L86)
docs/content/references/entities/classes/ClaimOrder.md
+261
View File
@@ -0,0 +1,261 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ClaimOrder
## Hierarchy
- `SoftDeletableEntity`
↳ **`ClaimOrder`**
## Constructors
### constructor
• **new ClaimOrder**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### additional\_items
• **additional\_items**: [`LineItem`](LineItem.md)[]
#### Defined in
[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L69)
___
### canceled\_at
• **canceled\_at**: `Date`
#### Defined in
[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L107)
___
### claim\_items
• **claim\_items**: [`ClaimItem`](ClaimItem.md)[]
#### Defined in
[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L66)
___
### created\_at
• **created\_at**: `Date`
#### Overrides
SoftDeletableEntity.created\_at
#### Defined in
[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L110)
___
### deleted\_at
• **deleted\_at**: `Date`
#### Overrides
SoftDeletableEntity.deleted\_at
#### Defined in
[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L116)
___
### fulfillment\_status
• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.md)
#### Defined in
[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L63)
___
### fulfillments
• **fulfillments**: [`Fulfillment`](Fulfillment.md)[]
#### Defined in
[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L101)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L125)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L122)
___
### no\_notification
• **no\_notification**: `boolean`
#### Defined in
[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L119)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L80)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L76)
___
### payment\_status
• **payment\_status**: [`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.md)
#### Defined in
[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L56)
___
### refund\_amount
• **refund\_amount**: `number`
#### Defined in
[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L104)
___
### return\_order
• **return\_order**: [`Return`](Return.md)
#### Defined in
[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L83)
___
### shipping\_address
• **shipping\_address**: [`Address`](Address.md)
#### Defined in
[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L91)
___
### shipping\_address\_id
• **shipping\_address\_id**: `string`
#### Defined in
[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L87)
___
### shipping\_methods
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
#### Defined in
[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L96)
___
### type
• **type**: [`ClaimType`](../enums/ClaimType.md)
#### Defined in
[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L72)
___
### updated\_at
• **updated\_at**: `Date`
#### Overrides
SoftDeletableEntity.updated\_at
#### Defined in
[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L113)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/claim-order.ts:127](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L127)
docs/content/references/entities/classes/ClaimTag.md
+111
View File
@@ -0,0 +1,111 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ClaimTag
## Hierarchy
- `SoftDeletableEntity`
↳ **`ClaimTag`**
## Constructors
### constructor
• **new ClaimTag**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-tag.ts#L14)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `string`
#### Defined in
[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-tag.ts#L11)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/claim-tag.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-tag.ts#L16)
docs/content/references/entities/classes/Country.md
+91
View File
@@ -0,0 +1,91 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Country
## Constructors
### constructor
• **new Country**()
## Properties
### display\_name
• **display\_name**: `string`
#### Defined in
[models/country.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L31)
___
### id
• **id**: `number`
#### Defined in
[models/country.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L15)
___
### iso\_2
• **iso\_2**: `string`
#### Defined in
[models/country.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L19)
___
### iso\_3
• **iso\_3**: `string`
#### Defined in
[models/country.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L22)
___
### name
• **name**: `string`
#### Defined in
[models/country.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L28)
___
### num\_code
• **num\_code**: `number`
#### Defined in
[models/country.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L25)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/country.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L39)
___
### region\_id
• **region\_id**: ``null`` \| `string`
#### Defined in
[models/country.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/country.ts#L35)
docs/content/references/entities/classes/Currency.md
+51
View File
@@ -0,0 +1,51 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Currency
## Constructors
### constructor
• **new Currency**()
## Properties
### code
• **code**: `string`
#### Defined in
[models/currency.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L6)
___
### name
• **name**: `string`
#### Defined in
[models/currency.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L15)
___
### symbol
• **symbol**: `string`
#### Defined in
[models/currency.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L9)
___
### symbol\_native
• **symbol\_native**: `string`
#### Defined in
[models/currency.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/currency.ts#L12)
docs/content/references/entities/classes/CustomShippingOption.md
+151
View File
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: CustomShippingOption
## Hierarchy
- `SoftDeletableEntity`
↳ **`CustomShippingOption`**
## Constructors
### constructor
• **new CustomShippingOption**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L37)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L33)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L40)
___
### price
• **price**: `number`
#### Defined in
[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L21)
___
### shipping\_option
• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
#### Defined in
[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L29)
___
### shipping\_option\_id
• **shipping\_option\_id**: `string`
#### Defined in
[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L25)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/custom-shipping-option.ts#L42)
docs/content/references/entities/classes/Customer.md
+211
View File
@@ -0,0 +1,211 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Customer
## Hierarchy
- `SoftDeletableEntity`
↳ **`Customer`**
## Constructors
### constructor
• **new Customer**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### billing\_address
• **billing\_address**: [`Address`](Address.md)
#### Defined in
[models/customer.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L38)
___
### billing\_address\_id
• **billing\_address\_id**: ``null`` \| `string`
#### Defined in
[models/customer.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L34)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### email
• **email**: `string`
#### Defined in
[models/customer.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L24)
___
### first\_name
• **first\_name**: `string`
#### Defined in
[models/customer.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L27)
___
### groups
• **groups**: [`CustomerGroup`](CustomerGroup.md)[]
#### Defined in
[models/customer.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L69)
___
### has\_account
• **has\_account**: `boolean`
#### Defined in
[models/customer.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L50)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### last\_name
• **last\_name**: `string`
#### Defined in
[models/customer.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L30)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/customer.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L72)
___
### orders
• **orders**: [`Order`](Order.md)[]
#### Defined in
[models/customer.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L53)
___
### password\_hash
• **password\_hash**: `string`
#### Defined in
[models/customer.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L44)
___
### phone
• **phone**: `string`
#### Defined in
[models/customer.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L47)
___
### shipping\_addresses
• **shipping\_addresses**: [`Address`](Address.md)[]
#### Defined in
[models/customer.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L41)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/customer.ts:74](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer.ts#L74)
docs/content/references/entities/classes/CustomerGroup.md
+131
View File
@@ -0,0 +1,131 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: CustomerGroup
## Hierarchy
- `SoftDeletableEntity`
↳ **`CustomerGroup`**
## Constructors
### constructor
• **new CustomerGroup**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### customers
• **customers**: [`Customer`](Customer.md)[]
#### Defined in
[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L18)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L26)
___
### name
• **name**: `string`
#### Defined in
[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L13)
___
### price\_lists
• **price\_lists**: [`PriceList`](PriceList.md)[]
#### Defined in
[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L23)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/customer-group.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/customer-group.ts#L28)
docs/content/references/entities/classes/Discount.md
+231
View File
@@ -0,0 +1,231 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Discount
## Hierarchy
- `SoftDeletableEntity`
↳ **`Discount`**
## Constructors
### constructor
• **new Discount**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### code
• **code**: `string`
#### Defined in
[models/discount.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L22)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### ends\_at
• **ends\_at**: ``null`` \| `Date`
#### Defined in
[models/discount.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L52)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### is\_disabled
• **is\_disabled**: `boolean`
#### Defined in
[models/discount.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L36)
___
### is\_dynamic
• **is\_dynamic**: `boolean`
#### Defined in
[models/discount.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L25)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L78)
___
### parent\_discount
• **parent\_discount**: [`Discount`](Discount.md)
#### Defined in
[models/discount.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L43)
___
### parent\_discount\_id
• **parent\_discount\_id**: `string`
#### Defined in
[models/discount.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L39)
___
### regions
• **regions**: [`Region`](Region.md)[]
#### Defined in
[models/discount.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L69)
___
### rule
• **rule**: [`DiscountRule`](DiscountRule.md)
#### Defined in
[models/discount.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L33)
___
### rule\_id
• **rule\_id**: `string`
#### Defined in
[models/discount.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L29)
___
### starts\_at
• **starts\_at**: `Date`
#### Defined in
[models/discount.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L49)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### usage\_count
• **usage\_count**: `number`
#### Defined in
[models/discount.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L75)
___
### usage\_limit
• **usage\_limit**: ``null`` \| `number`
#### Defined in
[models/discount.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L72)
___
### valid\_duration
• **valid\_duration**: ``null`` \| `string`
#### Defined in
[models/discount.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L55)
## Methods
### upperCaseCode
▸ `Private` **upperCaseCode**(): `void`
#### Returns
`void`
#### Defined in
[models/discount.ts:80](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount.ts#L80)
docs/content/references/entities/classes/DiscountCondition.md
+191
View File
@@ -0,0 +1,191 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountCondition
## Hierarchy
- `SoftDeletableEntity`
↳ **`DiscountCondition`**
## Constructors
### constructor
• **new DiscountCondition**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### customer\_groups
• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[]
#### Defined in
[models/discount-condition.ts:127](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L127)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### discount\_rule
• **discount\_rule**: [`DiscountRule`](DiscountRule.md)
#### Defined in
[models/discount-condition.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L57)
___
### discount\_rule\_id
• **discount\_rule\_id**: `string`
#### Defined in
[models/discount-condition.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L53)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-condition.ts:130](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L130)
___
### operator
• **operator**: [`DiscountConditionOperator`](../enums/DiscountConditionOperator.md)
#### Defined in
[models/discount-condition.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L49)
___
### product\_collections
• **product\_collections**: [`ProductCollection`](ProductCollection.md)[]
#### Defined in
[models/discount-condition.ts:113](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L113)
___
### product\_tags
• **product\_tags**: [`ProductTag`](ProductTag.md)[]
#### Defined in
[models/discount-condition.ts:99](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L99)
___
### product\_types
• **product\_types**: [`ProductType`](ProductType.md)[]
#### Defined in
[models/discount-condition.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L85)
___
### products
• **products**: [`Product`](Product.md)[]
#### Defined in
[models/discount-condition.ts:71](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L71)
___
### type
• **type**: [`DiscountConditionType`](../enums/DiscountConditionType.md)
#### Defined in
[models/discount-condition.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L43)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L132)
docs/content/references/entities/classes/DiscountConditionCustomerGroup.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountConditionCustomerGroup
## Constructors
### constructor
• **new DiscountConditionCustomerGroup**()
## Properties
### condition\_id
• **condition\_id**: `string`
#### Defined in
[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L20)
___
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L31)
___
### customer\_group
• `Optional` **customer\_group**: [`CustomerGroup`](CustomerGroup.md)
#### Defined in
[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L24)
___
### customer\_group\_id
• **customer\_group\_id**: `string`
#### Defined in
[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L17)
___
### discount\_condition
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
#### Defined in
[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L28)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L37)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-customer-group.ts#L34)
docs/content/references/entities/classes/DiscountConditionProduct.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountConditionProduct
## Constructors
### constructor
• **new DiscountConditionProduct**()
## Properties
### condition\_id
• **condition\_id**: `string`
#### Defined in
[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L20)
___
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L31)
___
### discount\_condition
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
#### Defined in
[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L28)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L37)
___
### product
• `Optional` **product**: [`Product`](Product.md)
#### Defined in
[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L24)
___
### product\_id
• **product\_id**: `string`
#### Defined in
[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L17)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product.ts#L34)
docs/content/references/entities/classes/DiscountConditionProductCollection.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountConditionProductCollection
## Constructors
### constructor
• **new DiscountConditionProductCollection**()
## Properties
### condition\_id
• **condition\_id**: `string`
#### Defined in
[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L20)
___
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L31)
___
### discount\_condition
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
#### Defined in
[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L28)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L37)
___
### product\_collection
• `Optional` **product\_collection**: [`ProductCollection`](ProductCollection.md)
#### Defined in
[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L24)
___
### product\_collection\_id
• **product\_collection\_id**: `string`
#### Defined in
[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L17)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-collection.ts#L34)
docs/content/references/entities/classes/DiscountConditionProductTag.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountConditionProductTag
## Constructors
### constructor
• **new DiscountConditionProductTag**()
## Properties
### condition\_id
• **condition\_id**: `string`
#### Defined in
[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L20)
___
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L31)
___
### discount\_condition
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
#### Defined in
[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L28)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L37)
___
### product\_tag
• `Optional` **product\_tag**: [`ProductTag`](ProductTag.md)
#### Defined in
[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L24)
___
### product\_tag\_id
• **product\_tag\_id**: `string`
#### Defined in
[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L17)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-tag.ts#L34)
docs/content/references/entities/classes/DiscountConditionProductType.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountConditionProductType
## Constructors
### constructor
• **new DiscountConditionProductType**()
## Properties
### condition\_id
• **condition\_id**: `string`
#### Defined in
[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L20)
___
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L31)
___
### discount\_condition
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
#### Defined in
[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L28)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L37)
___
### product\_type
• `Optional` **product\_type**: [`ProductType`](ProductType.md)
#### Defined in
[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L24)
___
### product\_type\_id
• **product\_type\_id**: `string`
#### Defined in
[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L17)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition-product-type.ts#L34)
docs/content/references/entities/classes/DiscountRule.md
+151
View File
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DiscountRule
## Hierarchy
- `SoftDeletableEntity`
↳ **`DiscountRule`**
## Constructors
### constructor
• **new DiscountRule**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### allocation
• **allocation**: [`AllocationType`](../enums/AllocationType.md)
#### Defined in
[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L38)
___
### conditions
• **conditions**: [`DiscountCondition`](DiscountCondition.md)[]
#### Defined in
[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L41)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### description
• **description**: `string`
#### Defined in
[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L22)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L44)
___
### type
• **type**: [`DiscountRuleType`](../enums/DiscountRuleType.md)
#### Defined in
[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L28)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `number`
#### Defined in
[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L31)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/discount-rule.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L46)
docs/content/references/entities/classes/DraftOrder.md
+187
View File
@@ -0,0 +1,187 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: DraftOrder
## Hierarchy
- `BaseEntity`
↳ **`DraftOrder`**
## Constructors
### constructor
• **new DraftOrder**()
#### Inherited from
BaseEntity.constructor
## Properties
### canceled\_at
• **canceled\_at**: `Date`
#### Defined in
[models/draft-order.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L54)
___
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/draft-order.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L43)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/draft-order.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L39)
___
### completed\_at
• **completed\_at**: `Date`
#### Defined in
[models/draft-order.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L57)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### display\_id
• **display\_id**: `number`
#### Defined in
[models/draft-order.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L35)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/draft-order.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L66)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/draft-order.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L63)
___
### no\_notification\_order
• **no\_notification\_order**: `boolean`
#### Defined in
[models/draft-order.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L60)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/draft-order.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L51)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/draft-order.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L47)
___
### status
• **status**: [`DraftOrderStatus`](../enums/DraftOrderStatus.md)
#### Defined in
[models/draft-order.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L30)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `Promise`<`void`\>
#### Returns
`Promise`<`void`\>
#### Defined in
[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L68)
docs/content/references/entities/classes/Fulfillment.md
+247
View File
@@ -0,0 +1,247 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Fulfillment
## Hierarchy
- `BaseEntity`
↳ **`Fulfillment`**
## Constructors
### constructor
• **new Fulfillment**()
#### Inherited from
BaseEntity.constructor
## Properties
### canceled\_at
• **canceled\_at**: `Date`
#### Defined in
[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L79)
___
### claim\_order
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
#### Defined in
[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L29)
___
### claim\_order\_id
• **claim\_order\_id**: `string`
#### Defined in
[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L25)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L73)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L85)
___
### items
• **items**: [`FulfillmentItem`](FulfillmentItem.md)[]
#### Defined in
[models/fulfillment.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L62)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L82)
___
### no\_notification
• **no\_notification**: `boolean`
#### Defined in
[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L48)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L45)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L41)
___
### provider
• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md)
#### Defined in
[models/fulfillment.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L56)
___
### provider\_id
• **provider\_id**: `string`
#### Defined in
[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L52)
___
### shipped\_at
• **shipped\_at**: `Date`
#### Defined in
[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L76)
___
### swap
• **swap**: [`Swap`](Swap.md)
#### Defined in
[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L37)
___
### swap\_id
• **swap\_id**: `string`
#### Defined in
[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L33)
___
### tracking\_links
• **tracking\_links**: [`TrackingLink`](TrackingLink.md)[]
#### Defined in
[models/fulfillment.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L67)
___
### tracking\_numbers
• **tracking\_numbers**: `string`[]
#### Defined in
[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L70)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/fulfillment.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment.ts#L87)
docs/content/references/entities/classes/FulfillmentItem.md
+61
View File
@@ -0,0 +1,61 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: FulfillmentItem
## Constructors
### constructor
• **new FulfillmentItem**()
## Properties
### fulfillment
• **fulfillment**: [`Fulfillment`](Fulfillment.md)
#### Defined in
[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L16)
___
### fulfillment\_id
• **fulfillment\_id**: `string`
#### Defined in
[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L9)
___
### item
• **item**: [`LineItem`](LineItem.md)
#### Defined in
[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L20)
___
### item\_id
• **item\_id**: `string`
#### Defined in
[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L12)
___
### quantity
• **quantity**: `number`
#### Defined in
[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-item.ts#L23)
docs/content/references/entities/classes/FulfillmentProvider.md
+31
View File
@@ -0,0 +1,31 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: FulfillmentProvider
## Constructors
### constructor
• **new FulfillmentProvider**()
## Properties
### id
• **id**: `string`
#### Defined in
[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-provider.ts#L6)
___
### is\_installed
• **is\_installed**: `boolean`
#### Defined in
[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/fulfillment-provider.ts#L9)
docs/content/references/entities/classes/GiftCard.md
+191
View File
@@ -0,0 +1,191 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: GiftCard
## Hierarchy
- `SoftDeletableEntity`
↳ **`GiftCard`**
## Constructors
### constructor
• **new GiftCard**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### balance
• **balance**: `number`
#### Defined in
[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L26)
___
### code
• **code**: `string`
#### Defined in
[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L20)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### ends\_at
• **ends\_at**: `Date`
#### Defined in
[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L51)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### is\_disabled
• **is\_disabled**: `boolean`
#### Defined in
[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L45)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L54)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L42)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L38)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L34)
___
### region\_id
• **region\_id**: `string`
#### Defined in
[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L30)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `number`
#### Defined in
[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L23)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/gift-card.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card.ts#L56)
docs/content/references/entities/classes/GiftCardTransaction.md
+115
View File
@@ -0,0 +1,115 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: GiftCardTransaction
## Constructors
### constructor
• **new GiftCardTransaction**()
## Properties
### amount
• **amount**: `number`
#### Defined in
[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L40)
___
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L43)
___
### gift\_card
• **gift\_card**: [`GiftCard`](GiftCard.md)
#### Defined in
[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L29)
___
### gift\_card\_id
• **gift\_card\_id**: `string`
#### Defined in
[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L25)
___
### id
• **id**: `string`
#### Defined in
[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L22)
___
### is\_taxable
• **is\_taxable**: `boolean`
#### Defined in
[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L46)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L37)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L33)
___
### tax\_rate
• **tax\_rate**: ``null`` \| `number`
#### Defined in
[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L49)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/gift-card-transaction.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/gift-card-transaction.ts#L51)
docs/content/references/entities/classes/IdempotencyKey.md
+125
View File
@@ -0,0 +1,125 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: IdempotencyKey
## Constructors
### constructor
• **new IdempotencyKey**()
## Properties
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L23)
___
### id
• **id**: `string`
#### Defined in
[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L16)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L20)
___
### locked\_at
• **locked\_at**: `Date`
#### Defined in
[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L26)
___
### recovery\_point
• **recovery\_point**: `string`
#### Defined in
[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L44)
___
### request\_method
• **request\_method**: `string`
#### Defined in
[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L29)
___
### request\_params
• **request\_params**: `Record`<`string`, `unknown`\>
#### Defined in
[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L32)
___
### request\_path
• **request\_path**: `string`
#### Defined in
[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L35)
___
### response\_body
• **response\_body**: `Record`<`string`, `unknown`\>
#### Defined in
[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L41)
___
### response\_code
• **response\_code**: `number`
#### Defined in
[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L38)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/idempotency-key.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/idempotency-key.ts#L46)
docs/content/references/entities/classes/Image.md
+111
View File
@@ -0,0 +1,111 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Image
## Hierarchy
- `SoftDeletableEntity`
↳ **`Image`**
## Constructors
### constructor
• **new Image**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/image.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/image.ts#L13)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### url
• **url**: `string`
#### Defined in
[models/image.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/image.ts#L10)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/image.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/image.ts#L15)
docs/content/references/entities/classes/Invite.md
+151
View File
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Invite
## Hierarchy
- `SoftDeletableEntity`
↳ **`Invite`**
## Constructors
### constructor
• **new Invite**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### accepted
• **accepted**: `boolean`
#### Defined in
[models/invite.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L23)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### expires\_at
• **expires\_at**: `Date`
#### Defined in
[models/invite.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L29)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/invite.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L32)
___
### role
• **role**: [`UserRoles`](../enums/UserRoles.md)
#### Defined in
[models/invite.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L20)
___
### token
• **token**: `string`
#### Defined in
[models/invite.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L26)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### user\_email
• **user\_email**: `string`
#### Defined in
[models/invite.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L12)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/invite.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/invite.ts#L34)
docs/content/references/entities/classes/LineItem.md
+417
View File
@@ -0,0 +1,417 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: LineItem
## Hierarchy
- `BaseEntity`
↳ **`LineItem`**
## Constructors
### constructor
• **new LineItem**()
#### Inherited from
BaseEntity.constructor
## Properties
### adjustments
• **adjustments**: [`LineItemAdjustment`](LineItemAdjustment.md)[]
#### Defined in
[models/line-item.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L67)
___
### allow\_discounts
• **allow\_discounts**: `boolean`
#### Defined in
[models/line-item.ts:88](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L88)
___
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/line-item.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L35)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/line-item.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L31)
___
### claim\_order
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
#### Defined in
[models/line-item.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L59)
___
### claim\_order\_id
• **claim\_order\_id**: `string`
#### Defined in
[models/line-item.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L55)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### description
• **description**: `string`
#### Defined in
[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L73)
___
### discount\_total
• `Optional` **discount\_total**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:125](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L125)
___
### fulfilled\_quantity
• **fulfilled\_quantity**: `number`
#### Defined in
[models/line-item.ts:108](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L108)
___
### gift\_card\_total
• `Optional` **gift\_card\_total**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:126](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L126)
___
### has\_shipping
• **has\_shipping**: `boolean`
#### Defined in
[models/line-item.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L91)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### is\_giftcard
• **is\_giftcard**: `boolean`
#### Defined in
[models/line-item.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L82)
___
### is\_return
• **is\_return**: `boolean`
#### Defined in
[models/line-item.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L79)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/line-item.ts:117](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L117)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/line-item.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L43)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/line-item.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L39)
___
### original\_tax\_total
• `Optional` **original\_tax\_total**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L124)
___
### original\_total
• `Optional` **original\_total**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:123](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L123)
___
### quantity
• **quantity**: `number`
#### Defined in
[models/line-item.ts:105](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L105)
___
### refundable
• `Optional` **refundable**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:119](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L119)
___
### returned\_quantity
• **returned\_quantity**: `number`
#### Defined in
[models/line-item.ts:111](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L111)
___
### shipped\_quantity
• **shipped\_quantity**: `number`
#### Defined in
[models/line-item.ts:114](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L114)
___
### should\_merge
• **should\_merge**: `boolean`
#### Defined in
[models/line-item.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L85)
___
### subtotal
• `Optional` **subtotal**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:120](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L120)
___
### swap
• **swap**: [`Swap`](Swap.md)
#### Defined in
[models/line-item.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L51)
___
### swap\_id
• **swap\_id**: `string`
#### Defined in
[models/line-item.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L47)
___
### tax\_lines
• **tax\_lines**: [`LineItemTaxLine`](LineItemTaxLine.md)[]
#### Defined in
[models/line-item.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L62)
___
### tax\_total
• `Optional` **tax\_total**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L121)
___
### thumbnail
• **thumbnail**: ``null`` \| `string`
#### Defined in
[models/line-item.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L76)
___
### title
• **title**: `string`
#### Defined in
[models/line-item.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L70)
___
### total
• `Optional` **total**: ``null`` \| `number`
#### Defined in
[models/line-item.ts:122](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L122)
___
### unit\_price
• **unit\_price**: `number`
#### Defined in
[models/line-item.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L94)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### variant
• **variant**: [`ProductVariant`](ProductVariant.md)
#### Defined in
[models/line-item.ts:102](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L102)
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
[models/line-item.ts:98](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L98)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item.ts#L128)
docs/content/references/entities/classes/LineItemAdjustment.md
+105
View File
@@ -0,0 +1,105 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: LineItemAdjustment
## Constructors
### constructor
• **new LineItemAdjustment**()
## Properties
### amount
• **amount**: `number`
#### Defined in
[models/line-item-adjustment.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L45)
___
### description
• **description**: `string`
#### Defined in
[models/line-item-adjustment.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L34)
___
### discount
• **discount**: [`Discount`](Discount.md)
#### Defined in
[models/line-item-adjustment.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L38)
___
### discount\_id
• **discount\_id**: `string`
#### Defined in
[models/line-item-adjustment.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L42)
___
### id
• **id**: `string`
#### Defined in
[models/line-item-adjustment.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L23)
___
### item
• **item**: [`LineItem`](LineItem.md)
#### Defined in
[models/line-item-adjustment.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L31)
___
### item\_id
• **item\_id**: `string`
#### Defined in
[models/line-item-adjustment.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L27)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/line-item-adjustment.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L48)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-adjustment.ts#L50)
docs/content/references/entities/classes/LineItemTaxLine.md
+153
View File
@@ -0,0 +1,153 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: LineItemTaxLine
## Hierarchy
- `TaxLine`
↳ **`LineItemTaxLine`**
## Constructors
### constructor
• **new LineItemTaxLine**()
#### Inherited from
TaxLine.constructor
## Properties
### code
• **code**: ``null`` \| `string`
#### Inherited from
TaxLine.code
#### Defined in
[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L13)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
TaxLine.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### id
• **id**: `string`
#### Inherited from
TaxLine.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### item
• **item**: [`LineItem`](LineItem.md)
#### Defined in
[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-tax-line.ts#L24)
___
### item\_id
• **item\_id**: `string`
#### Defined in
[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-tax-line.ts#L20)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Inherited from
TaxLine.metadata
#### Defined in
[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L16)
___
### name
• **name**: `string`
#### Inherited from
TaxLine.name
#### Defined in
[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L10)
___
### rate
• **rate**: `number`
#### Inherited from
TaxLine.rate
#### Defined in
[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L7)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
TaxLine.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/line-item-tax-line.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/line-item-tax-line.ts#L26)
docs/content/references/entities/classes/MoneyAmount.md
+201
View File
@@ -0,0 +1,201 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: MoneyAmount
## Hierarchy
- `SoftDeletableEntity`
↳ **`MoneyAmount`**
## Constructors
### constructor
• **new MoneyAmount**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### amount
• **amount**: `number`
#### Defined in
[models/money-amount.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L27)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### currency
• **currency**: [`Currency`](Currency.md)
#### Defined in
[models/money-amount.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L24)
___
### currency\_code
• **currency\_code**: `string`
#### Defined in
[models/money-amount.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L20)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### max\_quantity
• **max\_quantity**: ``null`` \| `number`
#### Defined in
[models/money-amount.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L33)
___
### min\_quantity
• **min\_quantity**: ``null`` \| `number`
#### Defined in
[models/money-amount.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L30)
___
### price\_list
• **price\_list**: ``null`` \| [`PriceList`](PriceList.md)
#### Defined in
[models/money-amount.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L43)
___
### price\_list\_id
• **price\_list\_id**: ``null`` \| `string`
#### Defined in
[models/money-amount.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L36)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/money-amount.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L61)
___
### region\_id
• **region\_id**: `string`
#### Defined in
[models/money-amount.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L57)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### variant
• **variant**: [`ProductVariant`](ProductVariant.md)
#### Defined in
[models/money-amount.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L53)
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
[models/money-amount.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L47)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `undefined` \| `void`
#### Returns
`undefined` \| `void`
#### Defined in
[models/money-amount.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/money-amount.ts#L63)
docs/content/references/entities/classes/Note.md
+151
View File
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Note
## Hierarchy
- `SoftDeletableEntity`
↳ **`Note`**
## Constructors
### constructor
• **new Note**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### author
• **author**: [`User`](User.md)
#### Defined in
[models/note.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L33)
___
### author\_id
• **author\_id**: `string`
#### Defined in
[models/note.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L29)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/note.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L36)
___
### resource\_id
• **resource\_id**: `string`
#### Defined in
[models/note.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L26)
___
### resource\_type
• **resource\_type**: `string`
#### Defined in
[models/note.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L22)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `string`
#### Defined in
[models/note.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L18)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/note.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/note.ts#L38)
docs/content/references/entities/classes/Notification.md
+197
View File
@@ -0,0 +1,197 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Notification
## Hierarchy
- `BaseEntity`
↳ **`Notification`**
## Constructors
### constructor
• **new Notification**()
#### Inherited from
BaseEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### customer
• **customer**: [`Customer`](Customer.md)
#### Defined in
[models/notification.ts:36](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L36)
___
### customer\_id
• **customer\_id**: ``null`` \| `string`
#### Defined in
[models/notification.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L32)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/notification.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L42)
___
### event\_name
• **event\_name**: `string`
#### Defined in
[models/notification.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L20)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### parent\_id
• **parent\_id**: `string`
#### Defined in
[models/notification.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L45)
___
### parent\_notification
• **parent\_notification**: [`Notification`](Notification.md)
#### Defined in
[models/notification.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L49)
___
### provider
• **provider**: `NotificationProvider`
#### Defined in
[models/notification.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L59)
___
### provider\_id
• **provider\_id**: `string`
#### Defined in
[models/notification.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L55)
___
### resends
• **resends**: [`Notification`](Notification.md)[]
#### Defined in
[models/notification.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L52)
___
### resource\_id
• **resource\_id**: `string`
#### Defined in
[models/notification.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L28)
___
### resource\_type
• **resource\_type**: `string`
#### Defined in
[models/notification.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L24)
___
### to
• **to**: `string`
#### Defined in
[models/notification.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L39)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/notification.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/notification.ts#L61)
docs/content/references/entities/classes/Oauth.md
+85
View File
@@ -0,0 +1,85 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Oauth
## Constructors
### constructor
• **new Oauth**()
## Properties
### application\_name
• **application\_name**: `string`
#### Defined in
[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L16)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L25)
___
### display\_name
• **display\_name**: `string`
#### Defined in
[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L12)
___
### id
• **id**: `string`
#### Defined in
[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L9)
___
### install\_url
• **install\_url**: `string`
#### Defined in
[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L19)
___
### uninstall\_url
• **uninstall\_url**: `string`
#### Defined in
[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L22)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/oauth.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/oauth.ts#L27)
docs/content/references/entities/classes/Order.md
+567
View File
@@ -0,0 +1,567 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Order
## Hierarchy
- `BaseEntity`
↳ **`Order`**
## Constructors
### constructor
• **new Order**()
#### Inherited from
BaseEntity.constructor
## Properties
### billing\_address
• **billing\_address**: [`Address`](Address.md)
#### Defined in
[models/order.ts:123](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L123)
___
### billing\_address\_id
• **billing\_address\_id**: `string`
#### Defined in
[models/order.ts:119](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L119)
___
### canceled\_at
• **canceled\_at**: `Date`
#### Defined in
[models/order.ts:220](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L220)
___
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/order.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L104)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/order.ts:100](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L100)
___
### claims
• **claims**: [`ClaimOrder`](ClaimOrder.md)[]
#### Defined in
[models/order.ts:196](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L196)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### currency
• **currency**: [`Currency`](Currency.md)
#### Defined in
[models/order.ts:146](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L146)
___
### currency\_code
• **currency\_code**: `string`
#### Defined in
[models/order.ts:142](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L142)
___
### customer
• **customer**: [`Customer`](Customer.md)
#### Defined in
[models/order.ts:112](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L112)
___
### customer\_id
• **customer\_id**: `string`
#### Defined in
[models/order.ts:108](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L108)
___
### discount\_total
• **discount\_total**: `number`
#### Defined in
[models/order.ts:245](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L245)
___
### discounts
• **discounts**: [`Discount`](Discount.md)[]
#### Defined in
[models/order.ts:163](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L163)
___
### display\_id
• **display\_id**: `number`
#### Defined in
[models/order.ts:96](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L96)
___
### draft\_order
• **draft\_order**: [`DraftOrder`](DraftOrder.md)
#### Defined in
[models/order.ts:209](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L209)
___
### draft\_order\_id
• **draft\_order\_id**: `string`
#### Defined in
[models/order.ts:205](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L205)
___
### email
• **email**: `string`
#### Defined in
[models/order.ts:115](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L115)
___
### external\_id
• **external\_id**: ``null`` \| `string`
#### Defined in
[models/order.ts:232](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L232)
___
### fulfillment\_status
• **fulfillment\_status**: [`FulfillmentStatus`](../enums/FulfillmentStatus.md)
#### Defined in
[models/order.ts:88](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L88)
___
### fulfillments
• **fulfillments**: [`Fulfillment`](Fulfillment.md)[]
#### Defined in
[models/order.ts:190](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L190)
___
### gift\_card\_tax\_total
• **gift\_card\_tax\_total**: `number`
#### Defined in
[models/order.ts:253](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L253)
___
### gift\_card\_total
• **gift\_card\_total**: `number`
#### Defined in
[models/order.ts:252](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L252)
___
### gift\_card\_transactions
• **gift\_card\_transactions**: [`GiftCardTransaction`](GiftCardTransaction.md)[]
#### Defined in
[models/order.ts:217](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L217)
___
### gift\_cards
• **gift\_cards**: [`GiftCard`](GiftCard.md)[]
#### Defined in
[models/order.ts:177](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L177)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/order.ts:229](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L229)
___
### items
• **items**: [`LineItem`](LineItem.md)[]
#### Defined in
[models/order.ts:214](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L214)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/order.ts:223](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L223)
___
### no\_notification
• **no\_notification**: `boolean`
#### Defined in
[models/order.ts:226](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L226)
___
### object
• `Readonly` **object**: ``"order"``
#### Defined in
[models/order.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L78)
___
### paid\_total
• **paid\_total**: `number`
#### Defined in
[models/order.ts:250](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L250)
___
### payment\_status
• **payment\_status**: [`PaymentStatus`](../enums/PaymentStatus.md)
#### Defined in
[models/order.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L91)
___
### payments
• **payments**: [`Payment`](Payment.md)[]
#### Defined in
[models/order.ts:185](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L185)
___
### refundable\_amount
• **refundable\_amount**: `number`
#### Defined in
[models/order.ts:251](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L251)
___
### refunded\_total
• **refunded\_total**: `number`
#### Defined in
[models/order.ts:247](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L247)
___
### refunds
• **refunds**: [`Refund`](Refund.md)[]
#### Defined in
[models/order.ts:199](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L199)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/order.ts:139](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L139)
___
### region\_id
• **region\_id**: `string`
#### Defined in
[models/order.ts:135](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L135)
___
### returns
• **returns**: [`Return`](Return.md)[]
#### Defined in
[models/order.ts:193](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L193)
___
### sales\_channel
• **sales\_channel**: [`SalesChannel`](SalesChannel.md)
#### Defined in
[models/order.ts:241](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L241)
___
### sales\_channel\_id
• **sales\_channel\_id**: ``null`` \| `string`
#### Defined in
[models/order.ts:235](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L235)
___
### shipping\_address
• **shipping\_address**: [`Address`](Address.md)
#### Defined in
[models/order.ts:131](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L131)
___
### shipping\_address\_id
• **shipping\_address\_id**: `string`
#### Defined in
[models/order.ts:127](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L127)
___
### shipping\_methods
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
#### Defined in
[models/order.ts:182](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L182)
___
### shipping\_total
• **shipping\_total**: `number`
#### Defined in
[models/order.ts:244](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L244)
___
### status
• **status**: [`OrderStatus`](../enums/OrderStatus.md)
#### Defined in
[models/order.ts:81](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L81)
___
### subtotal
• **subtotal**: `number`
#### Defined in
[models/order.ts:249](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L249)
___
### swaps
• **swaps**: [`Swap`](Swap.md)[]
#### Defined in
[models/order.ts:202](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L202)
___
### tax\_rate
• **tax\_rate**: ``null`` \| `number`
#### Defined in
[models/order.ts:149](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L149)
___
### tax\_total
• **tax\_total**: ``null`` \| `number`
#### Defined in
[models/order.ts:246](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L246)
___
### total
• **total**: `number`
#### Defined in
[models/order.ts:248](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L248)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `Promise`<`void`\>
#### Returns
`Promise`<`void`\>
#### Defined in
[models/order.ts:255](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L255)
docs/content/references/entities/classes/Payment.md
+237
View File
@@ -0,0 +1,237 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Payment
## Hierarchy
- `BaseEntity`
↳ **`Payment`**
## Constructors
### constructor
• **new Payment**()
#### Inherited from
BaseEntity.constructor
## Properties
### amount
• **amount**: `number`
#### Defined in
[models/payment.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L46)
___
### amount\_refunded
• **amount\_refunded**: `number`
#### Defined in
[models/payment.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L56)
___
### canceled\_at
• **canceled\_at**: `string` \| `Date`
#### Defined in
[models/payment.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L69)
___
### captured\_at
• **captured\_at**: `string` \| `Date`
#### Defined in
[models/payment.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L66)
___
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/payment.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L35)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/payment.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L31)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### currency
• **currency**: [`Currency`](Currency.md)
#### Defined in
[models/payment.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L53)
___
### currency\_code
• **currency\_code**: `string`
#### Defined in
[models/payment.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L49)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/payment.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L63)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/payment.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L75)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/payment.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L72)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/payment.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L43)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/payment.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L39)
___
### provider\_id
• **provider\_id**: `string`
#### Defined in
[models/payment.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L60)
___
### swap
• **swap**: [`Swap`](Swap.md)
#### Defined in
[models/payment.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L27)
___
### swap\_id
• **swap\_id**: `string`
#### Defined in
[models/payment.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L23)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/payment.ts:77](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment.ts#L77)
docs/content/references/entities/classes/PaymentProvider.md
+31
View File
@@ -0,0 +1,31 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: PaymentProvider
## Constructors
### constructor
• **new PaymentProvider**()
## Properties
### id
• **id**: `string`
#### Defined in
[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-provider.ts#L6)
___
### is\_installed
• **is\_installed**: `boolean`
#### Defined in
[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-provider.ts#L9)
docs/content/references/entities/classes/PaymentSession.md
+147
View File
@@ -0,0 +1,147 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: PaymentSession
## Hierarchy
- `BaseEntity`
↳ **`PaymentSession`**
## Constructors
### constructor
• **new PaymentSession**()
#### Inherited from
BaseEntity.constructor
## Properties
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/payment-session.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L34)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/payment-session.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L30)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/payment-session.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L47)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/payment-session.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L50)
___
### is\_selected
• **is\_selected**: ``null`` \| `boolean`
#### Defined in
[models/payment-session.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L41)
___
### provider\_id
• **provider\_id**: `string`
#### Defined in
[models/payment-session.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L38)
___
### status
• **status**: `string`
#### Defined in
[models/payment-session.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L44)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/payment-session.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L52)
docs/content/references/entities/classes/PriceList.md
+171
View File
@@ -0,0 +1,171 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: PriceList
## Hierarchy
- `SoftDeletableEntity`
↳ **`PriceList`**
## Constructors
### constructor
• **new PriceList**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### customer\_groups
• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[]
#### Defined in
[models/price-list.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L54)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### description
• **description**: `string`
#### Defined in
[models/price-list.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L23)
___
### ends\_at
• **ends\_at**: ``null`` \| `Date`
#### Defined in
[models/price-list.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L38)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### name
• **name**: `string`
#### Defined in
[models/price-list.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L20)
___
### prices
• **prices**: [`MoneyAmount`](MoneyAmount.md)[]
#### Defined in
[models/price-list.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L59)
___
### starts\_at
• **starts\_at**: ``null`` \| `Date`
#### Defined in
[models/price-list.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L35)
___
### status
• **status**: `PriceListStatus`
#### Defined in
[models/price-list.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L29)
___
### type
• **type**: `PriceListType`
#### Defined in
[models/price-list.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L26)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `undefined` \| `void`
#### Returns
`undefined` \| `void`
#### Defined in
[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/price-list.ts#L61)
docs/content/references/entities/classes/Product.md
+381
View File
@@ -0,0 +1,381 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Product
## Hierarchy
- `SoftDeletableEntity`
↳ **`Product`**
## Constructors
### constructor
• **new Product**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### collection
• **collection**: [`ProductCollection`](ProductCollection.md)
#### Defined in
[models/product.ts:117](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L117)
___
### collection\_id
• **collection\_id**: ``null`` \| `string`
#### Defined in
[models/product.ts:113](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L113)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### description
• **description**: ``null`` \| `string`
#### Defined in
[models/product.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L43)
___
### discountable
• **discountable**: `boolean`
#### Defined in
[models/product.ts:141](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L141)
___
### external\_id
• **external\_id**: ``null`` \| `string`
#### Defined in
[models/product.ts:144](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L144)
___
### handle
• **handle**: ``null`` \| `string`
#### Defined in
[models/product.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L47)
___
### height
• **height**: ``null`` \| `number`
#### Defined in
[models/product.ts:95](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L95)
___
### hs\_code
• **hs\_code**: ``null`` \| `string`
#### Defined in
[models/product.ts:101](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L101)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### images
• **images**: [`Image`](Image.md)[]
#### Defined in
[models/product.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L67)
___
### is\_giftcard
• **is\_giftcard**: `boolean`
#### Defined in
[models/product.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L50)
___
### length
• **length**: ``null`` \| `number`
#### Defined in
[models/product.ts:92](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L92)
___
### material
• **material**: ``null`` \| `string`
#### Defined in
[models/product.ts:110](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L110)
___
### metadata
• **metadata**: ``null`` \| `Record`<`string`, `unknown`\>
#### Defined in
[models/product.ts:147](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L147)
___
### mid\_code
• **mid\_code**: ``null`` \| `string`
#### Defined in
[models/product.ts:107](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L107)
___
### options
• **options**: [`ProductOption`](ProductOption.md)[]
#### Defined in
[models/product.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L73)
___
### origin\_country
• **origin\_country**: ``null`` \| `string`
#### Defined in
[models/product.ts:104](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L104)
___
### profile
• **profile**: [`ShippingProfile`](ShippingProfile.md)
#### Defined in
[models/product.ts:86](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L86)
___
### profile\_id
• **profile\_id**: `string`
#### Defined in
[models/product.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L82)
___
### sales\_channels
• **sales\_channels**: [`SalesChannel`](SalesChannel.md)[]
#### Defined in
[models/product.ts:163](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L163)
___
### status
• **status**: [`ProductStatus`](../enums/ProductStatus.md)
#### Defined in
[models/product.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L53)
___
### subtitle
• **subtitle**: ``null`` \| `string`
#### Defined in
[models/product.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L40)
___
### tags
• **tags**: [`ProductTag`](ProductTag.md)[]
#### Defined in
[models/product.ts:138](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L138)
___
### thumbnail
• **thumbnail**: ``null`` \| `string`
#### Defined in
[models/product.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L70)
___
### title
• **title**: `string`
#### Defined in
[models/product.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L37)
___
### type
• **type**: [`ProductType`](ProductType.md)
#### Defined in
[models/product.ts:124](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L124)
___
### type\_id
• **type\_id**: ``null`` \| `string`
#### Defined in
[models/product.ts:120](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L120)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### variants
• **variants**: [`ProductVariant`](ProductVariant.md)[]
#### Defined in
[models/product.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L78)
___
### weight
• **weight**: ``null`` \| `number`
#### Defined in
[models/product.ts:89](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L89)
___
### width
• **width**: ``null`` \| `number`
#### Defined in
[models/product.ts:98](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L98)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/product.ts:165](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L165)
docs/content/references/entities/classes/ProductCollection.md
+131
View File
@@ -0,0 +1,131 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductCollection
## Hierarchy
- `SoftDeletableEntity`
↳ **`ProductCollection`**
## Constructors
### constructor
• **new ProductCollection**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### handle
• **handle**: `string`
#### Defined in
[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L16)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L22)
___
### products
• **products**: [`Product`](Product.md)[]
#### Defined in
[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L19)
___
### title
• **title**: `string`
#### Defined in
[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L12)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### createHandleIfNotProvided
▸ `Private` **createHandleIfNotProvided**(): `void`
#### Returns
`void`
#### Defined in
[models/product-collection.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-collection.ts#L24)
docs/content/references/entities/classes/ProductOption.md
+141
View File
@@ -0,0 +1,141 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductOption
## Hierarchy
- `SoftDeletableEntity`
↳ **`ProductOption`**
## Constructors
### constructor
• **new ProductOption**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-option.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L32)
___
### product
• **product**: [`Product`](Product.md)
#### Defined in
[models/product-option.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L29)
___
### product\_id
• **product\_id**: `string`
#### Defined in
[models/product-option.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L25)
___
### title
• **title**: `string`
#### Defined in
[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L19)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### values
• **values**: [`ProductOptionValue`](ProductOptionValue.md)[]
#### Defined in
[models/product-option.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L22)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option.ts#L34)
docs/content/references/entities/classes/ProductOptionValue.md
+151
View File
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductOptionValue
## Hierarchy
- `SoftDeletableEntity`
↳ **`ProductOptionValue`**
## Constructors
### constructor
• **new ProductOptionValue**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L40)
___
### option
• **option**: [`ProductOption`](ProductOption.md)
#### Defined in
[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L27)
___
### option\_id
• **option\_id**: `string`
#### Defined in
[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L23)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `string`
#### Defined in
[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L19)
___
### variant
• **variant**: [`ProductVariant`](ProductVariant.md)
#### Defined in
[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L37)
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L31)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/product-option-value.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-option-value.ts#L42)
docs/content/references/entities/classes/ProductTag.md
+111
View File
@@ -0,0 +1,111 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductTag
## Hierarchy
- `SoftDeletableEntity`
↳ **`ProductTag`**
## Constructors
### constructor
• **new ProductTag**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tag.ts#L13)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `string`
#### Defined in
[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tag.ts#L10)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/product-tag.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tag.ts#L15)
docs/content/references/entities/classes/ProductTaxRate.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductTaxRate
## Constructors
### constructor
• **new ProductTaxRate**()
## Properties
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L32)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L38)
___
### product
• `Optional` **product**: [`Product`](Product.md)
#### Defined in
[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L24)
___
### product\_id
• **product\_id**: `string`
#### Defined in
[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L17)
___
### rate\_id
• **rate\_id**: `string`
#### Defined in
[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L20)
___
### tax\_rate
• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md)
#### Defined in
[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L29)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-tax-rate.ts#L35)
docs/content/references/entities/classes/ProductType.md
+111
View File
@@ -0,0 +1,111 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductType
## Hierarchy
- `SoftDeletableEntity`
↳ **`ProductType`**
## Constructors
### constructor
• **new ProductType**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type.ts#L13)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `string`
#### Defined in
[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type.ts#L10)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/product-type.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type.ts#L15)
docs/content/references/entities/classes/ProductTypeTaxRate.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductTypeTaxRate
## Constructors
### constructor
• **new ProductTypeTaxRate**()
## Properties
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L31)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L37)
___
### product\_type
• `Optional` **product\_type**: [`ProductType`](ProductType.md)
#### Defined in
[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L24)
___
### product\_type\_id
• **product\_type\_id**: `string`
#### Defined in
[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L17)
___
### rate\_id
• **rate\_id**: `string`
#### Defined in
[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L20)
___
### tax\_rate
• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md)
#### Defined in
[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L28)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-type-tax-rate.ts#L34)
docs/content/references/entities/classes/ProductVariant.md
+311
View File
@@ -0,0 +1,311 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ProductVariant
## Hierarchy
- `SoftDeletableEntity`
↳ **`ProductVariant`**
## Constructors
### constructor
• **new ProductVariant**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### allow\_backorder
• **allow\_backorder**: `boolean`
#### Defined in
[models/product-variant.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L60)
___
### barcode
• **barcode**: `string`
#### Defined in
[models/product-variant.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L43)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### ean
• **ean**: `string`
#### Defined in
[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L47)
___
### height
• **height**: `number`
#### Defined in
[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L84)
___
### hs\_code
• **hs\_code**: `string`
#### Defined in
[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L66)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### inventory\_quantity
• **inventory\_quantity**: `number`
#### Defined in
[models/product-variant.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L57)
___
### length
• **length**: `number`
#### Defined in
[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L81)
___
### manage\_inventory
• **manage\_inventory**: `boolean`
#### Defined in
[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L63)
___
### material
• **material**: `string`
#### Defined in
[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L75)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/product-variant.ts:95](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L95)
___
### mid\_code
• **mid\_code**: `string`
#### Defined in
[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L72)
___
### options
• **options**: [`ProductOptionValue`](ProductOptionValue.md)[]
#### Defined in
[models/product-variant.ts:92](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L92)
___
### origin\_country
• **origin\_country**: `string`
#### Defined in
[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L69)
___
### prices
• **prices**: [`MoneyAmount`](MoneyAmount.md)[]
#### Defined in
[models/product-variant.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L35)
___
### product
• **product**: [`Product`](Product.md)
#### Defined in
[models/product-variant.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L29)
___
### product\_id
• **product\_id**: `string`
#### Defined in
[models/product-variant.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L25)
___
### sku
• **sku**: `string`
#### Defined in
[models/product-variant.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L39)
___
### title
• **title**: `string`
#### Defined in
[models/product-variant.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L21)
___
### upc
• **upc**: `string`
#### Defined in
[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L51)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### variant\_rank
• **variant\_rank**: `number`
#### Defined in
[models/product-variant.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L54)
___
### weight
• **weight**: `number`
#### Defined in
[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L78)
___
### width
• **width**: `number`
#### Defined in
[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L87)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/product-variant.ts:97](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product-variant.ts#L97)
docs/content/references/entities/classes/Refund.md
+147
View File
@@ -0,0 +1,147 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Refund
## Hierarchy
- `BaseEntity`
↳ **`Refund`**
## Constructors
### constructor
• **new Refund**()
#### Inherited from
BaseEntity.constructor
## Properties
### amount
• **amount**: `number`
#### Defined in
[models/refund.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L34)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/refund.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L46)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/refund.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L43)
___
### note
• **note**: `string`
#### Defined in
[models/refund.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L37)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/refund.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L31)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/refund.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L27)
___
### reason
• **reason**: `string`
#### Defined in
[models/refund.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L40)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/refund.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/refund.ts#L48)
docs/content/references/entities/classes/Region.md
+231
View File
@@ -0,0 +1,231 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Region
## Hierarchy
- `SoftDeletableEntity`
↳ **`Region`**
## Constructors
### constructor
• **new Region**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### automatic\_taxes
• **automatic\_taxes**: `boolean`
#### Defined in
[models/region.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L47)
___
### countries
• **countries**: [`Country`](Country.md)[]
#### Defined in
[models/region.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L50)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### currency
• **currency**: [`Currency`](Currency.md)
#### Defined in
[models/region.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L32)
___
### currency\_code
• **currency\_code**: `string`
#### Defined in
[models/region.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L28)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### fulfillment\_providers
• **fulfillment\_providers**: [`FulfillmentProvider`](FulfillmentProvider.md)[]
#### Defined in
[models/region.ts:91](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L91)
___
### gift\_cards\_taxable
• **gift\_cards\_taxable**: `boolean`
#### Defined in
[models/region.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L44)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/region.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L94)
___
### name
• **name**: `string`
#### Defined in
[models/region.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L25)
___
### payment\_providers
• **payment\_providers**: [`PaymentProvider`](PaymentProvider.md)[]
#### Defined in
[models/region.ts:74](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L74)
___
### tax\_code
• **tax\_code**: `string`
#### Defined in
[models/region.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L41)
___
### tax\_provider
• **tax\_provider**: [`TaxProvider`](TaxProvider.md)
#### Defined in
[models/region.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L57)
___
### tax\_provider\_id
• **tax\_provider\_id**: ``null`` \| `string`
#### Defined in
[models/region.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L53)
___
### tax\_rate
• **tax\_rate**: `number`
#### Defined in
[models/region.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L35)
___
### tax\_rates
• **tax\_rates**: ``null`` \| [`TaxRate`](TaxRate.md)[]
#### Defined in
[models/region.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L38)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/region.ts:96](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/region.ts#L96)
docs/content/references/entities/classes/Return.md
+227
View File
@@ -0,0 +1,227 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Return
## Hierarchy
- `BaseEntity`
↳ **`Return`**
## Constructors
### constructor
• **new Return**()
#### Inherited from
BaseEntity.constructor
## Properties
### claim\_order
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
#### Defined in
[models/return.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L57)
___
### claim\_order\_id
• **claim\_order\_id**: `string`
#### Defined in
[models/return.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L53)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/return.ts:88](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L88)
___
### items
• **items**: [`ReturnItem`](ReturnItem.md)[]
#### Defined in
[models/return.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L41)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/return.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L85)
___
### no\_notification
• **no\_notification**: `boolean`
#### Defined in
[models/return.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L82)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/return.ts:65](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L65)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/return.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L61)
___
### received\_at
• **received\_at**: `Date`
#### Defined in
[models/return.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L79)
___
### refund\_amount
• **refund\_amount**: `number`
#### Defined in
[models/return.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L76)
___
### shipping\_data
• **shipping\_data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/return.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L73)
___
### shipping\_method
• **shipping\_method**: [`ShippingMethod`](ShippingMethod.md)
#### Defined in
[models/return.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L70)
___
### status
• **status**: [`ReturnStatus`](../enums/ReturnStatus.md)
#### Defined in
[models/return.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L35)
___
### swap
• **swap**: [`Swap`](Swap.md)
#### Defined in
[models/return.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L49)
___
### swap\_id
• **swap\_id**: `string`
#### Defined in
[models/return.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L45)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/return.ts:90](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return.ts#L90)
docs/content/references/entities/classes/ReturnItem.md
+131
View File
@@ -0,0 +1,131 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ReturnItem
## Constructors
### constructor
• **new ReturnItem**()
## Properties
### is\_requested
• **is\_requested**: `boolean`
#### Defined in
[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L28)
___
### item
• **item**: [`LineItem`](LineItem.md)
#### Defined in
[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L22)
___
### item\_id
• **item\_id**: `string`
#### Defined in
[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L14)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L47)
___
### note
• **note**: `string`
#### Defined in
[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L44)
___
### quantity
• **quantity**: `number`
#### Defined in
[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L25)
___
### reason
• **reason**: [`ReturnReason`](ReturnReason.md)
#### Defined in
[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L41)
___
### reason\_id
• **reason\_id**: `string`
#### Defined in
[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L37)
___
### received\_quantity
• **received\_quantity**: `number`
#### Defined in
[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L34)
___
### requested\_quantity
• **requested\_quantity**: `number`
#### Defined in
[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L31)
___
### return\_id
• **return\_id**: `string`
#### Defined in
[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L11)
___
### return\_order
• **return\_order**: [`Return`](Return.md)
#### Defined in
[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-item.ts#L18)
docs/content/references/entities/classes/ReturnReason.md
+161
View File
@@ -0,0 +1,161 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ReturnReason
## Hierarchy
- `SoftDeletableEntity`
↳ **`ReturnReason`**
## Constructors
### constructor
• **new ReturnReason**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### description
• **description**: `string`
#### Defined in
[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L25)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### label
• **label**: `string`
#### Defined in
[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L22)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L42)
___
### parent\_return\_reason
• **parent\_return\_reason**: ``null`` \| [`ReturnReason`](ReturnReason.md)
#### Defined in
[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L32)
___
### parent\_return\_reason\_id
• **parent\_return\_reason\_id**: ``null`` \| `string`
#### Defined in
[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L28)
___
### return\_reason\_children
• **return\_reason\_children**: [`ReturnReason`](ReturnReason.md)[]
#### Defined in
[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L39)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### value
• **value**: `string`
#### Defined in
[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/return-reason.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/return-reason.ts#L44)
docs/content/references/entities/classes/SalesChannel.md
+121
View File
@@ -0,0 +1,121 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: SalesChannel
## Hierarchy
- `SoftDeletableEntity`
↳ **`SalesChannel`**
## Constructors
### constructor
• **new SalesChannel**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### description
• **description**: ``null`` \| `string`
#### Defined in
[models/sales-channel.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L13)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### is\_disabled
• **is\_disabled**: `boolean`
#### Defined in
[models/sales-channel.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L16)
___
### name
• **name**: `string`
#### Defined in
[models/sales-channel.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L10)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/sales-channel.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/sales-channel.ts#L18)
docs/content/references/entities/classes/ShippingMethod.md
+185
View File
@@ -0,0 +1,185 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ShippingMethod
## Constructors
### constructor
• **new ShippingMethod**()
## Properties
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/shipping-method.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L59)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/shipping-method.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L55)
___
### claim\_order
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
#### Defined in
[models/shipping-method.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L51)
___
### claim\_order\_id
• **claim\_order\_id**: ``null`` \| `string`
#### Defined in
[models/shipping-method.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L47)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/shipping-method.ts:90](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L90)
___
### id
• **id**: `string`
#### Defined in
[models/shipping-method.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L31)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/shipping-method.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L43)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/shipping-method.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L39)
___
### price
• **price**: `number`
#### Defined in
[models/shipping-method.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L87)
___
### return\_id
• **return\_id**: `string`
#### Defined in
[models/shipping-method.ts:71](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L71)
___
### return\_order
• **return\_order**: [`Return`](Return.md)
#### Defined in
[models/shipping-method.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L75)
___
### shipping\_option
• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
#### Defined in
[models/shipping-method.ts:79](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L79)
___
### shipping\_option\_id
• **shipping\_option\_id**: `string`
#### Defined in
[models/shipping-method.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L35)
___
### swap
• **swap**: [`Swap`](Swap.md)
#### Defined in
[models/shipping-method.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L67)
___
### swap\_id
• **swap\_id**: `string`
#### Defined in
[models/shipping-method.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L63)
___
### tax\_lines
• **tax\_lines**: [`ShippingMethodTaxLine`](ShippingMethodTaxLine.md)[]
#### Defined in
[models/shipping-method.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L84)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method.ts#L92)
docs/content/references/entities/classes/ShippingMethodTaxLine.md
+153
View File
@@ -0,0 +1,153 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ShippingMethodTaxLine
## Hierarchy
- `TaxLine`
↳ **`ShippingMethodTaxLine`**
## Constructors
### constructor
• **new ShippingMethodTaxLine**()
#### Inherited from
TaxLine.constructor
## Properties
### code
• **code**: ``null`` \| `string`
#### Inherited from
TaxLine.code
#### Defined in
[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L13)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
TaxLine.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### id
• **id**: `string`
#### Inherited from
TaxLine.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Inherited from
TaxLine.metadata
#### Defined in
[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L16)
___
### name
• **name**: `string`
#### Inherited from
TaxLine.name
#### Defined in
[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L10)
___
### rate
• **rate**: `number`
#### Inherited from
TaxLine.rate
#### Defined in
[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-line.ts#L7)
___
### shipping\_method
• **shipping\_method**: [`ShippingMethod`](ShippingMethod.md)
#### Defined in
[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method-tax-line.ts#L24)
___
### shipping\_method\_id
• **shipping\_method\_id**: `string`
#### Defined in
[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method-tax-line.ts#L20)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
TaxLine.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/shipping-method-tax-line.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-method-tax-line.ts#L26)
docs/content/references/entities/classes/ShippingOption.md
+231
View File
@@ -0,0 +1,231 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ShippingOption
## Hierarchy
- `SoftDeletableEntity`
↳ **`ShippingOption`**
## Constructors
### constructor
• **new ShippingOption**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### admin\_only
• **admin\_only**: `boolean`
#### Defined in
[models/shipping-option.ts:65](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L65)
___
### amount
• **amount**: ``null`` \| `number`
#### Defined in
[models/shipping-option.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L59)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/shipping-option.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L73)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### is\_return
• **is\_return**: `boolean`
#### Defined in
[models/shipping-option.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L62)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/shipping-option.ts:76](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L76)
___
### name
• **name**: `string`
#### Defined in
[models/shipping-option.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L29)
___
### price\_type
• **price\_type**: [`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.md)
#### Defined in
[models/shipping-option.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L56)
___
### profile
• **profile**: [`ShippingProfile`](ShippingProfile.md)
#### Defined in
[models/shipping-option.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L45)
___
### profile\_id
• **profile\_id**: `string`
#### Defined in
[models/shipping-option.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L41)
___
### provider
• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md)
#### Defined in
[models/shipping-option.ts:53](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L53)
___
### provider\_id
• **provider\_id**: `string`
#### Defined in
[models/shipping-option.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L49)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/shipping-option.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L37)
___
### region\_id
• **region\_id**: `string`
#### Defined in
[models/shipping-option.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L33)
___
### requirements
• **requirements**: [`ShippingOptionRequirement`](ShippingOptionRequirement.md)[]
#### Defined in
[models/shipping-option.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L70)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option.ts#L78)
docs/content/references/entities/classes/ShippingOptionRequirement.md
+85
View File
@@ -0,0 +1,85 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ShippingOptionRequirement
## Constructors
### constructor
• **new ShippingOptionRequirement**()
## Properties
### amount
• **amount**: `number`
#### Defined in
[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L38)
___
### deleted\_at
• **deleted\_at**: `Date`
#### Defined in
[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L41)
___
### id
• **id**: `string`
#### Defined in
[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L24)
___
### shipping\_option
• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
#### Defined in
[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L32)
___
### shipping\_option\_id
• **shipping\_option\_id**: `string`
#### Defined in
[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L28)
___
### type
• **type**: [`RequirementType`](../enums/RequirementType.md)
#### Defined in
[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L35)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/shipping-option-requirement.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-option-requirement.ts#L43)
docs/content/references/entities/classes/ShippingProfile.md
+141
View File
@@ -0,0 +1,141 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ShippingProfile
## Hierarchy
- `SoftDeletableEntity`
↳ **`ShippingProfile`**
## Constructors
### constructor
• **new ShippingProfile**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/shipping-profile.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L30)
___
### name
• **name**: `string`
#### Defined in
[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L18)
___
### products
• **products**: [`Product`](Product.md)[]
#### Defined in
[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L24)
___
### shipping\_options
• **shipping\_options**: [`ShippingOption`](ShippingOption.md)[]
#### Defined in
[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L27)
___
### type
• **type**: [`ShippingProfileType`](../enums/ShippingProfileType.md)
#### Defined in
[models/shipping-profile.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L21)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/shipping-profile.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-profile.ts#L32)
docs/content/references/entities/classes/ShippingTaxRate.md
+81
View File
@@ -0,0 +1,81 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: ShippingTaxRate
## Constructors
### constructor
• **new ShippingTaxRate**()
## Properties
### created\_at
• **created\_at**: `Date`
#### Defined in
[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L31)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L37)
___
### rate\_id
• **rate\_id**: `string`
#### Defined in
[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L20)
___
### shipping\_option
• `Optional` **shipping\_option**: [`ShippingOption`](ShippingOption.md)
#### Defined in
[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L24)
___
### shipping\_option\_id
• **shipping\_option\_id**: `string`
#### Defined in
[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L17)
___
### tax\_rate
• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md)
#### Defined in
[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L28)
___
### updated\_at
• **updated\_at**: `Date`
#### Defined in
[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/shipping-tax-rate.ts#L34)
docs/content/references/entities/classes/StagedJob.md
+55
View File
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: StagedJob
## Constructors
### constructor
• **new StagedJob**()
## Properties
### data
• **data**: `Record`<`string`, `unknown`\>
#### Defined in
[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L15)
___
### event\_name
• **event\_name**: `string`
#### Defined in
[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L12)
___
### id
• **id**: `string`
#### Defined in
[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L9)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/staged-job.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/staged-job.ts#L17)
docs/content/references/entities/classes/Store.md
+177
View File
@@ -0,0 +1,177 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Store
## Hierarchy
- `BaseEntity`
↳ **`Store`**
## Constructors
### constructor
• **new Store**()
#### Inherited from
BaseEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### currencies
• **currencies**: [`Currency`](Currency.md)[]
#### Defined in
[models/store.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L46)
___
### default\_currency
• **default\_currency**: [`Currency`](Currency.md)
#### Defined in
[models/store.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L32)
___
### default\_currency\_code
• **default\_currency\_code**: `string`
#### Defined in
[models/store.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L28)
___
### default\_sales\_channel
• **default\_sales\_channel**: [`SalesChannel`](SalesChannel.md)
#### Defined in
[models/store.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L67)
___
### default\_sales\_channel\_id
• **default\_sales\_channel\_id**: `string`
#### Defined in
[models/store.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L61)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### invite\_link\_template
• **invite\_link\_template**: `string`
#### Defined in
[models/store.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L55)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/store.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L58)
___
### name
• **name**: `string`
#### Defined in
[models/store.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L25)
___
### payment\_link\_template
• **payment\_link\_template**: `string`
#### Defined in
[models/store.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L52)
___
### swap\_link\_template
• **swap\_link\_template**: `string`
#### Defined in
[models/store.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L49)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/store.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/store.ts#L69)
docs/content/references/entities/classes/Swap.md
+291
View File
@@ -0,0 +1,291 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: Swap
## Hierarchy
- `SoftDeletableEntity`
↳ **`Swap`**
## Constructors
### constructor
• **new Swap**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### additional\_items
• **additional\_items**: [`LineItem`](LineItem.md)[]
#### Defined in
[models/swap.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L61)
___
### allow\_backorder
• **allow\_backorder**: `boolean`
#### Defined in
[models/swap.ts:106](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L106)
___
### canceled\_at
• **canceled\_at**: `Date`
#### Defined in
[models/swap.ts:100](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L100)
___
### cart
• **cart**: [`Cart`](Cart.md)
#### Defined in
[models/swap.ts:94](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L94)
___
### cart\_id
• **cart\_id**: `string`
#### Defined in
[models/swap.ts:90](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L90)
___
### confirmed\_at
• **confirmed\_at**: `Date`
#### Defined in
[models/swap.ts:97](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L97)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### difference\_due
• **difference\_due**: `number`
#### Defined in
[models/swap.ts:75](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L75)
___
### fulfillment\_status
• **fulfillment\_status**: [`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.md)
#### Defined in
[models/swap.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L47)
___
### fulfillments
• **fulfillments**: [`Fulfillment`](Fulfillment.md)[]
#### Defined in
[models/swap.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L69)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/swap.ts:109](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L109)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/swap.ts:112](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L112)
___
### no\_notification
• **no\_notification**: `boolean`
#### Defined in
[models/swap.ts:103](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L103)
___
### order
• **order**: [`Order`](Order.md)
#### Defined in
[models/swap.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L58)
___
### order\_id
• **order\_id**: `string`
#### Defined in
[models/swap.ts:54](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L54)
___
### payment
• **payment**: [`Payment`](Payment.md)
#### Defined in
[models/swap.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L72)
___
### payment\_status
• **payment\_status**: [`SwapPaymentStatus`](../enums/SwapPaymentStatus.md)
#### Defined in
[models/swap.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L50)
___
### return\_order
• **return\_order**: [`Return`](Return.md)
#### Defined in
[models/swap.ts:64](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L64)
___
### shipping\_address
• **shipping\_address**: [`Address`](Address.md)
#### Defined in
[models/swap.ts:82](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L82)
___
### shipping\_address\_id
• **shipping\_address\_id**: `string`
#### Defined in
[models/swap.ts:78](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L78)
___
### shipping\_methods
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
#### Defined in
[models/swap.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L87)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/swap.ts:114](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/swap.ts#L114)
docs/content/references/entities/classes/TaxProvider.md
+31
View File
@@ -0,0 +1,31 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: TaxProvider
## Constructors
### constructor
• **new TaxProvider**()
## Properties
### id
• **id**: `string`
#### Defined in
[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-provider.ts#L6)
___
### is\_installed
• **is\_installed**: `boolean`
#### Defined in
[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-provider.ts#L9)
docs/content/references/entities/classes/TaxRate.md
+197
View File
@@ -0,0 +1,197 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: TaxRate
## Hierarchy
- `BaseEntity`
↳ **`TaxRate`**
## Constructors
### constructor
• **new TaxRate**()
#### Inherited from
BaseEntity.constructor
## Properties
### code
• **code**: ``null`` \| `string`
#### Defined in
[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L25)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
BaseEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### id
• **id**: `string`
#### Inherited from
BaseEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L38)
___
### name
• **name**: `string`
#### Defined in
[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L28)
___
### product\_count
• `Optional` **product\_count**: `number`
#### Defined in
[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L83)
___
### product\_type\_count
• `Optional` **product\_type\_count**: `number`
#### Defined in
[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L84)
___
### product\_types
• **product\_types**: [`ProductType`](ProductType.md)[]
#### Defined in
[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L66)
___
### products
• **products**: [`Product`](Product.md)[]
#### Defined in
[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L52)
___
### rate
• **rate**: ``null`` \| `number`
#### Defined in
[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L22)
___
### region
• **region**: [`Region`](Region.md)
#### Defined in
[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L35)
___
### region\_id
• **region\_id**: `string`
#### Defined in
[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L31)
___
### shipping\_option\_count
• `Optional` **shipping\_option\_count**: `number`
#### Defined in
[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L85)
___
### shipping\_options
• **shipping\_options**: [`ShippingOption`](ShippingOption.md)[]
#### Defined in
[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L80)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
BaseEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/tax-rate.ts:87](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tax-rate.ts#L87)
docs/content/references/entities/classes/TrackingLink.md
+151
View File
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: TrackingLink
## Hierarchy
- `SoftDeletableEntity`
↳ **`TrackingLink`**
## Constructors
### constructor
• **new TrackingLink**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### fulfillment
• **fulfillment**: [`Fulfillment`](Fulfillment.md)
#### Defined in
[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L21)
___
### fulfillment\_id
• **fulfillment\_id**: `string`
#### Defined in
[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L17)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### idempotency\_key
• **idempotency\_key**: `string`
#### Defined in
[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L24)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L27)
___
### tracking\_number
• **tracking\_number**: `string`
#### Defined in
[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L14)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
___
### url
• **url**: `string`
#### Defined in
[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L11)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/tracking-link.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/tracking-link.ts#L29)
docs/content/references/entities/classes/User.md
+161
View File
@@ -0,0 +1,161 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: User
## Hierarchy
- `SoftDeletableEntity`
↳ **`User`**
## Constructors
### constructor
• **new User**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### api\_token
• **api\_token**: `string`
#### Defined in
[models/user.ts:37](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L37)
___
### created\_at
• **created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
• **deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### email
• **email**: `string`
#### Defined in
[models/user.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L25)
___
### first\_name
• **first\_name**: `string`
#### Defined in
[models/user.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L28)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### last\_name
• **last\_name**: `string`
#### Defined in
[models/user.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L31)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/user.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L40)
___
### password\_hash
• **password\_hash**: `string`
#### Defined in
[models/user.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L34)
___
### role
• **role**: [`UserRoles`](../enums/UserRoles.md)
#### Defined in
[models/user.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L21)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/user.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/user.ts#L42)
docs/content/references/entities/enums/AllocationType.md
+25
View File
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: AllocationType
## Enumeration Members
### ITEM
• **ITEM** = ``"item"``
#### Defined in
[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L16)
___
### TOTAL
• **TOTAL** = ``"total"``
#### Defined in
[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L15)
docs/content/references/entities/enums/CartType.md
+55
View File
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: CartType
## Enumeration Members
### CLAIM
• **CLAIM** = ``"claim"``
#### Defined in
[models/cart.ts:208](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L208)
___
### DEFAULT
• **DEFAULT** = ``"default"``
#### Defined in
[models/cart.ts:204](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L204)
___
### DRAFT\_ORDER
• **DRAFT\_ORDER** = ``"draft_order"``
#### Defined in
[models/cart.ts:206](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L206)
___
### PAYMENT\_LINK
• **PAYMENT\_LINK** = ``"payment_link"``
#### Defined in
[models/cart.ts:207](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L207)
___
### SWAP
• **SWAP** = ``"swap"``
#### Defined in
[models/cart.ts:205](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/cart.ts#L205)
docs/content/references/entities/enums/ClaimFulfillmentStatus.md
+95
View File
@@ -0,0 +1,95 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimFulfillmentStatus
## Enumeration Members
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L45)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L40)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L38)
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L39)
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L43)
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L41)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L46)
___
### RETURNED
• **RETURNED** = ``"returned"``
#### Defined in
[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L44)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L42)
docs/content/references/entities/enums/ClaimPaymentStatus.md
+35
View File
@@ -0,0 +1,35 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimPaymentStatus
## Enumeration Members
### NA
• **NA** = ``"na"``
#### Defined in
[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L32)
___
### NOT\_REFUNDED
• **NOT\_REFUNDED** = ``"not_refunded"``
#### Defined in
[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L33)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L34)
docs/content/references/entities/enums/ClaimReason.md
+45
View File
@@ -0,0 +1,45 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimReason
## Enumeration Members
### MISSING\_ITEM
• **MISSING\_ITEM** = ``"missing_item"``
#### Defined in
[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L23)
___
### OTHER
• **OTHER** = ``"other"``
#### Defined in
[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L26)
___
### PRODUCTION\_FAILURE
• **PRODUCTION\_FAILURE** = ``"production_failure"``
#### Defined in
[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L25)
___
### WRONG\_ITEM
• **WRONG\_ITEM** = ``"wrong_item"``
#### Defined in
[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-item.ts#L24)
docs/content/references/entities/enums/ClaimType.md
+25
View File
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimType
## Enumeration Members
### REFUND
• **REFUND** = ``"refund"``
#### Defined in
[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L27)
___
### REPLACE
• **REPLACE** = ``"replace"``
#### Defined in
[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/claim-order.ts#L28)
docs/content/references/entities/enums/DiscountConditionOperator.md
+25
View File
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountConditionOperator
## Enumeration Members
### IN
• **IN** = ``"in"``
#### Defined in
[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L32)
___
### NOT\_IN
• **NOT\_IN** = ``"not_in"``
#### Defined in
[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L33)
docs/content/references/entities/enums/DiscountConditionType.md
+55
View File
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountConditionType
## Enumeration Members
### CUSTOMER\_GROUPS
• **CUSTOMER\_GROUPS** = ``"customer_groups"``
#### Defined in
[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L28)
___
### PRODUCTS
• **PRODUCTS** = ``"products"``
#### Defined in
[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L24)
___
### PRODUCT\_COLLECTIONS
• **PRODUCT\_COLLECTIONS** = ``"product_collections"``
#### Defined in
[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L26)
___
### PRODUCT\_TAGS
• **PRODUCT\_TAGS** = ``"product_tags"``
#### Defined in
[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L27)
___
### PRODUCT\_TYPES
• **PRODUCT\_TYPES** = ``"product_types"``
#### Defined in
[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-condition.ts#L25)
docs/content/references/entities/enums/DiscountRuleType.md
+35
View File
@@ -0,0 +1,35 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountRuleType
## Enumeration Members
### FIXED
• **FIXED** = ``"fixed"``
#### Defined in
[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L9)
___
### FREE\_SHIPPING
• **FREE\_SHIPPING** = ``"free_shipping"``
#### Defined in
[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L11)
___
### PERCENTAGE
• **PERCENTAGE** = ``"percentage"``
#### Defined in
[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/discount-rule.ts#L10)
docs/content/references/entities/enums/DraftOrderStatus.md
+25
View File
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DraftOrderStatus
## Enumeration Members
### COMPLETED
• **COMPLETED** = ``"completed"``
#### Defined in
[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L24)
___
### OPEN
• **OPEN** = ``"open"``
#### Defined in
[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/draft-order.ts#L23)
docs/content/references/entities/enums/FulfillmentStatus.md
+95
View File
@@ -0,0 +1,95 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: FulfillmentStatus
## Enumeration Members
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:62](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L62)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/order.ts:57](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L57)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/order.ts:55](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L55)
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
[models/order.ts:56](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L56)
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
[models/order.ts:60](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L60)
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
[models/order.ts:58](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L58)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:63](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L63)
___
### RETURNED
• **RETURNED** = ``"returned"``
#### Defined in
[models/order.ts:61](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L61)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/order.ts:59](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L59)
docs/content/references/entities/enums/OrderStatus.md
+55
View File
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: OrderStatus
## Enumeration Members
### ARCHIVED
• **ARCHIVED** = ``"archived"``
#### Defined in
[models/order.ts:49](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L49)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:50](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L50)
___
### COMPLETED
• **COMPLETED** = ``"completed"``
#### Defined in
[models/order.ts:48](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L48)
___
### PENDING
• **PENDING** = ``"pending"``
#### Defined in
[models/order.ts:47](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L47)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:51](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L51)
docs/content/references/entities/enums/PaymentSessionStatus.md
+55
View File
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentSessionStatus
## Enumeration Members
### AUTHORIZED
• **AUTHORIZED** = ``"authorized"``
#### Defined in
[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L17)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L21)
___
### ERROR
• **ERROR** = ``"error"``
#### Defined in
[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L20)
___
### PENDING
• **PENDING** = ``"pending"``
#### Defined in
[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L18)
___
### REQUIRES\_MORE
• **REQUIRES\_MORE** = ``"requires_more"``
#### Defined in
[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/payment-session.ts#L19)
docs/content/references/entities/enums/PaymentStatus.md
+75
View File
@@ -0,0 +1,75 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentStatus
## Enumeration Members
### AWAITING
• **AWAITING** = ``"awaiting"``
#### Defined in
[models/order.ts:68](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L68)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:72](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L72)
___
### CAPTURED
• **CAPTURED** = ``"captured"``
#### Defined in
[models/order.ts:69](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L69)
___
### NOT\_PAID
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
[models/order.ts:67](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L67)
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
[models/order.ts:70](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L70)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/order.ts:71](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L71)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:73](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/order.ts#L73)
docs/content/references/entities/enums/ProductStatus.md
+45
View File
@@ -0,0 +1,45 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ProductStatus
## Enumeration Members
### DRAFT
• **DRAFT** = ``"draft"``
#### Defined in
[models/product.ts:28](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L28)
___
### PROPOSED
• **PROPOSED** = ``"proposed"``
#### Defined in
[models/product.ts:29](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L29)
___
### PUBLISHED
• **PUBLISHED** = ``"published"``
#### Defined in
[models/product.ts:30](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L30)
___
### REJECTED
• **REJECTED** = ``"rejected"``
#### Defined in
[models/product.ts:31](https://github.com/medusajs/medusa/blob/aada5327e/packages/medusa/src/models/product.ts#L31)
Loaded 100 of 160 files, more files were not shown because too many files have changed in this diff. Show more