docs: add JS SDK to commerce modules sidebars (#10740)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
688e1e60a5
commit
ee50e67a96
111 files changed
+8567
-5406
No files matched your search
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/apiKey
|
||||
sidebar_label: apiKey
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- api key
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/campaign
|
||||
sidebar_label: campaign
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- promotion
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/claim
|
||||
sidebar_label: claim
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/currency
|
||||
sidebar_label: currency
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- currency
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/customer
|
||||
sidebar_label: customer
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- customer
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/customerGroup
|
||||
sidebar_label: customerGroup
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- customer
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/exchange
|
||||
sidebar_label: exchange
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/fulfillment
|
||||
sidebar_label: fulfillment
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/fulfillmentProvider
|
||||
sidebar_label: fulfillmentProvider
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/fulfillmentSet
|
||||
sidebar_label: fulfillmentSet
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/inventoryItem
|
||||
sidebar_label: inventoryItem
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- inventory
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/invite
|
||||
sidebar_label: invite
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- user
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/notification
|
||||
sidebar_label: notification
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- notification
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/order
|
||||
sidebar_label: order
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/orderEdit
|
||||
sidebar_label: orderEdit
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/payment
|
||||
sidebar_label: payment
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- payment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/paymentCollection
|
||||
sidebar_label: paymentCollection
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- payment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/priceList
|
||||
sidebar_label: priceList
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- pricing
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/pricePreference
|
||||
sidebar_label: pricePreference
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- pricing
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/product
|
||||
sidebar_label: product
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/productCategory
|
||||
sidebar_label: productCategory
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/productCollection
|
||||
sidebar_label: productCollection
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/productTag
|
||||
sidebar_label: productTag
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/productType
|
||||
sidebar_label: productType
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/productVariant
|
||||
sidebar_label: productVariant
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/promotion
|
||||
sidebar_label: promotion
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- promotion
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/refundReason
|
||||
sidebar_label: refundReason
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/region
|
||||
sidebar_label: region
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- region
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/reservation
|
||||
sidebar_label: reservation
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- inventory
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/return
|
||||
sidebar_label: return
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/returnReason
|
||||
sidebar_label: returnReason
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/salesChannel
|
||||
sidebar_label: salesChannel
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- sales channel
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/shippingOption
|
||||
sidebar_label: shippingOption
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/shippingProfile
|
||||
sidebar_label: shippingProfile
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/stockLocation
|
||||
sidebar_label: stockLocation
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- stock location
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/store
|
||||
sidebar_label: store
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- store
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/taxRate
|
||||
sidebar_label: taxRate
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- tax
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/taxRegion
|
||||
sidebar_label: taxRegion
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- tax
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/upload
|
||||
sidebar_label: upload
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- file
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/user
|
||||
sidebar_label: user
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- user
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/admin/workflowExecution
|
||||
sidebar_label: workflowExecution
|
||||
tags:
|
||||
- js sdk
|
||||
- admin
|
||||
- workflow
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+3
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/callback
|
||||
sidebar_label: callback
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/login
|
||||
sidebar_label: login
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+3
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/logout
|
||||
sidebar_label: logout
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+3
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/refresh
|
||||
sidebar_label: refresh
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+3
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/register
|
||||
sidebar_label: register
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+3
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/resetPassword
|
||||
sidebar_label: resetPassword
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+3
@@ -1,6 +1,9 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth/updateProvider
|
||||
sidebar_label: updateProvider
|
||||
tags:
|
||||
- js sdk
|
||||
- auth
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
---
|
||||
slug: /references/js-sdk/auth
|
||||
tags:
|
||||
- js sdk
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/cart
|
||||
sidebar_label: cart
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- cart
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/category
|
||||
sidebar_label: category
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/collection
|
||||
sidebar_label: collection
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/customer
|
||||
sidebar_label: customer
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- customer
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/fulfillment
|
||||
sidebar_label: fulfillment
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- fulfillment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/order
|
||||
sidebar_label: order
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- order
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/payment
|
||||
sidebar_label: payment
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- payment
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
+6
-2
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/product
|
||||
sidebar_label: product
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- product
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
@@ -60,7 +64,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"query","type":"[StoreProductParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductParams/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"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":"q","type":"`string`","description":"A query or keywords to search the searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)[]","description":"Filter the product by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter the product by the sales channel(s) it belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by the product's title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by the product's handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by the product's id(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filter by whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string` \\| `string`[]","description":"Filter by the product's tag(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter by the product's type(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_id","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[]","description":"Filter by the product's collection(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)<string>","description":"Apply filers on the product's creation date.","optional":true,"defaultValue":"",Line truncated
|
||||
<TypeList types={[{"name":"query","type":"`StoreProductListParams`","description":"Filters and pagination configurations.","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/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
@@ -104,7 +108,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[SelectParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)","description":"Configure the fields to retrieve in the product.","optional":true,"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":"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/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[StoreProductParams](../../../../../types/HttpTypes/interfaces/types.HttpTypes.StoreProductParams/page.mdx)","description":"Configure the fields to retrieve in the product.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<[BaseProductListParams](../../../../../types/interfaces/types.BaseProductListParams/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"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":"q","type":"`string`","description":"A query or keywords to search the searchable fields by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx) \\| [ProductStatus](../../../../../types/types/types.ProductStatus/page.mdx)[]","description":"Filter the product by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string` \\| `string`[]","description":"Filter the product by the sales channel(s) it belongs to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `string`[]","description":"Filter by the product's title(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string` \\| `string`[]","description":"Filter by the product's handle(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"Filter by the product's id(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Filter by whether the product is a gift card.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string` \\| `string`[]","description":"Filter by the product's tag(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type_id","type":"`string` \\| `string`[]","description":"Filter by the product's type(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"category_id","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"categories","type":"`string` \\| `string`[]","description":"Filter by the product's category(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"collection_id","type":"`string` \\| `string`[]","description":"Filter by the product's collection(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../types/DAL/types/Line truncated
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
+4
@@ -1,6 +1,10 @@
|
||||
---
|
||||
slug: /references/js-sdk/store/region
|
||||
sidebar_label: region
|
||||
tags:
|
||||
- js sdk
|
||||
- storefront
|
||||
- region
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
Reference in new issue
Block a user