docs: prep for v2 documentation (#6710)
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.
This commit is contained in:
Shahed Nasser
GitHub
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminAuthResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminAuthResource
|
||||
|
||||
@@ -37,11 +37,11 @@ medusa.admin.auth.getSession()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getSession"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getSession"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminAuthRes>","optional":false,"defaultValue":"","description":"Resolves to the logged-in user's details.","expandable":false,"children":[{"name":"AdminAuthRes","type":"[AdminAuthRes](../../medusa/types/medusa.AdminAuthRes.mdx)","optional":false,"defaultValue":"","description":"The user's details.","expandable":false,"children":[{"name":"user","type":"Omit<[User](../../entities/classes/entities.User.mdx), \"password_hash\">","description":"User details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getSession"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminAuthRes>","optional":false,"defaultValue":"","description":"Resolves to the logged-in user's details.","expandable":false,"children":[{"name":"AdminAuthRes","type":"[AdminAuthRes](../../medusa/types/medusa.AdminAuthRes.mdx)","optional":false,"defaultValue":"","description":"The user's details.","expandable":false,"children":[{"name":"user","type":"Omit<[User](../../entities/classes/entities.User.mdx), \"password_hash\">","description":"User details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getSession"/>
|
||||
|
||||
### deleteSession
|
||||
|
||||
@@ -59,11 +59,11 @@ medusa.admin.auth.deleteSession()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="deleteSession"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="deleteSession"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<void>","optional":false,"defaultValue":"","description":"Resolves when user is logged out successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="deleteSession"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<void>","optional":false,"defaultValue":"","description":"Resolves when user is logged out successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="deleteSession"/>
|
||||
|
||||
### createSession
|
||||
|
||||
@@ -85,11 +85,11 @@ medusa.admin.AdminAuthResource.createSession({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostAuthReq](../../medusa/classes/medusa.AdminPostAuthReq.mdx)","description":"The credentials of the user.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The user's password.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSession"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostAuthReq](../../medusa/classes/medusa.AdminPostAuthReq.mdx)","description":"The credentials of the user.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The user's password.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSession"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminAuthRes>","optional":false,"defaultValue":"","description":"Resolves to the user's details.","expandable":false,"children":[{"name":"AdminAuthRes","type":"[AdminAuthRes](../../medusa/types/medusa.AdminAuthRes.mdx)","optional":false,"defaultValue":"","description":"The user's details.","expandable":false,"children":[{"name":"user","type":"Omit<[User](../../entities/classes/entities.User.mdx), \"password_hash\">","description":"User details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSession"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminAuthRes>","optional":false,"defaultValue":"","description":"Resolves to the user's details.","expandable":false,"children":[{"name":"AdminAuthRes","type":"[AdminAuthRes](../../medusa/types/medusa.AdminAuthRes.mdx)","optional":false,"defaultValue":"","description":"The user's details.","expandable":false,"children":[{"name":"user","type":"Omit<[User](../../entities/classes/entities.User.mdx), \"password_hash\">","description":"User details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSession"/>
|
||||
|
||||
### getToken
|
||||
|
||||
@@ -111,8 +111,8 @@ medusa.admin.auth.getToken({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostAuthReq](../../medusa/classes/medusa.AdminPostAuthReq.mdx)","description":"The credentials of the user.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The user's password.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getToken"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostAuthReq](../../medusa/classes/medusa.AdminPostAuthReq.mdx)","description":"The credentials of the user.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The user's password.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getToken"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminBearerAuthRes>","optional":false,"defaultValue":"","description":"Resolves to the access token of the user, if they're authenticated successfully.","expandable":false,"children":[{"name":"AdminBearerAuthRes","type":"[AdminBearerAuthRes](../../medusa/types/medusa.AdminBearerAuthRes.mdx)","optional":false,"defaultValue":"","description":"The access token of the user, if they're authenticated successfully.","expandable":false,"children":[{"name":"access_token","type":"`string`","description":"Access token that can be used to send authenticated requests.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getToken"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminBearerAuthRes>","optional":false,"defaultValue":"","description":"Resolves to the access token of the user, if they're authenticated successfully.","expandable":false,"children":[{"name":"AdminBearerAuthRes","type":"[AdminBearerAuthRes](../../medusa/types/medusa.AdminBearerAuthRes.mdx)","optional":false,"defaultValue":"","description":"The access token of the user, if they're authenticated successfully.","expandable":false,"children":[{"name":"access_token","type":"`string`","description":"Access token that can be used to send authenticated requests.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getToken"/>
|
||||
|
||||
+11
-11
File diff suppressed because one or more lines are too long
+15
-15
File diff suppressed because one or more lines are too long
+5
-5
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminCurrenciesResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminCurrenciesResource
|
||||
|
||||
@@ -54,11 +54,11 @@ medusa.admin.currencies.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCurrenciesParams](../../medusa/classes/medusa.AdminGetCurrenciesParams.mdx)","description":"Filters and pagination configurations to apply on retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"Code to filter currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for currencies.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Filter currencies by whether they include tax.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.\nBy default, the returned currencies will be sorted by their `created_at` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCurrenciesParams](../../medusa/classes/medusa.AdminGetCurrenciesParams.mdx)","description":"Filters and pagination configurations to apply on retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"Code to filter currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search parameter for currencies.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Filter currencies by whether they include tax.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.\nBy default, the returned currencies will be sorted by their `created_at` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminCurrenciesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of currencies with pagination fields.","expandable":false,"children":[{"name":"AdminCurrenciesListRes","type":"[AdminCurrenciesListRes](../../medusa/types/medusa.AdminCurrenciesListRes.mdx)","optional":false,"defaultValue":"","description":"List of currencies with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currencies","type":"[Currency](../../entities/classes/entities.Currency.mdx)[]","description":"An array of currency details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminCurrenciesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of currencies with pagination fields.","expandable":false,"children":[{"name":"AdminCurrenciesListRes","type":"[AdminCurrenciesListRes](../../medusa/types/medusa.AdminCurrenciesListRes.mdx)","optional":false,"defaultValue":"","description":"List of currencies with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currencies","type":"[Currency](../../entities/classes/entities.Currency.mdx)[]","description":"An array of currency details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
### update
|
||||
|
||||
@@ -80,8 +80,8 @@ medusa.admin.currencies.update(code, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostCurrenciesCurrencyReq](../../medusa/classes/medusa.AdminPostCurrenciesCurrencyReq.mdx)","description":"The attributes to update in the currency.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"includes_tax","type":"`boolean`","description":"Tax included in prices of currency.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"code","type":"`string`","description":"The code of the currency to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostCurrenciesCurrencyReq](../../medusa/classes/medusa.AdminPostCurrenciesCurrencyReq.mdx)","description":"The attributes to update in the currency.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"includes_tax","type":"`boolean`","description":"Tax included in prices of currency.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminCurrenciesRes>","optional":false,"defaultValue":"","description":"Resolves to the currency's details.","expandable":false,"children":[{"name":"AdminCurrenciesRes","type":"[AdminCurrenciesRes](../../medusa/types/medusa.AdminCurrenciesRes.mdx)","optional":false,"defaultValue":"","description":"A currency's details.","expandable":false,"children":[{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"Currency details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminCurrenciesRes>","optional":false,"defaultValue":"","description":"Resolves to the currency's details.","expandable":false,"children":[{"name":"AdminCurrenciesRes","type":"[AdminCurrenciesRes](../../medusa/types/medusa.AdminCurrenciesRes.mdx)","optional":false,"defaultValue":"","description":"A currency's details.","expandable":false,"children":[{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"Currency details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
+10
-10
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminCustomResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminCustomResource
|
||||
|
||||
@@ -36,15 +36,15 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TQuery","type":"`Record<string, any>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="get"/>
|
||||
<TypeList types={[{"name":"TQuery","type":"`Record<string, any>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="get"/>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"path","type":"`string`","description":"The path of the custom API Route.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"TQuery","description":"Query path parameters to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`RequestOptions`","description":"Configurations to apply on the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="get"/>
|
||||
<TypeList types={[{"name":"path","type":"`string`","description":"The path of the custom API Route.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"TQuery","description":"Query path parameters to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`RequestOptions`","description":"Configurations to apply on the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="get"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<TResponse>","optional":false,"defaultValue":"","description":"The response data.","expandable":false,"children":[{"name":"TResponse","type":"TResponse","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="get"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<TResponse>","optional":false,"defaultValue":"","description":"The response data.","expandable":false,"children":[{"name":"TResponse","type":"TResponse","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="get"/>
|
||||
|
||||
### post
|
||||
|
||||
@@ -76,15 +76,15 @@ medusa.admin.custom.post<PostRequest, PostResponse>(
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TPayload","type":"`Record<string, any>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="post"/>
|
||||
<TypeList types={[{"name":"TPayload","type":"`Record<string, any>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="post"/>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"path","type":"`string`","description":"The path of the custom API Route.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"TPayload","description":"Body parameters to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`RequestOptions`","description":"Configurations to apply on the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="post"/>
|
||||
<TypeList types={[{"name":"path","type":"`string`","description":"The path of the custom API Route.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"TPayload","description":"Body parameters to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`RequestOptions`","description":"Configurations to apply on the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="post"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<TResponse>","optional":false,"defaultValue":"","description":"The response data.","expandable":false,"children":[{"name":"TResponse","type":"TResponse","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="post"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<TResponse>","optional":false,"defaultValue":"","description":"The response data.","expandable":false,"children":[{"name":"TResponse","type":"TResponse","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="post"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -106,12 +106,12 @@ medusa.admin.custom.delete(
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"TResponse","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"path","type":"`string`","description":"The path of the custom API Route.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`RequestOptions`","description":"Configurations to apply on the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"path","type":"`string`","description":"The path of the custom API Route.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`RequestOptions`","description":"Configurations to apply on the request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<TResponse>","optional":false,"defaultValue":"","description":"The response data.","expandable":false,"children":[{"name":"TResponse","type":"TResponse","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<TResponse>","optional":false,"defaultValue":"","description":"The response data.","expandable":false,"children":[{"name":"TResponse","type":"TResponse","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
+17
-17
File diff suppressed because one or more lines are too long
+9
-9
File diff suppressed because one or more lines are too long
+33
-33
File diff suppressed because one or more lines are too long
+19
-19
File diff suppressed because one or more lines are too long
+11
-11
File diff suppressed because one or more lines are too long
+19
-19
File diff suppressed because one or more lines are too long
+11
-11
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminInvitesResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminInvitesResource
|
||||
|
||||
@@ -47,11 +47,11 @@ medusa.admin.invites.accept({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostInvitesInviteAcceptReq](../../medusa/classes/medusa.AdminPostInvitesInviteAcceptReq.mdx)","description":"The user accepting the invite.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"token","type":"`string`","description":"The token of the invite to accept. This is a unique token generated when the invite was created or resent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"[AdminPostInvitesInviteAcceptUserReq](../../medusa/classes/medusa.AdminPostInvitesInviteAcceptUserReq.mdx)","description":"The details of the user to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The invite's first name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The invite's last name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The invite's password","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="accept"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostInvitesInviteAcceptReq](../../medusa/classes/medusa.AdminPostInvitesInviteAcceptReq.mdx)","description":"The user accepting the invite.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"token","type":"`string`","description":"The token of the invite to accept. This is a unique token generated when the invite was created or resent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"[AdminPostInvitesInviteAcceptUserReq](../../medusa/classes/medusa.AdminPostInvitesInviteAcceptUserReq.mdx)","description":"The details of the user to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"first_name","type":"`string`","description":"The invite's first name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The invite's last name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The invite's password","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="accept"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"`ResponsePromise`","optional":false,"defaultValue":"","description":"Resolves when the invite is accepted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="accept"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"`ResponsePromise`","optional":false,"defaultValue":"","description":"Resolves when the invite is accepted successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="accept"/>
|
||||
|
||||
### create
|
||||
|
||||
@@ -78,11 +78,11 @@ medusa.admin.invites.create({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"`AdminPostInvitesPayload`","description":"The invite to be created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"payload","type":"`AdminPostInvitesPayload`","description":"The invite to be created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"`ResponsePromise`","optional":false,"defaultValue":"","description":"Resolves when the invite is created successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"`ResponsePromise`","optional":false,"defaultValue":"","description":"Resolves when the invite is created successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -102,11 +102,11 @@ medusa.admin.invites.delete(inviteId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The invite's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The invite's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -126,11 +126,11 @@ medusa.admin.invites.list()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminListInvitesRes>","optional":false,"defaultValue":"","description":"Resolves to the list of invites.","expandable":false,"children":[{"name":"AdminListInvitesRes","type":"[AdminListInvitesRes](../../medusa/types/medusa.AdminListInvitesRes.mdx)","optional":false,"defaultValue":"","description":"The list of invites.","expandable":false,"children":[{"name":"invites","type":"[Invite](../../entities/classes/entities.Invite.mdx)[]","description":"An array of invites","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The invite's ID","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":"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":"user_email","type":"`string`","description":"The email of the user being invited.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't change the privileges of the user.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"accepted","type":"`boolean`","description":"Whether the invite was accepted or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token used to accept the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"The date the invite expires at.","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminListInvitesRes>","optional":false,"defaultValue":"","description":"Resolves to the list of invites.","expandable":false,"children":[{"name":"AdminListInvitesRes","type":"[AdminListInvitesRes](../../medusa/types/medusa.AdminListInvitesRes.mdx)","optional":false,"defaultValue":"","description":"The list of invites.","expandable":false,"children":[{"name":"invites","type":"[Invite](../../entities/classes/entities.Invite.mdx)[]","description":"An array of invites","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The invite's ID","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":"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":"user_email","type":"`string`","description":"The email of the user being invited.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't change the privileges of the user.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"accepted","type":"`boolean`","description":"Whether the invite was accepted or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token used to accept the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"The date the invite expires at.","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
### resend
|
||||
|
||||
@@ -155,8 +155,8 @@ medusa.admin.invites.resend(inviteId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The invite's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="resend"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The invite's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="resend"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"`ResponsePromise`","optional":false,"defaultValue":"","description":"Resolves when the invite is resent successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="resend"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"`ResponsePromise`","optional":false,"defaultValue":"","description":"Resolves when the invite is resent successfully.","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="resend"/>
|
||||
|
||||
+11
-11
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminNotesResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminNotesResource
|
||||
|
||||
@@ -38,11 +38,11 @@ medusa.admin.notes.create({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostNotesReq](../../medusa/classes/medusa.AdminPostNotesReq.mdx)","description":"The note to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resource_id","type":"`string`","description":"The ID of the resource which the Note relates to. For example, an order ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource which the Note relates to. For example, `order`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The content of the Note to create.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostNotesReq](../../medusa/classes/medusa.AdminPostNotesReq.mdx)","description":"The note to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resource_id","type":"`string`","description":"The ID of the resource which the Note relates to. For example, an order ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource which the Note relates to. For example, `order`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The content of the Note to create.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesRes>","optional":false,"defaultValue":"","description":"Resolves to the note's details.","expandable":false,"children":[{"name":"AdminNotesRes","type":"[AdminNotesRes](../../medusa/types/medusa.AdminNotesRes.mdx)","optional":false,"defaultValue":"","description":"The note's details.","expandable":false,"children":[{"name":"note","type":"[Note](../../entities/classes/entities.Note.mdx)","description":"Note details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesRes>","optional":false,"defaultValue":"","description":"Resolves to the note's details.","expandable":false,"children":[{"name":"AdminNotesRes","type":"[AdminNotesRes](../../medusa/types/medusa.AdminNotesRes.mdx)","optional":false,"defaultValue":"","description":"The note's details.","expandable":false,"children":[{"name":"note","type":"[Note](../../entities/classes/entities.Note.mdx)","description":"Note details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
### update
|
||||
|
||||
@@ -64,11 +64,11 @@ medusa.admin.notes.update(noteId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The note's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostNotesNoteReq](../../medusa/classes/medusa.AdminPostNotesNoteReq.mdx)","description":"The attributes to update in the note.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The description of the Note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The note's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostNotesNoteReq](../../medusa/classes/medusa.AdminPostNotesNoteReq.mdx)","description":"The attributes to update in the note.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"The description of the Note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesRes>","optional":false,"defaultValue":"","description":"Resolves to the note's details.","expandable":false,"children":[{"name":"AdminNotesRes","type":"[AdminNotesRes](../../medusa/types/medusa.AdminNotesRes.mdx)","optional":false,"defaultValue":"","description":"The note's details.","expandable":false,"children":[{"name":"note","type":"[Note](../../entities/classes/entities.Note.mdx)","description":"Note details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesRes>","optional":false,"defaultValue":"","description":"Resolves to the note's details.","expandable":false,"children":[{"name":"AdminNotesRes","type":"[AdminNotesRes](../../medusa/types/medusa.AdminNotesRes.mdx)","optional":false,"defaultValue":"","description":"The note's details.","expandable":false,"children":[{"name":"note","type":"[Note](../../entities/classes/entities.Note.mdx)","description":"Note details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -88,11 +88,11 @@ medusa.admin.notes.delete(noteId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The note's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The note's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
### retrieve
|
||||
|
||||
@@ -112,11 +112,11 @@ medusa.admin.notes.retrieve(noteId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The note's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The note's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesRes>","optional":false,"defaultValue":"","description":"Resolves to the note's details.","expandable":false,"children":[{"name":"AdminNotesRes","type":"[AdminNotesRes](../../medusa/types/medusa.AdminNotesRes.mdx)","optional":false,"defaultValue":"","description":"The note's details.","expandable":false,"children":[{"name":"note","type":"[Note](../../entities/classes/entities.Note.mdx)","description":"Note details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesRes>","optional":false,"defaultValue":"","description":"Resolves to the note's details.","expandable":false,"children":[{"name":"AdminNotesRes","type":"[AdminNotesRes](../../medusa/types/medusa.AdminNotesRes.mdx)","optional":false,"defaultValue":"","description":"The note's details.","expandable":false,"children":[{"name":"note","type":"[Note](../../entities/classes/entities.Note.mdx)","description":"Note details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -153,8 +153,8 @@ medusa.admin.notes.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetNotesParams](../../medusa/classes/medusa.AdminGetNotesParams.mdx)","description":"Filters and pagination configurations applied on retrieved notes.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"Resource ID to filter notes by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetNotesParams](../../medusa/classes/medusa.AdminGetNotesParams.mdx)","description":"Filters and pagination configurations applied on retrieved notes.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"Resource ID to filter notes by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of notes with pagination fields.","expandable":false,"children":[{"name":"AdminNotesListRes","type":"[AdminNotesListRes](../../medusa/types/medusa.AdminNotesListRes.mdx)","optional":false,"defaultValue":"","description":"The list of notes with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notes","type":"[Note](../../entities/classes/entities.Note.mdx)[]","description":"An array of notes","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminNotesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of notes with pagination fields.","expandable":false,"children":[{"name":"AdminNotesListRes","type":"[AdminNotesListRes](../../medusa/types/medusa.AdminNotesListRes.mdx)","optional":false,"defaultValue":"","description":"The list of notes with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notes","type":"[Note](../../entities/classes/entities.Note.mdx)[]","description":"An array of notes","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The note's ID","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":"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":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","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":"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":"role","type":"[UserRoles](../../entities/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":"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":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with 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":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+5
-5
File diff suppressed because one or more lines are too long
+25
-25
File diff suppressed because one or more lines are too long
+51
-51
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminOrdersResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminOrdersResource
|
||||
|
||||
@@ -39,11 +39,11 @@ medusa.admin.orders.update(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderReq](../../medusa/classes/medusa.AdminPostOrdersOrderReq.mdx)","description":"The attributes to update in the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The email associated with the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The order's billing address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The order's shipping address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"`Record<string, unknown>`[]","description":"The line items of the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"`string`","description":"ID of the region that the order is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"`Record<string, unknown>`[]","description":"The discounts applied to the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_method","type":"[PaymentMethod](../../medusa/classes/medusa.PaymentMethod.mdx)","description":"The payment method chosen for the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-3.mdx)[]","description":"The Shipping Method used for shipping the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderReq](../../medusa/classes/medusa.AdminPostOrdersOrderReq.mdx)","description":"The attributes to update in the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The email associated with the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The order's billing address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The order's shipping address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"`Record<string, unknown>`[]","description":"The line items of the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"`string`","description":"ID of the region that the order is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"`Record<string, unknown>`[]","description":"The discounts applied to the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_method","type":"[PaymentMethod](../../medusa/classes/medusa.PaymentMethod.mdx)","description":"The payment method chosen for the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-3.mdx)[]","description":"The Shipping Method used for shipping the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
### retrieve
|
||||
|
||||
@@ -79,11 +79,11 @@ medusa.admin.orders.retrieve(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[FindParams](../../medusa/classes/medusa.FindParams.mdx)","description":"Configurations to apply on the retrieved order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[FindParams](../../medusa/classes/medusa.FindParams.mdx)","description":"Configurations to apply on the retrieved order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -135,11 +135,11 @@ medusa.admin.orders.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetOrdersParams](../../medusa/classes/medusa.AdminGetOrdersParams.mdx)","description":"Filters and pagination configurations applied on the retrieved orders.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search orders' shipping address, first name, email, and display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`[]","description":"Statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"`string`[]","description":"Fulfillment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"`string`[]","description":"Payment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`string`","description":"Display ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"Cart ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"Customer ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"Email to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[]","description":"Regions to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"Currency code to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`string`","description":"Tax rate to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`[]","description":"Sales channel IDs to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetOrdersParams](../../medusa/classes/medusa.AdminGetOrdersParams.mdx)","description":"Filters and pagination configurations applied on the retrieved orders.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search orders' shipping address, first name, email, and display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`[]","description":"Statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"`string`[]","description":"Fulfillment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"`string`[]","description":"Payment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`string`","description":"Display ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"Cart ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"Customer ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"Email to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[]","description":"Regions to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"Currency code to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`string`","description":"Tax rate to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`[]","description":"Sales channel IDs to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of orders with pagination fields.","expandable":false,"children":[{"name":"AdminOrdersListRes","type":"[PaginatedResponse](../../medusa/interfaces/medusa.PaginatedResponse.mdx) & `object`","description":"The list of orders with pagination fields.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of orders with pagination fields.","expandable":false,"children":[{"name":"AdminOrdersListRes","type":"[PaginatedResponse](../../medusa/interfaces/medusa.PaginatedResponse.mdx) & `object`","description":"The list of orders with pagination fields.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
### complete
|
||||
|
||||
@@ -159,11 +159,11 @@ medusa.admin.orders.complete(orderId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="complete"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="complete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="complete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="complete"/>
|
||||
|
||||
### capturePayment
|
||||
|
||||
@@ -183,11 +183,11 @@ medusa.admin.orders.capturePayment(orderId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order whose payments should be captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="capturePayment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order whose payments should be captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="capturePayment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="capturePayment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="capturePayment"/>
|
||||
|
||||
### refundPayment
|
||||
|
||||
@@ -210,11 +210,11 @@ medusa.admin.orders.refundPayment(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order whose customer should be refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderRefundsReq](../../medusa/classes/medusa.AdminPostOrdersOrderRefundsReq.mdx)","description":"The refund's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"`number`","description":"The amount to refund. It should be less than or equal the `refundable\\_amount` of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"The reason for the Refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"A note with additional details about the Refund.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Refund.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="refundPayment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order whose customer should be refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderRefundsReq](../../medusa/classes/medusa.AdminPostOrdersOrderRefundsReq.mdx)","description":"The refund's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"`number`","description":"The amount to refund. It should be less than or equal the `refundable\\_amount` of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"The reason for the Refund.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"A note with additional details about the Refund.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Refund.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="refundPayment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="refundPayment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="refundPayment"/>
|
||||
|
||||
### createFulfillment
|
||||
|
||||
@@ -242,11 +242,11 @@ medusa.admin.orders.createFulfillment(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsReq.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[Item](../../medusa/classes/medusa.Item-2.mdx)[]","description":"The Line Items to include in the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location where the items will be fulfilled from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createFulfillment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderFulfillmentsReq.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[Item](../../medusa/classes/medusa.Item-2.mdx)[]","description":"The Line Items to include in the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location where the items will be fulfilled from.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createFulfillment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createFulfillment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createFulfillment"/>
|
||||
|
||||
### cancelFulfillment
|
||||
|
||||
@@ -266,11 +266,11 @@ medusa.admin.orders.cancelFulfillment(orderId, fulfillmentId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"The fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelFulfillment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"The fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelFulfillment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelFulfillment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelFulfillment"/>
|
||||
|
||||
### cancelSwapFulfillment
|
||||
|
||||
@@ -290,11 +290,11 @@ medusa.admin.orders.cancelSwapFulfillment(orderId, swapId, fulfillmentId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the swap is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The ID of the swap the fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"The fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwapFulfillment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the swap is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The ID of the swap the fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"The fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwapFulfillment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwapFulfillment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwapFulfillment"/>
|
||||
|
||||
### cancelClaimFulfillment
|
||||
|
||||
@@ -314,11 +314,11 @@ medusa.admin.orders.cancelClaimFulfillment(orderId, claimId, fulfillmentId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the claim is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"The fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaimFulfillment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the claim is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentId","type":"`string`","description":"The fulfillment's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaimFulfillment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaimFulfillment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaimFulfillment"/>
|
||||
|
||||
### createShipment
|
||||
|
||||
@@ -341,11 +341,11 @@ medusa.admin.orders.createShipment(order_id, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderShipmentReq](../../medusa/classes/medusa.AdminPostOrdersOrderShipmentReq.mdx)","description":"The shipment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers for the shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createShipment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderShipmentReq](../../medusa/classes/medusa.AdminPostOrdersOrderShipmentReq.mdx)","description":"The shipment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers for the shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createShipment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createShipment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createShipment"/>
|
||||
|
||||
### requestReturn
|
||||
|
||||
@@ -372,11 +372,11 @@ medusa.admin.orders.requestReturn(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderReturnsReq](../../medusa/classes/medusa.AdminPostOrdersOrderReturnsReq.mdx)","description":"The return to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem.mdx)[]","description":"The line items that will be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping-2.mdx)","description":"The Shipping Method to be used to handle the return shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note with information about the Return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receive_now","type":"`boolean`","description":"A flag to indicate if the Return should be registerd as received immediately.","optional":true,"defaultValue":"false","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund","type":"`number`","description":"The amount to refund.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location used for the return.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="requestReturn"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderReturnsReq](../../medusa/classes/medusa.AdminPostOrdersOrderReturnsReq.mdx)","description":"The return to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"items","type":"[OrdersReturnItem](../../medusa/classes/medusa.OrdersReturnItem.mdx)[]","description":"The line items that will be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping-2.mdx)","description":"The Shipping Method to be used to handle the return shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note with information about the Return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"receive_now","type":"`boolean`","description":"A flag to indicate if the Return should be registerd as received immediately.","optional":true,"defaultValue":"false","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund","type":"`number`","description":"The amount to refund.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location used for the return.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="requestReturn"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the return under the `returns` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="requestReturn"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the return under the `returns` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="requestReturn"/>
|
||||
|
||||
### cancel
|
||||
|
||||
@@ -397,11 +397,11 @@ medusa.admin.orders.cancel(orderId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancel"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancel"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancel"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancel"/>
|
||||
|
||||
### addShippingMethod
|
||||
|
||||
@@ -424,11 +424,11 @@ medusa.admin.orders.addShippingMethod(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderShippingMethodsReq](../../medusa/classes/medusa.AdminPostOrdersOrderShippingMethodsReq.mdx)","description":"The shipping method to be added.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"price","type":"`number`","description":"The price (excluding VAT) that should be charged for the Shipping Method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string`","description":"The ID of the Shipping Option to create the Shipping Method from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="addShippingMethod"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderShippingMethodsReq](../../medusa/classes/medusa.AdminPostOrdersOrderShippingMethodsReq.mdx)","description":"The shipping method to be added.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"price","type":"`number`","description":"The price (excluding VAT) that should be charged for the Shipping Method","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string`","description":"The ID of the Shipping Option to create the Shipping Method from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="addShippingMethod"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="addShippingMethod"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="addShippingMethod"/>
|
||||
|
||||
### archive
|
||||
|
||||
@@ -448,11 +448,11 @@ medusa.admin.orders.archive(orderId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="archive"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="archive"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="archive"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="archive"/>
|
||||
|
||||
### createSwap
|
||||
|
||||
@@ -479,11 +479,11 @@ medusa.admin.orders.createSwap(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderSwapsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsReq.mdx)","description":"The swap to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"return_items","type":"[ReturnItem](../../medusa/classes/medusa.ReturnItem.mdx)[]","description":"The Line Items to associate with the swap's return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping-1.mdx)","description":"The shipping method associated with the swap's return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel associated with the swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[AdditionalItem](../../medusa/classes/medusa.AdditionalItem-1.mdx)[]","description":"The new items to send to the Customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_shipping_options","type":"[CustomShippingOption](../../medusa/classes/medusa.CustomShippingOption.mdx)[]","description":"An array of custom shipping options to potentially create a Shipping Method from to send the additional items.","optional":true,"defaultValue":"[]","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_location_id","type":"`string`","description":"The ID of the location used for the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If set to `true`, swaps can be completed with items out of stock","optional":true,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwap"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderSwapsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsReq.mdx)","description":"The swap to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"return_items","type":"[ReturnItem](../../medusa/classes/medusa.ReturnItem.mdx)[]","description":"The Line Items to associate with the swap's return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping-1.mdx)","description":"The shipping method associated with the swap's return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the sales channel associated with the swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[AdditionalItem](../../medusa/classes/medusa.AdditionalItem-1.mdx)[]","description":"The new items to send to the Customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"custom_shipping_options","type":"[CustomShippingOption](../../medusa/classes/medusa.CustomShippingOption.mdx)[]","description":"An array of custom shipping options to potentially create a Shipping Method from to send the additional items.","optional":true,"defaultValue":"[]","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_location_id","type":"`string`","description":"The ID of the location used for the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If set to `true`, swaps can be completed with items out of stock","optional":true,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwap"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwap"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwap"/>
|
||||
|
||||
### cancelSwap
|
||||
|
||||
@@ -503,11 +503,11 @@ medusa.admin.orders.cancelSwap(orderId, swapId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwap"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwap"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwap"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelSwap"/>
|
||||
|
||||
### fulfillSwap
|
||||
|
||||
@@ -530,11 +530,11 @@ medusa.admin.orders.fulfillSwap(orderId, swapId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the fulfillment's location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillSwap"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the fulfillment's location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillSwap"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillSwap"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillSwap"/>
|
||||
|
||||
### createSwapShipment
|
||||
|
||||
@@ -557,11 +557,11 @@ medusa.admin.orders.createSwapShipment(orderId, swapId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderSwapsSwapShipmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx)","description":"The shipment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers for the shipment.","optional":true,"defaultValue":"[]","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be sent related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwapShipment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderSwapsSwapShipmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderSwapsSwapShipmentsReq.mdx)","description":"The shipment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers for the shipment.","optional":true,"defaultValue":"[]","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be sent related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwapShipment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwapShipment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createSwapShipment"/>
|
||||
|
||||
### processSwapPayment
|
||||
|
||||
@@ -582,11 +582,11 @@ medusa.admin.orders.processSwapPayment(orderId, swapId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="processSwapPayment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swapId","type":"`string`","description":"The swap's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="processSwapPayment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="processSwapPayment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `swaps` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="processSwapPayment"/>
|
||||
|
||||
### createClaim
|
||||
|
||||
@@ -615,11 +615,11 @@ medusa.admin.orders.createClaim(orderId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsReq.mdx)","description":"The claim to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"replace\"` \\| `\"refund\"`","description":"The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[Item](../../medusa/classes/medusa.Item-1.mdx)[]","description":"The Claim Items that the Claim will consist of.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping.mdx)","description":"Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[AdditionalItem](../../medusa/classes/medusa.AdditionalItem.mdx)[]","description":"The new items to send to the Customer. This is only used if the claim's type is `replace`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-1.mdx)[]","description":"The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount to refund the customer. This is used when the claim's type is `refund`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_location_id","type":"`string`","description":"The ID of the location used for the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaim"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsReq.mdx)","description":"The claim to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"replace\"` \\| `\"refund\"`","description":"The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[Item](../../medusa/classes/medusa.Item-1.mdx)[]","description":"The Claim Items that the Claim will consist of.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping.mdx)","description":"Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"[AdditionalItem](../../medusa/classes/medusa.AdditionalItem.mdx)[]","description":"The new items to send to the Customer. This is only used if the claim's type is `replace`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-1.mdx)[]","description":"The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount to refund the customer. This is used when the claim's type is `refund`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_location_id","type":"`string`","description":"The ID of the location used for the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaim"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the claim under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaim"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the claim under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaim"/>
|
||||
|
||||
### cancelClaim
|
||||
|
||||
@@ -639,11 +639,11 @@ medusa.admin.orders.cancelClaim(orderId, claimId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaim"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaim"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaim"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="cancelClaim"/>
|
||||
|
||||
### updateClaim
|
||||
|
||||
@@ -665,11 +665,11 @@ medusa.admin.orders.updateClaim(orderId, claimId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsClaimReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimReq.mdx)","description":"The attributes to update in the claim.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"claim_items","type":"[Item](../../medusa/classes/medusa.Item-3.mdx)[]","description":"The Claim Items that the Claim will consist of.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-2.mdx)[]","description":"The Shipping Methods to send the additional Line Items with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="updateClaim"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsClaimReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimReq.mdx)","description":"The attributes to update in the claim.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"claim_items","type":"[Item](../../medusa/classes/medusa.Item-3.mdx)[]","description":"The Claim Items that the Claim will consist of.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-2.mdx)[]","description":"The Shipping Methods to send the additional Line Items with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="updateClaim"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the claims under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="updateClaim"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the claims under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="updateClaim"/>
|
||||
|
||||
### fulfillClaim
|
||||
|
||||
@@ -691,11 +691,11 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the fulfillment's location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillClaim"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.mdx)","description":"The fulfillment to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the fulfillment's location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillClaim"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillClaim"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="fulfillClaim"/>
|
||||
|
||||
### createClaimShipment
|
||||
|
||||
@@ -718,8 +718,8 @@ medusa.admin.orders.createClaimShipment(orderId, claimId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsClaimShipmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx)","description":"The shipment to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"An array of tracking numbers for the shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaimShipment"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order that the claim belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claimId","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostOrdersOrderClaimsClaimShipmentsReq](../../medusa/classes/medusa.AdminPostOrdersOrderClaimsClaimShipmentsReq.mdx)","description":"The shipment to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"An array of tracking numbers for the shipment.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaimShipment"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaimShipment"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminOrdersRes>","optional":false,"defaultValue":"","description":"Resolves to the order's details. You can access the swap under the `claims` property.","expandable":false,"children":[{"name":"AdminOrdersRes","type":"`object`","description":"The order's details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createClaimShipment"/>
|
||||
|
||||
+9
-9
File diff suppressed because one or more lines are too long
+7
-7
File diff suppressed because one or more lines are too long
+23
-23
File diff suppressed because one or more lines are too long
+15
-15
File diff suppressed because one or more lines are too long
+3
-3
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminProductTagsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminProductTagsResource
|
||||
|
||||
@@ -52,8 +52,8 @@ medusa.admin.productTags.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"query","type":"[AdminGetProductTagsParams](../../medusa/classes/medusa.AdminGetProductTagsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product tags.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product tags' value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to search product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product tags' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product tags' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product tags by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"query","type":"[AdminGetProductTagsParams](../../medusa/classes/medusa.AdminGetProductTagsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product tags.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product tags' value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to search product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product tags' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product tags' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product tags by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminProductTagsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product tags with pagination fields.","expandable":false,"children":[{"name":"AdminProductTagsListRes","type":"[AdminProductTagsListRes](../../medusa/types/medusa.AdminProductTagsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of product tags with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"An array of product tag details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product tag's ID","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":"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":"value","type":"`string`","description":"The value that the Product Tag represents","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminProductTagsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product tags with pagination fields.","expandable":false,"children":[{"name":"AdminProductTagsListRes","type":"[AdminProductTagsListRes](../../medusa/types/medusa.AdminProductTagsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of product tags with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"An array of product tag details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product tag's ID","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":"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":"value","type":"`string`","description":"The value that the Product Tag represents","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+3
-3
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminProductTypesResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminProductTypesResource
|
||||
|
||||
@@ -53,8 +53,8 @@ medusa.admin.productTypes.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetProductTypesParams](../../medusa/classes/medusa.AdminGetProductTypesParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search product types' value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product types by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetProductTypesParams](../../medusa/classes/medusa.AdminGetProductTypesParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search product types' value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product types by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminProductTypesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product types with pagination fields.","expandable":false,"children":[{"name":"AdminProductTypesListRes","type":"[AdminProductTypesListRes](../../medusa/types/medusa.AdminProductTypesListRes.mdx)","optional":false,"defaultValue":"","description":"The list of product types with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)[]","description":"An array of product types details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product type's ID","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":"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":"value","type":"`string`","description":"The value that the Product Type represents.","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminProductTypesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product types with pagination fields.","expandable":false,"children":[{"name":"AdminProductTypesListRes","type":"[AdminProductTypesListRes](../../medusa/types/medusa.AdminProductTypesListRes.mdx)","optional":false,"defaultValue":"","description":"The list of product types with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)[]","description":"An array of product types details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product type's ID","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":"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":"value","type":"`string`","description":"The value that the Product Type represents.","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+27
-27
File diff suppressed because one or more lines are too long
+19
-19
File diff suppressed because one or more lines are too long
+25
-25
File diff suppressed because one or more lines are too long
+11
-11
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminReservationsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminReservationsResource
|
||||
|
||||
@@ -38,11 +38,11 @@ medusa.admin.reservations.retrieve(reservationId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The reservation's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The reservation's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsRes>","optional":false,"defaultValue":"","description":"Resolves to the reservation's details.","expandable":false,"children":[{"name":"AdminReservationsRes","type":"[AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes.mdx)","optional":false,"defaultValue":"","description":"The reservation's details.","expandable":false,"children":[{"name":"reservation","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)","description":"Reservation details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsRes>","optional":false,"defaultValue":"","description":"Resolves to the reservation's details.","expandable":false,"children":[{"name":"AdminReservationsRes","type":"[AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes.mdx)","optional":false,"defaultValue":"","description":"The reservation's details.","expandable":false,"children":[{"name":"reservation","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)","description":"Reservation details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -94,11 +94,11 @@ medusa.admin.reservations.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetReservationsParams](../../medusa/classes/medusa.AdminGetReservationsParams.mdx)","description":"Filters and pagination parameters to apply on the retrieved reservations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string` \\| `string`[]","description":"Location IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`[]","description":"Inventory item IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`[]","description":"Line item IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`[]","description":"\"Create by\" user IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Numerical filters to apply on the reservations' `quantity` field.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`number`","description":"The filtered number must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`number`","description":"The filtered number must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"The filtered number must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"The filtered number must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the reservations' `created_at` field.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string` \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"String filters tp apply on the reservations' `description` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetReservationsParams](../../medusa/classes/medusa.AdminGetReservationsParams.mdx)","description":"Filters and pagination parameters to apply on the retrieved reservations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string` \\| `string`[]","description":"Location IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`[]","description":"Inventory item IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`[]","description":"Line item IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`[]","description":"\"Create by\" user IDs to filter reservations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"[NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Numerical filters to apply on the reservations' `quantity` field.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`number`","description":"The filtered number must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`number`","description":"The filtered number must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`number`","description":"The filtered number must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`number`","description":"The filtered number must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the reservations' `created_at` field.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string` \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"String filters tp apply on the reservations' `description` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of reservations with pagination fields.","expandable":false,"children":[{"name":"AdminReservationsListRes","type":"[AdminReservationsListRes](../../medusa/types/medusa.AdminReservationsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of reservations with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reservations","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)[]","description":"An array of reservations details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of reservations with pagination fields.","expandable":false,"children":[{"name":"AdminReservationsListRes","type":"[AdminReservationsListRes](../../medusa/types/medusa.AdminReservationsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of reservations with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reservations","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)[]","description":"An array of reservations details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
### create
|
||||
|
||||
@@ -123,11 +123,11 @@ medusa.admin.reservations.create({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostReservationsReq](../../medusa/classes/medusa.AdminPostReservationsReq.mdx)","description":"The reservation to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the location of the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the inventory item the reservation is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity to reserve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The ID of the line item of the reservation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The reservation's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostReservationsReq](../../medusa/classes/medusa.AdminPostReservationsReq.mdx)","description":"The reservation to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`","description":"The ID of the location of the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The ID of the inventory item the reservation is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity to reserve.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string`","description":"The ID of the line item of the reservation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The reservation's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsRes>","optional":false,"defaultValue":"","description":"Resolves to the reservation's details.","expandable":false,"children":[{"name":"AdminReservationsRes","type":"[AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes.mdx)","optional":false,"defaultValue":"","description":"The reservation's details.","expandable":false,"children":[{"name":"reservation","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)","description":"Reservation details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsRes>","optional":false,"defaultValue":"","description":"Resolves to the reservation's details.","expandable":false,"children":[{"name":"AdminReservationsRes","type":"[AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes.mdx)","optional":false,"defaultValue":"","description":"The reservation's details.","expandable":false,"children":[{"name":"reservation","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)","description":"Reservation details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
### update
|
||||
|
||||
@@ -149,11 +149,11 @@ medusa.admin.reservations.update(reservationId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostReservationsReservationReq](../../medusa/classes/medusa.AdminPostReservationsReservationReq.mdx)","description":"The attributes to update in the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The quantity to reserve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location associated with the reservation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The reservation's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostReservationsReservationReq](../../medusa/classes/medusa.AdminPostReservationsReservationReq.mdx)","description":"The attributes to update in the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The quantity to reserve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the location associated with the reservation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The reservation's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsRes>","optional":false,"defaultValue":"","description":"Resolves to the reservation's details.","expandable":false,"children":[{"name":"AdminReservationsRes","type":"[AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes.mdx)","optional":false,"defaultValue":"","description":"The reservation's details.","expandable":false,"children":[{"name":"reservation","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)","description":"Reservation details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReservationsRes>","optional":false,"defaultValue":"","description":"Resolves to the reservation's details.","expandable":false,"children":[{"name":"AdminReservationsRes","type":"[AdminReservationsRes](../../medusa/types/medusa.AdminReservationsRes.mdx)","optional":false,"defaultValue":"","description":"The reservation's details.","expandable":false,"children":[{"name":"reservation","type":"[ReservationItemDTO](../../medusa/types/medusa.ReservationItemDTO.mdx)","description":"Reservation details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The id of the location of the reservation","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item the reservation relates to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -173,8 +173,8 @@ medusa.admin.reservations.delete(reservationId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the reservation.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, unknown>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
+11
-11
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminReturnReasonsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminReturnReasonsResource
|
||||
|
||||
@@ -40,11 +40,11 @@ medusa.admin.returnReasons.create({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostReturnReasonsReq](../../medusa/classes/medusa.AdminPostReturnReasonsReq.mdx)","description":"The return reason to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"A unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label to display to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The ID of the parent return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the Reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostReturnReasonsReq](../../medusa/classes/medusa.AdminPostReturnReasonsReq.mdx)","description":"The return reason to create.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string`","description":"A unique value of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label to display to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`string`","description":"The ID of the parent return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the Reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"AdminReturnReasonsRes","type":"[AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The return reason's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"AdminReturnReasonsRes","type":"[AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The return reason's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
### update
|
||||
|
||||
@@ -66,11 +66,11 @@ medusa.admin.returnReasons.update(returnReasonId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The return reason's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostReturnReasonsReasonReq](../../medusa/classes/medusa.AdminPostReturnReasonsReasonReq.mdx)","description":"The attributes to update in the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"The label to display to the Customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"A unique value of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the Reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The return reason's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostReturnReasonsReasonReq](../../medusa/classes/medusa.AdminPostReturnReasonsReasonReq.mdx)","description":"The attributes to update in the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"The label to display to the Customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"A unique value of the return reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The description of the Reason.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"AdminReturnReasonsRes","type":"[AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The return reason's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"AdminReturnReasonsRes","type":"[AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The return reason's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -90,11 +90,11 @@ medusa.admin.returnReasons.delete(returnReasonId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
### retrieve
|
||||
|
||||
@@ -114,11 +114,11 @@ medusa.admin.returnReasons.retrieve(returnReasonId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The return reason's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The return reason's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"AdminReturnReasonsRes","type":"[AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The return reason's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"AdminReturnReasonsRes","type":"[AdminReturnReasonsRes](../../medusa/types/medusa.AdminReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The return reason's details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -138,8 +138,8 @@ medusa.admin.returnReasons.list()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of return reasons.","expandable":false,"children":[{"name":"AdminReturnReasonsListRes","type":"[AdminReturnReasonsListRes](../../medusa/types/medusa.AdminReturnReasonsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of return reasons.","expandable":false,"children":[{"name":"return_reasons","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The list of return reasons.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminReturnReasonsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of return reasons.","expandable":false,"children":[{"name":"AdminReturnReasonsListRes","type":"[AdminReturnReasonsListRes](../../medusa/types/medusa.AdminReturnReasonsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of return reasons.","expandable":false,"children":[{"name":"return_reasons","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The list of return reasons.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+7
-7
File diff suppressed because one or more lines are too long
+19
-19
File diff suppressed because one or more lines are too long
+11
-11
File diff suppressed because one or more lines are too long
+11
-11
File diff suppressed because one or more lines are too long
+11
-11
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminStockLocationsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminStockLocationsResource
|
||||
|
||||
@@ -40,11 +40,11 @@ medusa.admin.stockLocations.create({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostStockLocationsReq](../../medusa/classes/medusa.AdminPostStockLocationsReq.mdx)","description":"The stock location to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"the name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddress](../../medusa/classes/medusa.StockLocationAddress.mdx)","description":"A new stock location address to create and associate with the stock location. Only required if `address\\_id` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The two character ISO code for the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"Stock location address' company","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"address_id","type":"`string`","description":"the ID of an existing stock location address to associate with the stock location. Only required if `address` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostStockLocationsReq](../../medusa/classes/medusa.AdminPostStockLocationsReq.mdx)","description":"The stock location to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"the name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddress](../../medusa/classes/medusa.StockLocationAddress.mdx)","description":"A new stock location address to create and associate with the stock location. Only required if `address\\_id` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The two character ISO code for the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"Stock location address' company","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"address_id","type":"`string`","description":"the ID of an existing stock location address to associate with the stock location. Only required if `address` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsRes>","optional":false,"defaultValue":"","description":"Resolves to the stock location's details.","expandable":false,"children":[{"name":"AdminStockLocationsRes","type":"[AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes.mdx)","optional":false,"defaultValue":"","description":"The stock location's details.","expandable":false,"children":[{"name":"stock_location","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)","description":"Stock location details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The stock location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"Stock location address' ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO.mdx)","description":"The Address of the Stock Location","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Stock location address' country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The stock location address' ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"Stock location company' name","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsRes>","optional":false,"defaultValue":"","description":"Resolves to the stock location's details.","expandable":false,"children":[{"name":"AdminStockLocationsRes","type":"[AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes.mdx)","optional":false,"defaultValue":"","description":"The stock location's details.","expandable":false,"children":[{"name":"stock_location","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)","description":"Stock location details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The stock location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"Stock location address' ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO.mdx)","description":"The Address of the Stock Location","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Stock location address' country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The stock location address' ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"Stock location company' name","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
### retrieve
|
||||
|
||||
@@ -64,11 +64,11 @@ medusa.admin.stockLocations.retrieve(stockLocationId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"itemId","type":"`string`","description":"The stock location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"itemId","type":"`string`","description":"The stock location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsRes>","optional":false,"defaultValue":"","description":"Resolves to the stock location's details.","expandable":false,"children":[{"name":"AdminStockLocationsRes","type":"[AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes.mdx)","optional":false,"defaultValue":"","description":"The stock location's details.","expandable":false,"children":[{"name":"stock_location","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)","description":"Stock location details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The stock location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"Stock location address' ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO.mdx)","description":"The Address of the Stock Location","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Stock location address' country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The stock location address' ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"Stock location company' name","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsRes>","optional":false,"defaultValue":"","description":"Resolves to the stock location's details.","expandable":false,"children":[{"name":"AdminStockLocationsRes","type":"[AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes.mdx)","optional":false,"defaultValue":"","description":"The stock location's details.","expandable":false,"children":[{"name":"stock_location","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)","description":"Stock location details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The stock location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"Stock location address' ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO.mdx)","description":"The Address of the Stock Location","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Stock location address' country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The stock location address' ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"Stock location company' name","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
### update
|
||||
|
||||
@@ -90,11 +90,11 @@ medusa.admin.stockLocations.update(stockLocationId, {
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"stockLocationId","type":"`string`","description":"The stock location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostStockLocationsLocationReq](../../medusa/classes/medusa.AdminPostStockLocationsLocationReq.mdx)","description":"The attributes to be updated in the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"the name of the stock location","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddress](../../medusa/classes/medusa.StockLocationAddress-1.mdx)","description":"The data of an associated address to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"First line address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Country code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"Second line address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"Company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"City.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"Phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"Postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"Province.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"address_id","type":"`string`","description":"the stock location address ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"stockLocationId","type":"`string`","description":"The stock location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payload","type":"[AdminPostStockLocationsLocationReq](../../medusa/classes/medusa.AdminPostStockLocationsLocationReq.mdx)","description":"The attributes to be updated in the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"the name of the stock location","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddress](../../medusa/classes/medusa.StockLocationAddress-1.mdx)","description":"The data of an associated address to create or update.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"First line address.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Country code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"Second line address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"Company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"City.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"Phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"Postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"Province.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"address_id","type":"`string`","description":"the stock location address ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsRes>","optional":false,"defaultValue":"","description":"Resolves to the stock location's details.","expandable":false,"children":[{"name":"AdminStockLocationsRes","type":"[AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes.mdx)","optional":false,"defaultValue":"","description":"The stock location's details.","expandable":false,"children":[{"name":"stock_location","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)","description":"Stock location details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The stock location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"Stock location address' ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO.mdx)","description":"The Address of the Stock Location","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Stock location address' country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The stock location address' ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"Stock location company' name","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsRes>","optional":false,"defaultValue":"","description":"Resolves to the stock location's details.","expandable":false,"children":[{"name":"AdminStockLocationsRes","type":"[AdminStockLocationsRes](../../medusa/types/medusa.AdminStockLocationsRes.mdx)","optional":false,"defaultValue":"","description":"The stock location's details.","expandable":false,"children":[{"name":"stock_location","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)","description":"Stock location details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The stock location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"Stock location address' ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[StockLocationAddressDTO](../../medusa/types/medusa.StockLocationAddressDTO.mdx)","description":"The Address of the Stock Location","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"address_1","type":"`string`","description":"Stock location address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"Stock location address' country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The stock location address' ID","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| `null`","description":"Stock location address' complement","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| `null`","description":"Stock location company' name","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `null`","description":"Stock location address' city","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| `null`","description":"Stock location address' phone number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| `null`","description":"Stock location address' postal code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| `null`","description":"Stock location address' province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="update"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -114,11 +114,11 @@ medusa.admin.stockLocations.delete(stockLocationId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The stock location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The stock location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<[DeleteResponse](../../medusa/types/medusa.DeleteResponse-1.mdx)>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/types/medusa.DeleteResponse-1.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the item that was deleted.","optional":false,"defaultValue":"stock_location","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<[DeleteResponse](../../medusa/types/medusa.DeleteResponse-1.mdx)>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/types/medusa.DeleteResponse-1.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the item that was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the item that was deleted.","optional":false,"defaultValue":"stock_location","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -171,8 +171,8 @@ medusa.admin.stockLocations.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetStockLocationsParams](../../medusa/classes/medusa.AdminGetStockLocationsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved stock locations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search stock location names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `string`[]","description":"Filter stock locations by the ID of their associated addresses.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter stock locations by the ID of their associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetStockLocationsParams](../../medusa/classes/medusa.AdminGetStockLocationsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved stock locations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search stock location names.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Names to filter stock locations by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string` \\| `string`[]","description":"Filter stock locations by the ID of their associated addresses.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter stock locations by the ID of their associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of stock locations with pagination fields.","expandable":false,"children":[{"name":"AdminStockLocationsListRes","type":"[AdminStockLocationsListRes](../../medusa/types/medusa.AdminStockLocationsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of stock locations with pagination fields.","expandable":false,"children":[{"name":"stock_locations","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)[]","description":"The list of stock locations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminStockLocationsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of stock locations with pagination fields.","expandable":false,"children":[{"name":"AdminStockLocationsListRes","type":"[AdminStockLocationsListRes](../../medusa/types/medusa.AdminStockLocationsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of stock locations with pagination fields.","expandable":false,"children":[{"name":"stock_locations","type":"[StockLocationExpandedDTO](../../medusa/types/medusa.StockLocationExpandedDTO.mdx)[]","description":"The list of stock locations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"sales_channels","type":"`any`[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+13
-13
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+23
-23
File diff suppressed because one or more lines are too long
+11
-11
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/AdminUploadsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# AdminUploadsResource
|
||||
|
||||
@@ -36,11 +36,11 @@ medusa.admin.uploads.create(file)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"file","type":"`AdminCreateUploadPayload`","description":"The file(s) to upload.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"file","type":"`AdminCreateUploadPayload`","description":"The file(s) to upload.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminUploadsRes>","optional":false,"defaultValue":"","description":"Resolves to the uploaded file details.","expandable":false,"children":[{"name":"AdminUploadsRes","type":"[AdminUploadsRes](../../medusa/types/medusa.AdminUploadsRes.mdx)","optional":false,"defaultValue":"","description":"The list of uploaded files.","expandable":false,"children":[{"name":"uploads","type":"[FileServiceUploadResult](../../medusa/interfaces/medusa.FileServiceUploadResult.mdx)[]","description":"Uploaded files details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"The file's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key. This key is used in other operations,\nsuch as deleting a file.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminUploadsRes>","optional":false,"defaultValue":"","description":"Resolves to the uploaded file details.","expandable":false,"children":[{"name":"AdminUploadsRes","type":"[AdminUploadsRes](../../medusa/types/medusa.AdminUploadsRes.mdx)","optional":false,"defaultValue":"","description":"The list of uploaded files.","expandable":false,"children":[{"name":"uploads","type":"[FileServiceUploadResult](../../medusa/interfaces/medusa.FileServiceUploadResult.mdx)[]","description":"Uploaded files details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"The file's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key. This key is used in other operations,\nsuch as deleting a file.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="create"/>
|
||||
|
||||
### createProtected
|
||||
|
||||
@@ -60,11 +60,11 @@ medusa.admin.uploads.createProtected(file)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"file","type":"`AdminCreateUploadPayload`","description":"The file to upload.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createProtected"/>
|
||||
<TypeList types={[{"name":"file","type":"`AdminCreateUploadPayload`","description":"The file to upload.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createProtected"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminUploadsRes>","optional":false,"defaultValue":"","description":"Resolves to the uploaded file details.","expandable":false,"children":[{"name":"AdminUploadsRes","type":"[AdminUploadsRes](../../medusa/types/medusa.AdminUploadsRes.mdx)","optional":false,"defaultValue":"","description":"The list of uploaded files.","expandable":false,"children":[{"name":"uploads","type":"[FileServiceUploadResult](../../medusa/interfaces/medusa.FileServiceUploadResult.mdx)[]","description":"Uploaded files details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"The file's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key. This key is used in other operations,\nsuch as deleting a file.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createProtected"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminUploadsRes>","optional":false,"defaultValue":"","description":"Resolves to the uploaded file details.","expandable":false,"children":[{"name":"AdminUploadsRes","type":"[AdminUploadsRes](../../medusa/types/medusa.AdminUploadsRes.mdx)","optional":false,"defaultValue":"","description":"The list of uploaded files.","expandable":false,"children":[{"name":"uploads","type":"[FileServiceUploadResult](../../medusa/interfaces/medusa.FileServiceUploadResult.mdx)[]","description":"Uploaded files details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"The file's URL.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"key","type":"`string`","description":"The file's key. This key is used in other operations,\nsuch as deleting a file.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="createProtected"/>
|
||||
|
||||
### delete
|
||||
|
||||
@@ -86,11 +86,11 @@ medusa.admin.uploads.delete({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminDeleteUploadsReq](../../medusa/classes/medusa.AdminDeleteUploadsReq.mdx)","description":"The uploaded file to delete.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"file_key","type":"`string`","description":"key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminDeleteUploadsReq](../../medusa/classes/medusa.AdminDeleteUploadsReq.mdx)","description":"The uploaded file to delete.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"file_key","type":"`string`","description":"key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<DeleteResponse>","optional":false,"defaultValue":"","description":"Resolves to the deletion operation's details.","expandable":false,"children":[{"name":"DeleteResponse","type":"[DeleteResponse](../../medusa/interfaces/medusa.DeleteResponse.mdx)","optional":false,"defaultValue":"","description":"The response returned for a \n\n`DELETE`\n\n request.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the deleted item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`string`","description":"The type of the deleted item.","optional":false,"defaultValue":"product-collection","expandable":false,"children":[]},{"name":"deleted","type":"`boolean`","description":"Whether the item was deleted successfully.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="delete"/>
|
||||
|
||||
### getPresignedDownloadUrl
|
||||
|
||||
@@ -112,18 +112,18 @@ medusa.admin.uploads.getPresignedDownloadUrl({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"payload","type":"[AdminPostUploadsDownloadUrlReq](../../medusa/classes/medusa.AdminPostUploadsDownloadUrlReq.mdx)","description":"The uploaded file to get a presigned download URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"file_key","type":"`string`","description":"key of the file to obtain the download link for. This is obtained when you first uploaded the file, or by the file service if you used it directly.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getPresignedDownloadUrl"/>
|
||||
<TypeList types={[{"name":"payload","type":"[AdminPostUploadsDownloadUrlReq](../../medusa/classes/medusa.AdminPostUploadsDownloadUrlReq.mdx)","description":"The uploaded file to get a presigned download URL for.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"file_key","type":"`string`","description":"key of the file to obtain the download link for. This is obtained when you first uploaded the file, or by the file service if you used it directly.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getPresignedDownloadUrl"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<AdminUploadsDownloadUrlRes>","optional":false,"defaultValue":"","description":"Resolves to the download URL details.","expandable":false,"children":[{"name":"AdminUploadsDownloadUrlRes","type":"[AdminUploadsDownloadUrlRes](../../medusa/types/medusa.AdminUploadsDownloadUrlRes.mdx)","optional":false,"defaultValue":"","description":"The download URL details.","expandable":false,"children":[{"name":"download_url","type":"`string`","description":"The Download URL of the file","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getPresignedDownloadUrl"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<AdminUploadsDownloadUrlRes>","optional":false,"defaultValue":"","description":"Resolves to the download URL details.","expandable":false,"children":[{"name":"AdminUploadsDownloadUrlRes","type":"[AdminUploadsDownloadUrlRes](../../medusa/types/medusa.AdminUploadsDownloadUrlRes.mdx)","optional":false,"defaultValue":"","description":"The download URL details.","expandable":false,"children":[{"name":"download_url","type":"`string`","description":"The Download URL of the file","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="getPresignedDownloadUrl"/>
|
||||
|
||||
### \_createPayload
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"file","type":"`AdminCreateUploadPayload`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="_createPayload"/>
|
||||
<TypeList types={[{"name":"file","type":"`AdminCreateUploadPayload`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="_createPayload"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"FormData","type":"`FormData`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="_createPayload"/>
|
||||
<TypeList types={[{"name":"FormData","type":"`FormData`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="_createPayload"/>
|
||||
|
||||
+15
-15
File diff suppressed because one or more lines are too long
+7
-7
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+5
-5
File diff suppressed because one or more lines are too long
+14
-14
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+13
-13
File diff suppressed because one or more lines are too long
+3
-3
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/PaymentMethodsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# PaymentMethodsResource
|
||||
|
||||
@@ -33,8 +33,8 @@ medusa.customers.paymentMethods.list()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreCustomersListPaymentMethodsRes>","optional":false,"defaultValue":"","description":"Resolves to the customer's payment methods.","expandable":false,"children":[{"name":"StoreCustomersListPaymentMethodsRes","type":"[StoreCustomersListPaymentMethodsRes](../../medusa/types/medusa.StoreCustomersListPaymentMethodsRes.mdx)","optional":false,"defaultValue":"","description":"The payment method's details.","expandable":false,"children":[{"name":"payment_methods","type":"`object`[]","description":"The details of the saved payment methods.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider where the payment method is saved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`object`","description":"The data needed for the Payment Provider to use the saved payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreCustomersListPaymentMethodsRes>","optional":false,"defaultValue":"","description":"Resolves to the customer's payment methods.","expandable":false,"children":[{"name":"StoreCustomersListPaymentMethodsRes","type":"[StoreCustomersListPaymentMethodsRes](../../medusa/types/medusa.StoreCustomersListPaymentMethodsRes.mdx)","optional":false,"defaultValue":"","description":"The payment method's details.","expandable":false,"children":[{"name":"payment_methods","type":"`object`[]","description":"The details of the saved payment methods.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider where the payment method is saved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`object`","description":"The data needed for the Payment Provider to use the saved payment method.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+5
-5
File diff suppressed because one or more lines are too long
+3
-3
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/ProductTagsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ProductTagsResource
|
||||
|
||||
@@ -48,8 +48,8 @@ medusa.productTags.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[StoreGetProductTagsParams](../../medusa/classes/medusa.StoreGetProductTagsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product tags.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product tags' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply to the product tags' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply to the product tags' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product tags by the ID of their associated discount condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[StoreGetProductTagsParams](../../medusa/classes/medusa.StoreGetProductTagsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product tags.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product tags' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to filter product tags by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply to the product tags' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply to the product tags' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product tags by the ID of their associated discount condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreProductTagsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product tags with pagination fields.","expandable":false,"children":[{"name":"StoreProductTagsListRes","type":"[StoreProductTagsListRes](../../medusa/types/medusa.StoreProductTagsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of product tags with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"An array of product tags details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product tag's ID","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":"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":"value","type":"`string`","description":"The value that the Product Tag represents","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreProductTagsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product tags with pagination fields.","expandable":false,"children":[{"name":"StoreProductTagsListRes","type":"[StoreProductTagsListRes](../../medusa/types/medusa.StoreProductTagsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of product tags with pagination fields.","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"An array of product tags details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product tag's ID","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":"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":"value","type":"`string`","description":"The value that the Product Tag represents","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+3
-3
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/ProductTypesResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ProductTypesResource
|
||||
|
||||
@@ -50,8 +50,8 @@ medusa.productTypes.list({
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[StoreGetProductTypesParams](../../medusa/classes/medusa.StoreGetProductTypesParams.mdx)","description":"Filters and pagination configurations to apply on retrieved product types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product types' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product types by the ID of their associated discount condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[StoreGetProductTypesParams](../../medusa/classes/medusa.StoreGetProductTypesParams.mdx)","description":"Filters and pagination configurations to apply on retrieved product types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product types' values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"Values to filter product types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product types' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product types by the ID of their associated discount condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreProductTypesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product types with pagination fields.","expandable":false,"children":[{"name":"StoreProductTypesListRes","type":"[StoreProductTypesListRes](../../medusa/types/medusa.StoreProductTypesListRes.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)[]","description":"An array of product types details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product type's ID","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":"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":"value","type":"`string`","description":"The value that the Product Type represents.","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreProductTypesListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of product types with pagination fields.","expandable":false,"children":[{"name":"StoreProductTypesListRes","type":"[StoreProductTypesListRes](../../medusa/types/medusa.StoreProductTypesListRes.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)[]","description":"An array of product types details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product type's ID","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":"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":"value","type":"`string`","description":"The value that the Product Type represents.","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
+5
-5
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+5
-5
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/ReturnReasonsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ReturnReasonsResource
|
||||
|
||||
@@ -31,11 +31,11 @@ medusa.returnReasons.retrieve(reasonId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the return reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"StoreReturnReasonsRes","type":"[StoreReturnReasonsRes](../../medusa/types/medusa.StoreReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"Return reason details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreReturnReasonsRes>","optional":false,"defaultValue":"","description":"Resolves to the return reason's details.","expandable":false,"children":[{"name":"StoreReturnReasonsRes","type":"[StoreReturnReasonsRes](../../medusa/types/medusa.StoreReturnReasonsRes.mdx)","optional":false,"defaultValue":"","description":"The return reason's details.","expandable":false,"children":[{"name":"return_reason","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"Return reason details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="retrieve"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -54,8 +54,8 @@ medusa.returnReasons.list()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreReturnReasonsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of return reasons.","expandable":false,"children":[{"name":"StoreReturnReasonsListRes","type":"[StoreReturnReasonsListRes](../../medusa/types/medusa.StoreReturnReasonsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of return reasons.","expandable":false,"children":[{"name":"return_reasons","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"An array of return reasons details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreReturnReasonsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of return reasons.","expandable":false,"children":[{"name":"StoreReturnReasonsListRes","type":"[StoreReturnReasonsListRes](../../medusa/types/medusa.StoreReturnReasonsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of return reasons.","expandable":false,"children":[{"name":"return_reasons","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"An array of return reasons details.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","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":"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":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](../../entities/classes/entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](../../entities/classes/entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","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":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
+5
-5
@@ -3,7 +3,7 @@ displayed_sidebar: jsClientSidebar
|
||||
slug: /references/js-client/ShippingOptionsResource
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import TypeList from "@site/src/components/TypeList"
|
||||
|
||||
# ShippingOptionsResource
|
||||
|
||||
@@ -33,11 +33,11 @@ medusa.shippingOptions.listCartOptions(cartId)
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"cart_id","type":"`string`","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="listCartOptions"/>
|
||||
<TypeList types={[{"name":"cart_id","type":"`string`","description":"The cart's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="listCartOptions"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreShippingOptionsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of shipping options.","expandable":false,"children":[{"name":"StoreShippingOptionsListRes","type":"[StoreShippingOptionsListRes](../../medusa/types/medusa.StoreShippingOptionsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of shipping options.","expandable":false,"children":[{"name":"shipping_options","type":"[PricedShippingOption](../../medusa/types/medusa.PricedShippingOption.mdx)[]","description":"An array of shipping options details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="listCartOptions"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreShippingOptionsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of shipping options.","expandable":false,"children":[{"name":"StoreShippingOptionsListRes","type":"[StoreShippingOptionsListRes](../../medusa/types/medusa.StoreShippingOptionsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of shipping options.","expandable":false,"children":[{"name":"shipping_options","type":"[PricedShippingOption](../../medusa/types/medusa.PricedShippingOption.mdx)[]","description":"An array of shipping options details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="listCartOptions"/>
|
||||
|
||||
### list
|
||||
|
||||
@@ -56,8 +56,8 @@ medusa.shippingOptions.list()
|
||||
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[StoreGetShippingOptionsParams](../../medusa/classes/medusa.StoreGetShippingOptionsParams.mdx)","description":"The filters to apply on the shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"product_ids","type":"`string`","description":"Product ID that is used to filter shipping options by whether they can be used to ship that product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"Filter the shipping options by the ID of their associated region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_return","type":"`string`","description":"Filter the shipping options by whether they're return shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"customHeaders","type":"`Record<string, any>`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[StoreGetShippingOptionsParams](../../medusa/classes/medusa.StoreGetShippingOptionsParams.mdx)","description":"The filters to apply on the shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"product_ids","type":"`string`","description":"Product ID that is used to filter shipping options by whether they can be used to ship that product.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"Filter the shipping options by the ID of their associated region.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_return","type":"`string`","description":"Filter the shipping options by whether they're return shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[{"name":"ResponsePromise","type":"ResponsePromise<StoreShippingOptionsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of shipping options.","expandable":false,"children":[{"name":"StoreShippingOptionsListRes","type":"[StoreShippingOptionsListRes](../../medusa/types/medusa.StoreShippingOptionsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of shipping options.","expandable":false,"children":[{"name":"shipping_options","type":"[PricedShippingOption](../../medusa/types/medusa.PricedShippingOption.mdx)[]","description":"An array of shipping options details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
<TypeList types={[{"name":"ResponsePromise","type":"ResponsePromise<StoreShippingOptionsListRes>","optional":false,"defaultValue":"","description":"Resolves to the list of shipping options.","expandable":false,"children":[{"name":"StoreShippingOptionsListRes","type":"[StoreShippingOptionsListRes](../../medusa/types/medusa.StoreShippingOptionsListRes.mdx)","optional":false,"defaultValue":"","description":"The list of shipping options.","expandable":false,"children":[{"name":"shipping_options","type":"[PricedShippingOption](../../medusa/types/medusa.PricedShippingOption.mdx)[]","description":"An array of shipping options details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields" sectionTitle="list"/>
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user