Get Started
Product
Framework
Commerce Modules
Infrastructure Modules
Build
Recipes
How-to & Tutorials
Integrations
Storefront
Tools
CLI Tools
JS SDK
Next.js Starter
Medusa UI
Reference
Admin API
Store API
Admin Injection Zones
Container Resources
Core Workflows
Data Model Language
Data Model Repository
Events Reference
Helper Steps
Service Factory
Testing Framework
Workflows SDK
User Guide
Cloud

Help

Troubleshooting

Discord Community

Hide Sidebar⌘\

Theme

Light

Dark

Menu

Get Started
Product
Build
Tools
Reference
User Guide
Cloud

Loading...

Was this page helpful?

New versionv2.10.2 details

Loading...

View as Markdown

Ask Anything

FAQ

What is Medusa?

How can I create a module?

How can I create a data model?

How do I create a workflow?

How can I extend a data model in the Product Module?

Recipes

How do I build a marketplace with Medusa?

How do I build digital products with Medusa?

How do I build subscription-based purchases with Medusa?

What other recipes are available in the Medusa documentation?

Chat is cleared on refresh

Line break

⇧↵

Navigation↑↓

Open Result↵

ServiceStepInput

The remote query's details.

fieldsstring[]

The fields to retrieve in the records.

servicestring

The name of the module's service.

variablesRecord<string, any>Optional

Filters, context variables, or pagination fields to apply when retrieving the records.

throw_if_key_not_foundbooleanOptional

Throw an error if a record isn't found matching an ID specified in the filters.

throw_if_relation_not_foundboolean | string[]Optional

Throw an error if a specified relation isn't found.

listbooleanOptional

Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.

Default: true