docs: migrate guides to TSDoc references (#6100)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
85dad169bb
commit
4792c55226
980 files changed
+195537
-160619
No files matched your search
@@ -11,4 +11,4 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[{"name":"context","type":"`Record<string, unknown>`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record<string, unknown>`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
<ParameterTypes parameters={[{"name":"context","type":"`Record<string, unknown>`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record<string, unknown>`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"chiLine truncated
|
||||
@@ -11,4 +11,4 @@ A Price List represents a set of prices that override the default price for one
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"",Line truncated
|
||||
<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"",Line truncated
|
||||
@@ -16,8 +16,6 @@ The scope that the discount should apply to.
|
||||
|
||||
The discount should be applied to applicable items in the cart.
|
||||
|
||||
___
|
||||
|
||||
### TOTAL
|
||||
|
||||
**TOTAL** = `"total"`
|
||||
|
||||
@@ -12,26 +12,18 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
**CLAIM** = `"claim"`
|
||||
|
||||
___
|
||||
|
||||
### DEFAULT
|
||||
|
||||
**DEFAULT** = `"default"`
|
||||
|
||||
___
|
||||
|
||||
### DRAFT\_ORDER
|
||||
|
||||
**DRAFT\_ORDER** = `"draft_order"`
|
||||
|
||||
___
|
||||
|
||||
### PAYMENT\_LINK
|
||||
|
||||
**PAYMENT\_LINK** = `"payment_link"`
|
||||
|
||||
___
|
||||
|
||||
### SWAP
|
||||
|
||||
**SWAP** = `"swap"`
|
||||
@@ -16,64 +16,48 @@ The claim's fulfillment status.
|
||||
|
||||
The claim's fulfillments are canceled.
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
**FULFILLED** = `"fulfilled"`
|
||||
|
||||
The claim's replacement items are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
**NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
The claim's replacement items are not fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_FULFILLED
|
||||
|
||||
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
|
||||
|
||||
Some of the claim's replacement items, but not all, are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_RETURNED
|
||||
|
||||
**PARTIALLY\_RETURNED** = `"partially_returned"`
|
||||
|
||||
Some of the claim's items, but not all, are returned.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
Some of the claim's replacement items, but not all, are shipped.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The claim's fulfillment requires action.
|
||||
|
||||
___
|
||||
|
||||
### RETURNED
|
||||
|
||||
**RETURNED** = `"returned"`
|
||||
|
||||
The claim's items are returned.
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
**SHIPPED** = `"shipped"`
|
||||
|
||||
@@ -16,16 +16,12 @@ The claim's payment status
|
||||
|
||||
The payment status isn't set, which is typically used when the claim's type is `replace`.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_REFUNDED
|
||||
|
||||
**NOT\_REFUNDED** = `"not_refunded"`
|
||||
|
||||
The payment isn't refunded.
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
**REFUNDED** = `"refunded"`
|
||||
|
||||
@@ -12,20 +12,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
**MISSING\_ITEM** = `"missing_item"`
|
||||
|
||||
___
|
||||
|
||||
### OTHER
|
||||
|
||||
**OTHER** = `"other"`
|
||||
|
||||
___
|
||||
|
||||
### PRODUCTION\_FAILURE
|
||||
|
||||
**PRODUCTION\_FAILURE** = `"production_failure"`
|
||||
|
||||
___
|
||||
|
||||
### WRONG\_ITEM
|
||||
|
||||
**WRONG\_ITEM** = `"wrong_item"`
|
||||
@@ -16,8 +16,6 @@ The claim's type.
|
||||
|
||||
The claim refunds an amount to the customer.
|
||||
|
||||
___
|
||||
|
||||
### REPLACE
|
||||
|
||||
**REPLACE** = `"replace"`
|
||||
|
||||
@@ -16,8 +16,6 @@ The possible operators used for a discount condition.
|
||||
|
||||
The discountable resources are within the specified resources.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_IN
|
||||
|
||||
**NOT\_IN** = `"not_in"`
|
||||
|
||||
@@ -16,32 +16,24 @@ The discount condition's type.
|
||||
|
||||
The discount condition is used for customer groups.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCTS
|
||||
|
||||
**PRODUCTS** = `"products"`
|
||||
|
||||
The discount condition is used for products.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_COLLECTIONS
|
||||
|
||||
**PRODUCT\_COLLECTIONS** = `"product_collections"`
|
||||
|
||||
The discount condition is used for product collections.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_TAGS
|
||||
|
||||
**PRODUCT\_TAGS** = `"product_tags"`
|
||||
|
||||
The discount condition is used for product tags.
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_TYPES
|
||||
|
||||
**PRODUCT\_TYPES** = `"product_types"`
|
||||
|
||||
@@ -16,16 +16,12 @@ The possible types of discount rules.
|
||||
|
||||
Discounts that reduce the price by a fixed amount.
|
||||
|
||||
___
|
||||
|
||||
### FREE\_SHIPPING
|
||||
|
||||
**FREE\_SHIPPING** = `"free_shipping"`
|
||||
|
||||
Discounts that sets the shipping price to `0`.
|
||||
|
||||
___
|
||||
|
||||
### PERCENTAGE
|
||||
|
||||
**PERCENTAGE** = `"percentage"`
|
||||
|
||||
@@ -16,8 +16,6 @@ The draft order's status.
|
||||
|
||||
The draft order is completed, and an order has been created from it.
|
||||
|
||||
___
|
||||
|
||||
### OPEN
|
||||
|
||||
**OPEN** = `"open"`
|
||||
|
||||
@@ -16,64 +16,48 @@ The order's fulfillment status.
|
||||
|
||||
The order's fulfillments are canceled.
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
**FULFILLED** = `"fulfilled"`
|
||||
|
||||
The order's items are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
**NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
The order's items are not fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_FULFILLED
|
||||
|
||||
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
|
||||
|
||||
Some of the order's items, but not all, are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_RETURNED
|
||||
|
||||
**PARTIALLY\_RETURNED** = `"partially_returned"`
|
||||
|
||||
Some of the order's items, but not all, are returned.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
Some of the order's items, but not all, are shipped.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The order's fulfillment requires action.
|
||||
|
||||
___
|
||||
|
||||
### RETURNED
|
||||
|
||||
**RETURNED** = `"returned"`
|
||||
|
||||
The order's items are returned.
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
**SHIPPED** = `"shipped"`
|
||||
|
||||
@@ -16,16 +16,12 @@ The type of the order edit item change.
|
||||
|
||||
A new item to be added to the original order.
|
||||
|
||||
___
|
||||
|
||||
### ITEM\_REMOVE
|
||||
|
||||
**ITEM\_REMOVE** = `"item_remove"`
|
||||
|
||||
An existing item to be removed from the original order.
|
||||
|
||||
___
|
||||
|
||||
### ITEM\_UPDATE
|
||||
|
||||
**ITEM\_UPDATE** = `"item_update"`
|
||||
|
||||
@@ -16,32 +16,24 @@ The order edit's status.
|
||||
|
||||
The order edit is canceled.
|
||||
|
||||
___
|
||||
|
||||
### CONFIRMED
|
||||
|
||||
**CONFIRMED** = `"confirmed"`
|
||||
|
||||
The order edit is confirmed.
|
||||
|
||||
___
|
||||
|
||||
### CREATED
|
||||
|
||||
**CREATED** = `"created"`
|
||||
|
||||
The order edit is created.
|
||||
|
||||
___
|
||||
|
||||
### DECLINED
|
||||
|
||||
**DECLINED** = `"declined"`
|
||||
|
||||
The order edit is declined.
|
||||
|
||||
___
|
||||
|
||||
### REQUESTED
|
||||
|
||||
**REQUESTED** = `"requested"`
|
||||
|
||||
@@ -16,16 +16,12 @@ The order's status.
|
||||
|
||||
The order is archived.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The order is canceled.
|
||||
|
||||
___
|
||||
|
||||
### COMPLETED
|
||||
|
||||
**COMPLETED** = `"completed"`
|
||||
@@ -34,16 +30,12 @@ The order is completed, meaning that
|
||||
the items have been fulfilled and the payment
|
||||
has been captured.
|
||||
|
||||
___
|
||||
|
||||
### PENDING
|
||||
|
||||
**PENDING** = `"pending"`
|
||||
|
||||
The order is pending.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
@@ -16,32 +16,24 @@ The payment collection's status.
|
||||
|
||||
The payment colleciton is authorized.
|
||||
|
||||
___
|
||||
|
||||
### AWAITING
|
||||
|
||||
**AWAITING** = `"awaiting"`
|
||||
|
||||
The payment collection is awaiting payment.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The payment collection is canceled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
**NOT\_PAID** = `"not_paid"`
|
||||
|
||||
The payment collection isn't paid.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_AUTHORIZED
|
||||
|
||||
**PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
|
||||
|
||||
@@ -16,32 +16,24 @@ The status of a payment session.
|
||||
|
||||
The payment is authorized.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The payment is canceled.
|
||||
|
||||
___
|
||||
|
||||
### ERROR
|
||||
|
||||
**ERROR** = `"error"`
|
||||
|
||||
An error occurred while processing the payment.
|
||||
|
||||
___
|
||||
|
||||
### PENDING
|
||||
|
||||
**PENDING** = `"pending"`
|
||||
|
||||
The payment is pending.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_MORE
|
||||
|
||||
**REQUIRES\_MORE** = `"requires_more"`
|
||||
|
||||
@@ -16,48 +16,36 @@ The order's payment status.
|
||||
|
||||
The order's payment is awaiting capturing.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The order's payment is canceled.
|
||||
|
||||
___
|
||||
|
||||
### CAPTURED
|
||||
|
||||
**CAPTURED** = `"captured"`
|
||||
|
||||
The order's payment is captured.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
**NOT\_PAID** = `"not_paid"`
|
||||
|
||||
The order's payment is not paid.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_REFUNDED
|
||||
|
||||
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
||||
|
||||
Some of the order's payment amount is refunded.
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
**REFUNDED** = `"refunded"`
|
||||
|
||||
The order's payment amount is refunded.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
@@ -16,24 +16,18 @@ The status of a product.
|
||||
|
||||
The product is a draft. It's not viewable by customers.
|
||||
|
||||
___
|
||||
|
||||
### PROPOSED
|
||||
|
||||
**PROPOSED** = `"proposed"`
|
||||
|
||||
The product is proposed, but not yet published.
|
||||
|
||||
___
|
||||
|
||||
### PUBLISHED
|
||||
|
||||
**PUBLISHED** = `"published"`
|
||||
|
||||
The product is published.
|
||||
|
||||
___
|
||||
|
||||
### REJECTED
|
||||
|
||||
**REJECTED** = `"rejected"`
|
||||
|
||||
@@ -16,32 +16,24 @@ The reason of the refund.
|
||||
|
||||
The refund is applied because of a created claim.
|
||||
|
||||
___
|
||||
|
||||
### DISCOUNT
|
||||
|
||||
**DISCOUNT** = `"discount"`
|
||||
|
||||
The refund is applied as a discount.
|
||||
|
||||
___
|
||||
|
||||
### OTHER
|
||||
|
||||
**OTHER** = `"other"`
|
||||
|
||||
The refund is created for a custom reason.
|
||||
|
||||
___
|
||||
|
||||
### RETURN
|
||||
|
||||
**RETURN** = `"return"`
|
||||
|
||||
The refund is applied because of a created return.
|
||||
|
||||
___
|
||||
|
||||
### SWAP
|
||||
|
||||
**SWAP** = `"swap"`
|
||||
|
||||
@@ -16,8 +16,6 @@ The type of shipping option requirement.
|
||||
|
||||
The shipping option can only be applied if the subtotal is less than the requirement's amont.
|
||||
|
||||
___
|
||||
|
||||
### MIN\_SUBTOTAL
|
||||
|
||||
**MIN\_SUBTOTAL** = `"min_subtotal"`
|
||||
|
||||
@@ -16,24 +16,18 @@ The return's status.
|
||||
|
||||
The return is canceled.
|
||||
|
||||
___
|
||||
|
||||
### RECEIVED
|
||||
|
||||
**RECEIVED** = `"received"`
|
||||
|
||||
The return is received.
|
||||
|
||||
___
|
||||
|
||||
### REQUESTED
|
||||
|
||||
**REQUESTED** = `"requested"`
|
||||
|
||||
The return is requested.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
@@ -16,8 +16,6 @@ The type of the shipping option price.
|
||||
|
||||
The shipping option's price is calculated. In this case, the `amount` field is typically `null`.
|
||||
|
||||
___
|
||||
|
||||
### FLAT\_RATE
|
||||
|
||||
**FLAT\_RATE** = `"flat_rate"`
|
||||
|
||||
@@ -16,16 +16,12 @@ The shipping profile's type.
|
||||
|
||||
The profile used to ship custom items.
|
||||
|
||||
___
|
||||
|
||||
### DEFAULT
|
||||
|
||||
**DEFAULT** = `"default"`
|
||||
|
||||
The default profile used to ship item.
|
||||
|
||||
___
|
||||
|
||||
### GIFT\_CARD
|
||||
|
||||
**GIFT\_CARD** = `"gift_card"`
|
||||
|
||||
@@ -16,40 +16,30 @@ The swap's fulfillment status.
|
||||
|
||||
The swap's fulfillments are canceled.
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
**FULFILLED** = `"fulfilled"`
|
||||
|
||||
The swap's items are fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
**NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
The swap's items aren't fulfilled.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
Some of the swap's items are shipped.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
The swap's fulfillments require an action.
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
**SHIPPED** = `"shipped"`
|
||||
|
||||
@@ -16,64 +16,48 @@ The swap's payment status.
|
||||
|
||||
The swap is additional awaiting payment.
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
**CANCELED** = `"canceled"`
|
||||
|
||||
The swap's additional payment is canceled.
|
||||
|
||||
___
|
||||
|
||||
### CAPTURED
|
||||
|
||||
**CAPTURED** = `"captured"`
|
||||
|
||||
The swap's additional payment is captured.
|
||||
|
||||
___
|
||||
|
||||
### CONFIRMED
|
||||
|
||||
**CONFIRMED** = `"confirmed"`
|
||||
|
||||
The swap's additional payment is confirmed.
|
||||
|
||||
___
|
||||
|
||||
### DIFFERENCE\_REFUNDED
|
||||
|
||||
**DIFFERENCE\_REFUNDED** = `"difference_refunded"`
|
||||
|
||||
The negative difference amount between the returned item(s) and the new one(s) has been refuneded.
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
**NOT\_PAID** = `"not_paid"`
|
||||
|
||||
The swap's additional payment isn't paid.
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_REFUNDED
|
||||
|
||||
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
||||
|
||||
Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
**REFUNDED** = `"refunded"`
|
||||
|
||||
The amount in the associated order has been refunded.
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
**REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
@@ -16,16 +16,12 @@ The user's role. These roles don't change the user's capabilities or provide acc
|
||||
|
||||
The user is an admin.
|
||||
|
||||
___
|
||||
|
||||
### DEVELOPER
|
||||
|
||||
**DEVELOPER** = `"developer"`
|
||||
|
||||
The user is a developer.
|
||||
|
||||
___
|
||||
|
||||
### MEMBER
|
||||
|
||||
**MEMBER** = `"member"`
|
||||
|
||||
Reference in new issue
Block a user