bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
66 lines
1.1 KiB
Plaintext
66 lines
1.1 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
---
|
|
|
|
import TypeList from "@site/src/components/TypeList"
|
|
|
|
# FulfillmentStatus
|
|
|
|
The order's fulfillment status.
|
|
|
|
## Enumeration Members
|
|
|
|
### 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.
|
|
|
|
### FULFILLED
|
|
|
|
**FULFILLED** = `"fulfilled"`
|
|
|
|
The order's items are fulfilled.
|
|
|
|
### PARTIALLY\_SHIPPED
|
|
|
|
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
|
|
|
Some of the order's items, but not all, are shipped.
|
|
|
|
### SHIPPED
|
|
|
|
**SHIPPED** = `"shipped"`
|
|
|
|
The order's items are shipped.
|
|
|
|
### PARTIALLY\_RETURNED
|
|
|
|
**PARTIALLY\_RETURNED** = `"partially_returned"`
|
|
|
|
Some of the order's items, but not all, are returned.
|
|
|
|
### RETURNED
|
|
|
|
**RETURNED** = `"returned"`
|
|
|
|
The order's items are returned.
|
|
|
|
### CANCELED
|
|
|
|
**CANCELED** = `"canceled"`
|
|
|
|
The order's fulfillments are canceled.
|
|
|
|
### REQUIRES\_ACTION
|
|
|
|
**REQUIRES\_ACTION** = `"requires_action"`
|
|
|
|
The order's fulfillment requires action.
|