docs: update override price selection strategy documentation (#5438)

* docs: update override price selection strategy documentation

* fix eslint errors
This commit is contained in:
Shahed Nasser
2023-10-20 20:17:45 +03:00
committed by GitHub
parent 8bc902fb0f
commit 1a10822cae
540 changed files with 244366 additions and 18865 deletions
@@ -1,25 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: AllocationType
## Enumeration Members
### ITEM
**ITEM** = ``"item"``
#### Defined in
[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L16)
___
### TOTAL
• **TOTAL** = ``"total"``
#### Defined in
[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L15)
@@ -0,0 +1,19 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AllocationType
## Enumeration Members
### ITEM
**ITEM** = ``"item"``
___
### TOTAL
**TOTAL** = ``"total"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: CartType
## Enumeration Members
### CLAIM
**CLAIM** = ``"claim"``
#### Defined in
[models/cart.ts:270](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L270)
___
### DEFAULT
• **DEFAULT** = ``"default"``
#### Defined in
[models/cart.ts:266](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L266)
___
### DRAFT\_ORDER
• **DRAFT\_ORDER** = ``"draft_order"``
#### Defined in
[models/cart.ts:268](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L268)
___
### PAYMENT\_LINK
• **PAYMENT\_LINK** = ``"payment_link"``
#### Defined in
[models/cart.ts:269](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L269)
___
### SWAP
• **SWAP** = ``"swap"``
#### Defined in
[models/cart.ts:267](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L267)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CartType
## Enumeration Members
### CLAIM
**CLAIM** = ``"claim"``
___
### DEFAULT
**DEFAULT** = ``"default"``
___
### DRAFT\_ORDER
**DRAFT\_ORDER** = ``"draft_order"``
___
### PAYMENT\_LINK
**PAYMENT\_LINK** = ``"payment_link"``
___
### SWAP
**SWAP** = ``"swap"``
@@ -1,95 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimFulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L45)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/models/claim-order.ts#L46)
___
### RETURNED
• **RETURNED** = ``"returned"``
#### Defined in
[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L44)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L42)
@@ -0,0 +1,61 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ClaimFulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
___
### FULFILLED
**FULFILLED** = ``"fulfilled"``
___
### NOT\_FULFILLED
**NOT\_FULFILLED** = ``"not_fulfilled"``
___
### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
___
### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = ``"partially_returned"``
___
### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = ``"partially_shipped"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
___
### RETURNED
**RETURNED** = ``"returned"``
___
### SHIPPED
**SHIPPED** = ``"shipped"``
@@ -1,35 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimPaymentStatus
## Enumeration Members
### NA
**NA** = ``"na"``
#### Defined in
[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/models/claim-order.ts#L33)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L34)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ClaimPaymentStatus
## Enumeration Members
### NA
**NA** = ``"na"``
___
### NOT\_REFUNDED
**NOT\_REFUNDED** = ``"not_refunded"``
___
### REFUNDED
**REFUNDED** = ``"refunded"``
@@ -1,45 +0,0 @@
---
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/b38f73726/packages/medusa/src/models/claim-item.ts#L23)
___
### OTHER
• **OTHER** = ``"other"``
#### Defined in
[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/models/claim-item.ts#L24)
@@ -0,0 +1,31 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ClaimReason
## Enumeration Members
### MISSING\_ITEM
**MISSING\_ITEM** = ``"missing_item"``
___
### OTHER
**OTHER** = ``"other"``
___
### PRODUCTION\_FAILURE
**PRODUCTION\_FAILURE** = ``"production_failure"``
___
### WRONG\_ITEM
**WRONG\_ITEM** = ``"wrong_item"``
@@ -1,25 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimType
## Enumeration Members
### REFUND
**REFUND** = ``"refund"``
#### Defined in
[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L27)
___
### REPLACE
• **REPLACE** = ``"replace"``
#### Defined in
[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L28)
@@ -0,0 +1,19 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ClaimType
## Enumeration Members
### REFUND
**REFUND** = ``"refund"``
___
### REPLACE
**REPLACE** = ``"replace"``
@@ -1,25 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountConditionOperator
## Enumeration Members
### IN
**IN** = ``"in"``
#### Defined in
[models/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L34)
___
### NOT\_IN
• **NOT\_IN** = ``"not_in"``
#### Defined in
[models/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L35)
@@ -0,0 +1,19 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# DiscountConditionOperator
## Enumeration Members
### IN
**IN** = ``"in"``
___
### NOT\_IN
**NOT\_IN** = ``"not_in"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountConditionType
## Enumeration Members
### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = ``"customer_groups"``
#### Defined in
[models/discount-condition.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L30)
___
### PRODUCTS
• **PRODUCTS** = ``"products"``
#### Defined in
[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L26)
___
### PRODUCT\_COLLECTIONS
• **PRODUCT\_COLLECTIONS** = ``"product_collections"``
#### Defined in
[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L28)
___
### PRODUCT\_TAGS
• **PRODUCT\_TAGS** = ``"product_tags"``
#### Defined in
[models/discount-condition.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L29)
___
### PRODUCT\_TYPES
• **PRODUCT\_TYPES** = ``"product_types"``
#### Defined in
[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L27)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# DiscountConditionType
## Enumeration Members
### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = ``"customer_groups"``
___
### PRODUCTS
**PRODUCTS** = ``"products"``
___
### PRODUCT\_COLLECTIONS
**PRODUCT\_COLLECTIONS** = ``"product_collections"``
___
### PRODUCT\_TAGS
**PRODUCT\_TAGS** = ``"product_tags"``
___
### PRODUCT\_TYPES
**PRODUCT\_TYPES** = ``"product_types"``
@@ -1,35 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountRuleType
## Enumeration Members
### FIXED
**FIXED** = ``"fixed"``
#### Defined in
[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/models/discount-rule.ts#L11)
___
### PERCENTAGE
• **PERCENTAGE** = ``"percentage"``
#### Defined in
[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L10)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# DiscountRuleType
## Enumeration Members
### FIXED
**FIXED** = ``"fixed"``
___
### FREE\_SHIPPING
**FREE\_SHIPPING** = ``"free_shipping"``
___
### PERCENTAGE
**PERCENTAGE** = ``"percentage"``
@@ -1,25 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DraftOrderStatus
## Enumeration Members
### COMPLETED
**COMPLETED** = ``"completed"``
#### Defined in
[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L23)
___
### OPEN
• **OPEN** = ``"open"``
#### Defined in
[models/draft-order.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L22)
@@ -0,0 +1,19 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# DraftOrderStatus
## Enumeration Members
### COMPLETED
**COMPLETED** = ``"completed"``
___
### OPEN
**OPEN** = ``"open"``
@@ -1,95 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: FulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L56)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/order.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L51)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/order.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L49)
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
[models/order.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L50)
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
[models/order.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L54)
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
[models/order.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L52)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L57)
___
### RETURNED
• **RETURNED** = ``"returned"``
#### Defined in
[models/order.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L55)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/order.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L53)
@@ -0,0 +1,61 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
___
### FULFILLED
**FULFILLED** = ``"fulfilled"``
___
### NOT\_FULFILLED
**NOT\_FULFILLED** = ``"not_fulfilled"``
___
### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
___
### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = ``"partially_returned"``
___
### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = ``"partially_shipped"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
___
### RETURNED
**RETURNED** = ``"returned"``
___
### SHIPPED
**SHIPPED** = ``"shipped"``
@@ -1,35 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: OrderEditItemChangeType
## Enumeration Members
### ITEM\_ADD
**ITEM\_ADD** = ``"item_add"``
#### Defined in
[models/order-item-change.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L18)
___
### ITEM\_REMOVE
• **ITEM\_REMOVE** = ``"item_remove"``
#### Defined in
[models/order-item-change.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L19)
___
### ITEM\_UPDATE
• **ITEM\_UPDATE** = ``"item_update"``
#### Defined in
[models/order-item-change.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L20)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# OrderEditItemChangeType
## Enumeration Members
### ITEM\_ADD
**ITEM\_ADD** = ``"item_add"``
___
### ITEM\_REMOVE
**ITEM\_REMOVE** = ``"item_remove"``
___
### ITEM\_UPDATE
**ITEM\_UPDATE** = ``"item_update"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: OrderEditStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/order-edit.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L24)
___
### CONFIRMED
• **CONFIRMED** = ``"confirmed"``
#### Defined in
[models/order-edit.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L20)
___
### CREATED
• **CREATED** = ``"created"``
#### Defined in
[models/order-edit.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L23)
___
### DECLINED
• **DECLINED** = ``"declined"``
#### Defined in
[models/order-edit.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L21)
___
### REQUESTED
• **REQUESTED** = ``"requested"``
#### Defined in
[models/order-edit.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L22)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# OrderEditStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
___
### CONFIRMED
**CONFIRMED** = ``"confirmed"``
___
### CREATED
**CREATED** = ``"created"``
___
### DECLINED
**DECLINED** = ``"declined"``
___
### REQUESTED
**REQUESTED** = ``"requested"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: OrderStatus
## Enumeration Members
### ARCHIVED
**ARCHIVED** = ``"archived"``
#### Defined in
[models/order.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L43)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L44)
___
### COMPLETED
• **COMPLETED** = ``"completed"``
#### Defined in
[models/order.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L42)
___
### PENDING
• **PENDING** = ``"pending"``
#### Defined in
[models/order.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L41)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L45)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# OrderStatus
## Enumeration Members
### ARCHIVED
**ARCHIVED** = ``"archived"``
___
### CANCELED
**CANCELED** = ``"canceled"``
___
### COMPLETED
**COMPLETED** = ``"completed"``
___
### PENDING
**PENDING** = ``"pending"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentCollectionStatus
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
#### Defined in
[models/payment-collection.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L20)
___
### AWAITING
• **AWAITING** = ``"awaiting"``
#### Defined in
[models/payment-collection.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L19)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/payment-collection.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L22)
___
### NOT\_PAID
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
[models/payment-collection.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L18)
___
### PARTIALLY\_AUTHORIZED
• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"``
#### Defined in
[models/payment-collection.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L21)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PaymentCollectionStatus
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
___
### AWAITING
**AWAITING** = ``"awaiting"``
___
### CANCELED
**CANCELED** = ``"canceled"``
___
### NOT\_PAID
**NOT\_PAID** = ``"not_paid"``
___
### PARTIALLY\_AUTHORIZED
**PARTIALLY\_AUTHORIZED** = ``"partially_authorized"``
@@ -1,15 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentCollectionType
## Enumeration Members
### ORDER\_EDIT
**ORDER\_EDIT** = ``"order_edit"``
#### Defined in
[models/payment-collection.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L26)
@@ -0,0 +1,13 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PaymentCollectionType
## Enumeration Members
### ORDER\_EDIT
**ORDER\_EDIT** = ``"order_edit"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentSessionStatus
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
#### Defined in
[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L17)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L21)
___
### ERROR
• **ERROR** = ``"error"``
#### Defined in
[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L20)
___
### PENDING
• **PENDING** = ``"pending"``
#### Defined in
[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/models/payment-session.ts#L19)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PaymentSessionStatus
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
___
### CANCELED
**CANCELED** = ``"canceled"``
___
### ERROR
**ERROR** = ``"error"``
___
### PENDING
**PENDING** = ``"pending"``
___
### REQUIRES\_MORE
**REQUIRES\_MORE** = ``"requires_more"``
@@ -1,75 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentStatus
## Enumeration Members
### AWAITING
**AWAITING** = ``"awaiting"``
#### Defined in
[models/order.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L62)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L66)
___
### CAPTURED
• **CAPTURED** = ``"captured"``
#### Defined in
[models/order.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L63)
___
### NOT\_PAID
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
[models/order.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L61)
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
[models/order.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L64)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/order.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L65)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L67)
@@ -0,0 +1,49 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PaymentStatus
## Enumeration Members
### AWAITING
**AWAITING** = ``"awaiting"``
___
### CANCELED
**CANCELED** = ``"canceled"``
___
### CAPTURED
**CAPTURED** = ``"captured"``
___
### NOT\_PAID
**NOT\_PAID** = ``"not_paid"``
___
### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = ``"partially_refunded"``
___
### REFUNDED
**REFUNDED** = ``"refunded"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
@@ -1,45 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ProductStatus
## Enumeration Members
### DRAFT
**DRAFT** = ``"draft"``
#### Defined in
[models/product.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L31)
___
### PROPOSED
• **PROPOSED** = ``"proposed"``
#### Defined in
[models/product.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L32)
___
### PUBLISHED
• **PUBLISHED** = ``"published"``
#### Defined in
[models/product.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L33)
___
### REJECTED
• **REJECTED** = ``"rejected"``
#### Defined in
[models/product.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L34)
@@ -0,0 +1,31 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ProductStatus
## Enumeration Members
### DRAFT
**DRAFT** = ``"draft"``
___
### PROPOSED
**PROPOSED** = ``"proposed"``
___
### PUBLISHED
**PUBLISHED** = ``"published"``
___
### REJECTED
**REJECTED** = ``"rejected"``
@@ -1,55 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: RefundReason
## Enumeration Members
### CLAIM
**CLAIM** = ``"claim"``
#### Defined in
[models/refund.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L21)
___
### DISCOUNT
• **DISCOUNT** = ``"discount"``
#### Defined in
[models/refund.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L18)
___
### OTHER
• **OTHER** = ``"other"``
#### Defined in
[models/refund.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L22)
___
### RETURN
• **RETURN** = ``"return"``
#### Defined in
[models/refund.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L19)
___
### SWAP
• **SWAP** = ``"swap"``
#### Defined in
[models/refund.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L20)
@@ -0,0 +1,37 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RefundReason
## Enumeration Members
### CLAIM
**CLAIM** = ``"claim"``
___
### DISCOUNT
**DISCOUNT** = ``"discount"``
___
### OTHER
**OTHER** = ``"other"``
___
### RETURN
**RETURN** = ``"return"``
___
### SWAP
**SWAP** = ``"swap"``
@@ -1,25 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: RequirementType
## Enumeration Members
### MAX\_SUBTOTAL
**MAX\_SUBTOTAL** = ``"max_subtotal"``
#### Defined in
[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L18)
___
### MIN\_SUBTOTAL
• **MIN\_SUBTOTAL** = ``"min_subtotal"``
#### Defined in
[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L17)
@@ -0,0 +1,19 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# RequirementType
## Enumeration Members
### MAX\_SUBTOTAL
**MAX\_SUBTOTAL** = ``"max_subtotal"``
___
### MIN\_SUBTOTAL
**MIN\_SUBTOTAL** = ``"min_subtotal"``
@@ -1,45 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ReturnStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/return.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L25)
___
### RECEIVED
• **RECEIVED** = ``"received"``
#### Defined in
[models/return.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L23)
___
### REQUESTED
• **REQUESTED** = ``"requested"``
#### Defined in
[models/return.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L22)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/return.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L24)
@@ -0,0 +1,31 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ReturnStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
___
### RECEIVED
**RECEIVED** = ``"received"``
___
### REQUESTED
**REQUESTED** = ``"requested"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
@@ -1,25 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ShippingOptionPriceType
## Enumeration Members
### CALCULATED
**CALCULATED** = ``"calculated"``
#### Defined in
[models/shipping-option.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L24)
___
### FLAT\_RATE
• **FLAT\_RATE** = ``"flat_rate"``
#### Defined in
[models/shipping-option.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L23)
@@ -0,0 +1,19 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ShippingOptionPriceType
## Enumeration Members
### CALCULATED
**CALCULATED** = ``"calculated"``
___
### FLAT\_RATE
**FLAT\_RATE** = ``"flat_rate"``
@@ -1,35 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ShippingProfileType
## Enumeration Members
### CUSTOM
**CUSTOM** = ``"custom"``
#### Defined in
[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L18)
___
### DEFAULT
• **DEFAULT** = ``"default"``
#### Defined in
[models/shipping-profile.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L16)
___
### GIFT\_CARD
• **GIFT\_CARD** = ``"gift_card"``
#### Defined in
[models/shipping-profile.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L17)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ShippingProfileType
## Enumeration Members
### CUSTOM
**CUSTOM** = ``"custom"``
___
### DEFAULT
**DEFAULT** = ``"default"``
___
### GIFT\_CARD
**GIFT\_CARD** = ``"gift_card"``
@@ -1,65 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: SwapFulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/swap.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L29)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/swap.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L26)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/swap.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L25)
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
[models/swap.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L28)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/swap.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L30)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/swap.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L27)
@@ -0,0 +1,43 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SwapFulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
___
### FULFILLED
**FULFILLED** = ``"fulfilled"``
___
### NOT\_FULFILLED
**NOT\_FULFILLED** = ``"not_fulfilled"``
___
### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = ``"partially_shipped"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
___
### SHIPPED
**SHIPPED** = ``"shipped"``
@@ -1,95 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: SwapPaymentStatus
## Enumeration Members
### AWAITING
**AWAITING** = ``"awaiting"``
#### Defined in
[models/swap.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L35)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/swap.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L38)
___
### CAPTURED
• **CAPTURED** = ``"captured"``
#### Defined in
[models/swap.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L36)
___
### CONFIRMED
• **CONFIRMED** = ``"confirmed"``
#### Defined in
[models/swap.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L37)
___
### DIFFERENCE\_REFUNDED
• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"``
#### Defined in
[models/swap.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L39)
___
### NOT\_PAID
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
[models/swap.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L34)
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
[models/swap.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L40)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/swap.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L41)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/swap.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L42)
@@ -0,0 +1,61 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# SwapPaymentStatus
## Enumeration Members
### AWAITING
**AWAITING** = ``"awaiting"``
___
### CANCELED
**CANCELED** = ``"canceled"``
___
### CAPTURED
**CAPTURED** = ``"captured"``
___
### CONFIRMED
**CONFIRMED** = ``"confirmed"``
___
### DIFFERENCE\_REFUNDED
**DIFFERENCE\_REFUNDED** = ``"difference_refunded"``
___
### NOT\_PAID
**NOT\_PAID** = ``"not_paid"``
___
### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = ``"partially_refunded"``
___
### REFUNDED
**REFUNDED** = ``"refunded"``
___
### REQUIRES\_ACTION
**REQUIRES\_ACTION** = ``"requires_action"``
@@ -1,35 +0,0 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: UserRoles
## Enumeration Members
### ADMIN
**ADMIN** = ``"admin"``
#### Defined in
[models/user.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L8)
___
### DEVELOPER
• **DEVELOPER** = ``"developer"``
#### Defined in
[models/user.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L10)
___
### MEMBER
• **MEMBER** = ``"member"``
#### Defined in
[models/user.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L9)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# UserRoles
## Enumeration Members
### ADMIN
**ADMIN** = ``"admin"``
___
### DEVELOPER
**DEVELOPER** = ``"developer"``
___
### MEMBER
**MEMBER** = ``"member"``