Back to Medusa

retrieveFulfillmentOptions - Fulfillment Module Reference

www/apps/resources/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillmentOptions/page.mdx

2.14.21.7 KB
Original Source

import { TypeList } from "docs-ui"

retrieveFulfillmentOptions - Fulfillment Module Reference

This documentation provides a reference to the retrieveFulfillmentOptions method. This belongs to the Fulfillment Module.

<Note>

You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

</Note>

This method retrieves the fulfillment options of a fulfillment provider.

Example

ts
const fulfillment =
  await fulfillmentModuleService.retrieveFulfillmentOptions(
    "ful_123"
  )

Parameters

<TypeList types={[{"name":"providerId","type":"string","description":"The fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveFulfillmentOptions"/>

Returns

<TypeList types={[{"name":"Promise","type":"Promise<Record<string, unknown>[]>","optional":false,"defaultValue":"","description":"The fulfillment provider's options.","expandable":false,"children":[{"name":"Record<string, unknown>[]","type":"Record<string, unknown>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"string","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"unknown","type":"unknown","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveFulfillmentOptions"/>