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

Generated the following references:
- `cart`
- `cart_models`
- `core_flows`
- `fulfillment`
- `js_sdk`
- `medusa`
- `modules`
- `order`
- `payment`
- `payment_provider`
- `types`

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 2025-03-04 14:14:00 +00:00
1 parent 6294a71296
commit af613bbc4e
636 files changed
+475297 -464638

No files matched your search

@@ -104,7 +104,7 @@ sdk.admin.order.retrievePreview("order_123")
### Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Query parameters.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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).","optionLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Query parameters.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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).","optionLine truncated
### Returns
@@ -158,7 +158,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
### Parameters
<TypeList types={[{"name":"queryParams","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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`","descriptiLine truncated
<TypeList types={[{"name":"queryParams","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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`","descriptiLine truncated
### Returns
@@ -15,7 +15,7 @@ This documentation provides a reference to the `sdk.admin.productVariant` set of
## list
This method retrieves a paginated list of product variants. It sends a request to the
This method retrieves a paginated list of product variants. It sends a request to the
[List Product Variants](https://docs.medusajs.com/api/admin#product-variants\_getproductvariants)
API route.
@@ -46,7 +46,7 @@ Learn more about the `fields` property in the [API reference](https://docs.medus
## Parameters
<TypeList types={[{"name":"queryParams","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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`","descriptiLine truncated
<TypeList types={[{"name":"queryParams","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Filters and pagination configurations.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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`","descriptiLine truncated
## Returns
@@ -16,7 +16,7 @@ sdk.admin.order.retrievePreview("order_123")
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Query parameters.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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).","optionLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[AdminOrderFilters](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminOrderFilters/page.mdx)","description":"Query parameters.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter by order ID(s).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx) \\| [OrderStatus](../../../../../fulfillment/types/fulfillment.OrderStatus/page.mdx)[] \\| [OperatorMap](../../../../../types/DAL/types/types.DAL.OperatorMap/page.mdx)&#60;OrderStatus | OrderStatus[]&#62;","description":"Filter by status(es).","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"$and","type":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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":"([BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx) \\| [BaseFilterable](../../../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)&#60;[BaseOrderFilters](../../../../../types/interfaces/types.BaseOrderFilters/page.mdx)&#62;)[]","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).","optionLine truncated
## Returns
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
# list
This method retrieves a paginated list of product variants. It sends a request to the
This method retrieves a paginated list of product variants. It sends a request to the
[List Product Variants](https://docs.medusajs.com/api/admin#product-variants\_getproductvariants)
API route.
@@ -23,7 +23,7 @@ sdk.auth.callback(
"google",
{
code: "123",
state: "456"
state: "456"
}
).then((token) => {
console.log(token)
@@ -39,7 +39,7 @@ sdk.auth.updateProvider(
## Parameters
<TypeList types={[{"name":"actor","type":"`string`","description":"The actor type. For example, `user` for admin user, or `customer` for customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The authentication provider to use. For example, `emailpass`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`Record<string, unknown>`","description":"The data necessary to update the user's authentication data. When resetting the user's password,\nsend the `password` property.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/>
<TypeList types={[{"name":"actor","type":"`string`","description":"The actor type. For example, `user` for admin user, or `customer` for customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The authentication provider to use. For example, `emailpass`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"[AdminUpdateProvider](../../../../../types/HttpTypes/interfaces/types.HttpTypes.AdminUpdateProvider/page.mdx)","description":"The data necessary to update the user's authentication data. When resetting the user's password,\nsend the `password` property.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProvider"/>
## Returns