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

chore(docs): Generated References (automated) (#10016)

Browse Source 
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and GitHub committed 2024-11-11 11:12:13 +00:00
1 parent 1d2efb5ae3
commit 1cab15b209
113 files changed
+500481 -499982
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.cart/page.mdx
+8 -8
View File
@@ -69,7 +69,7 @@ ___
## retrieve
This method retrieves a cart by its ID. It sends a request to the
This method retrieves a cart by its ID. It sends a request to the
[Get Cart](https://docs.medusajs.com/api/store#carts\_getcartsid) API route.
Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/retrieve).
@@ -139,7 +139,7 @@ ___
## updateLineItem
This method updates a line item in a cart. It sends a request to the
This method updates a line item in a cart. It sends a request to the
[Update Line Item](https://docs.medusajs.com/api/store#carts\_postcartsidlineitemsline\_id) API route.
Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
@@ -148,7 +148,7 @@ Related guide: [How to manage a cart's line items in the storefront](https://doc
```ts
sdk.store.cart.updateLineItem(
"cart_123",
"cart_123",
"li_123",
{
quantity: 1
@@ -200,7 +200,7 @@ ___
## addShippingMethod
This method adds a shipping method to a cart. It sends a request to
This method adds a shipping method to a cart. It sends a request to
the [Add Shipping Method](https://docs.medusajs.com/api/store#carts\_postcartsidshippingmethods) API routes.
Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
@@ -318,7 +318,7 @@ ___
## retrieve
This method retrieves a cart by its ID. It sends a request to the
This method retrieves a cart by its ID. It sends a request to the
[Get Cart](https://docs.medusajs.com/api/store#carts\_getcartsid) API route.
Related guide: [How to retrieve a cart in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/retrieve).
@@ -388,7 +388,7 @@ ___
## updateLineItem
This method updates a line item in a cart. It sends a request to the
This method updates a line item in a cart. It sends a request to the
[Update Line Item](https://docs.medusajs.com/api/store#carts\_postcartsidlineitemsline\_id) API route.
Related guide: [How to manage a cart's line items in the storefront](https://docs.medusajs.com/resources/storefront-development/cart/manage-items).
@@ -397,7 +397,7 @@ Related guide: [How to manage a cart's line items in the storefront](https://doc
```ts
sdk.store.cart.updateLineItem(
"cart_123",
"cart_123",
"li_123",
{
quantity: 1
@@ -449,7 +449,7 @@ ___
## addShippingMethod
This method adds a shipping method to a cart. It sends a request to
This method adds a shipping method to a cart. It sends a request to
the [Add Shipping Method](https://docs.medusajs.com/api/store#carts\_postcartsidshippingmethods) API routes.
Related guide: [Implement shipping step during checkout](https://docs.medusajs.com/resources/storefront-development/checkout/shipping).
www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.category/page.mdx
+8 -8
View File
@@ -11,14 +11,14 @@ This documentation provides a reference to the `sdk.store.category` set of metho
## list
This method retrieves a paginated list of product categories. It sends a request to the
This method retrieves a paginated list of product categories. It sends a request to the
[List Categories](https://docs.medusajs.com/api/store#product-categories\_getproductcategories) API route.
Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/list).
### Example
To retrieve the list of categoreis:
To retrieve the list of categories:
```ts
sdk.store.category.list()
@@ -61,13 +61,13 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of categoreis.","expandable":false,"children":[{"name":"StoreProductCategoryListResponse","type":"[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_categories","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The paginated list of categories.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)","description":"The parent category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[StoreProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx)[]","description":"The category's products.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of categories.","expandable":false,"children":[{"name":"StoreProductCategoryListResponse","type":"[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_categories","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The paginated list of categories.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)","description":"The parent category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[StoreProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx)[]","description":"The category's products.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
___
## retrieve
This method retrieves a category by its ID. It sends a request to the
This method retrieves a category by its ID. It sends a request to the
[Retrieve Product Category](https://docs.medusajs.com/api/store#product-categories\_getproductcategoriesid).
Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve).
@@ -106,14 +106,14 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## list
This method retrieves a paginated list of product categories. It sends a request to the
This method retrieves a paginated list of product categories. It sends a request to the
[List Categories](https://docs.medusajs.com/api/store#product-categories\_getproductcategories) API route.
Related guide: [How to retrieve list of categories in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/list).
### Example
To retrieve the list of categoreis:
To retrieve the list of categories:
```ts
sdk.store.category.list()
@@ -156,13 +156,13 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of categoreis.","expandable":false,"children":[{"name":"StoreProductCategoryListResponse","type":"[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_categories","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The paginated list of categories.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)","description":"The parent category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[StoreProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx)[]","description":"The category's products.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The paginated list of categories.","expandable":false,"children":[{"name":"StoreProductCategoryListResponse","type":"[StoreProductCategoryListResponse](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategoryListResponse/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"The maximum number of items retrieved.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_categories","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The paginated list of categories.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The category's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The category's name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"The product category's unique handle. Can be used to create\nhuman-readable URLs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rank","type":"`null` \\| `number`","description":"The category's ranking among sibling categories.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the category's parent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The date the category was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the category was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The date the category was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)","description":"The parent category.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"category_children","type":"[StoreProductCategory](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductCategory/page.mdx)[]","description":"The category's children.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Key-value pairs of custom data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[StoreProduct](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProduct/page.mdx)[]","description":"The category's products.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
___
## retrieve
This method retrieves a category by its ID. It sends a request to the
This method retrieves a category by its ID. It sends a request to the
[Retrieve Product Category](https://docs.medusajs.com/api/store#product-categories\_getproductcategoriesid).
Related guide: [How to retrieve a category in the storefront](https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve).
www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.customer/page.mdx
+2 -2
View File
@@ -15,7 +15,7 @@ This method registers a customer. It sends a request to the [Register Customer](
API route.
You must use the Auth.register method first to retrieve a registration token. Then, pass that
registration token in the `headers` parameter of this method as an authorization bearer header.
registration token in the `headers` parameter of this method as an authorization bearer header.
Related guide: [How to register customer in storefront](https://docs.medusajs.com/resources/storefront-development/customers/register)
@@ -315,7 +315,7 @@ This method registers a customer. It sends a request to the [Register Customer](
API route.
You must use the Auth.register method first to retrieve a registration token. Then, pass that
registration token in the `headers` parameter of this method as an authorization bearer header.
registration token in the `headers` parameter of this method as an authorization bearer header.
Related guide: [How to register customer in storefront](https://docs.medusajs.com/resources/storefront-development/customers/register)
www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.order/page.mdx
+2 -2
View File
@@ -66,7 +66,7 @@ ___
## retrieve
This method retrieves an order by its ID. It sends a request to the
This method retrieves an order by its ID. It sends a request to the
[Get Order](https://docs.medusajs.com/api/store#orders\_getordersid) API route.
### Example
@@ -158,7 +158,7 @@ ___
## retrieve
This method retrieves an order by its ID. It sends a request to the
This method retrieves an order by its ID. It sends a request to the
[Get Order](https://docs.medusajs.com/api/store#orders\_getordersid) API route.
### Example
www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.payment/page.mdx
+2 -2
View File
@@ -64,7 +64,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Parameters
<TypeList types={[{"name":"query","type":"[FindParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx) & [StorePaymentProviderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProviderFilters/page.mdx)","description":"The filters to apply on the retrieved providers, along with configurations of the \nfields to retrieve in the options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The ID of the region to retrieve its payment providers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../../admin/types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
<TypeList types={[{"name":"query","type":"[FindParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx) & [StorePaymentProviderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProviderFilters/page.mdx)","description":"The filters to apply on the retrieved providers, along with configurations of the\nfields to retrieve in the options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The ID of the region to retrieve its payment providers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../../admin/types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
### Returns
@@ -164,7 +164,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Parameters
<TypeList types={[{"name":"query","type":"[FindParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx) & [StorePaymentProviderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProviderFilters/page.mdx)","description":"The filters to apply on the retrieved providers, along with configurations of the \nfields to retrieve in the options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The ID of the region to retrieve its payment providers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../../admin/types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
<TypeList types={[{"name":"query","type":"[FindParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx) & [StorePaymentProviderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StorePaymentProviderFilters/page.mdx)","description":"The filters to apply on the retrieved providers, along with configurations of the\nfields to retrieve in the options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"region_id","type":"`string`","description":"The ID of the region to retrieve its payment providers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"The fields and relations to retrieve separated by commas.\n\nLearn more in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"The maximum number of items to retrieve.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip before retrieving the returned items.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort by and in which order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"headers","type":"[ClientHeaders](../../../../admin/types/js_sdk.admin.ClientHeaders/page.mdx)","description":"Headers to pass in the request.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"tags","type":"`string`[]","description":"Tags to cache data under for Next.js applications.\n\nLearn more in [Next.js's documentation](https://nextjs.org/docs/app/building-your-application/caching#fetch-optionsnexttags-and-revalidatetag).","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
### Returns
www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.product/page.mdx
+2 -2
View File
@@ -70,7 +70,7 @@ ___
## retrieve
This method is used to retrieve a product by its ID. It sends a request to the
This method is used to retrieve a product by its ID. It sends a request to the
[Get Product](https://docs.medusajs.com/api/store#products\_getproductsid) API route.
Related guides:
@@ -171,7 +171,7 @@ ___
## retrieve
This method is used to retrieve a product by its ID. It sends a request to the
This method is used to retrieve a product by its ID. It sends a request to the
[Get Product](https://docs.medusajs.com/api/store#products\_getproductsid) API route.
Related guides:
www/apps/resources/references/js_sdk/store/Store/properties/js_sdk.store.Store.region/page.mdx
+2 -2
View File
@@ -11,7 +11,7 @@ This documentation provides a reference to the `sdk.store.region` set of methods
## list
This method retrieves the paginated list of regions in the store. It sends a request to the
This method retrieves the paginated list of regions in the store. It sends a request to the
[List Regions API route](https://docs.medusajs.com/api/store#regions\_getregions).
Related guide: [How to list regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/list).
@@ -109,7 +109,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## list
This method retrieves the paginated list of regions in the store. It sends a request to the
This method retrieves the paginated list of regions in the store. It sends a request to the
[List Regions API route](https://docs.medusajs.com/api/store#regions\_getregions).
Related guide: [How to list regions in a storefront](https://docs.medusajs.com/resources/storefront-development/regions/list).