96 lines
11 KiB
Plaintext
96 lines
11 KiB
Plaintext
---
|
||
displayed_sidebar: fulfillmentReference
|
||
slug: /references/fulfillment
|
||
---
|
||
|
||
import { TypeList } from "docs-ui"
|
||
|
||
# IFulfillmentModuleService Reference
|
||
|
||
This section of the documentation provides a reference to the `IFulfillmentModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Fulfillment Module.
|
||
|
||
<Note>
|
||
|
||
You should only use the methods in this reference when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
|
||
|
||
</Note>
|
||
|
||
The main service interface for the Fulfillment Module.
|
||
|
||
## Methods
|
||
|
||
- [calculateShippingOptionsPrices](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices/page.mdx)
|
||
- [cancelFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx)
|
||
- [createFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx)
|
||
- [createFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx)
|
||
- [createGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx)
|
||
- [createReturnFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createReturnFulfillment/page.mdx)
|
||
- [createServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createServiceZones/page.mdx)
|
||
- [createShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptionRules/page.mdx)
|
||
- [createShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptions/page.mdx)
|
||
- [createShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptionTypes/page.mdx)
|
||
- [createShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles/page.mdx)
|
||
- [deleteFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillment/page.mdx)
|
||
- [deleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets/page.mdx)
|
||
- [deleteGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteGeoZones/page.mdx)
|
||
- [deleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteServiceZones/page.mdx)
|
||
- [deleteShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptionRules/page.mdx)
|
||
- [deleteShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptions/page.mdx)
|
||
- [deleteShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptionTypes/page.mdx)
|
||
- [deleteShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingProfiles/page.mdx)
|
||
- [listAndCountFulfillments](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountFulfillments/page.mdx)
|
||
- [listAndCountFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountFulfillmentSets/page.mdx)
|
||
- [listAndCountGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountGeoZones/page.mdx)
|
||
- [listAndCountServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountServiceZones/page.mdx)
|
||
- [listAndCountShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptionRules/page.mdx)
|
||
- [listAndCountShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptions/page.mdx)
|
||
- [listAndCountShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptionTypes/page.mdx)
|
||
- [listAndCountShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingProfiles/page.mdx)
|
||
- [listFulfillmentProviders](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillmentProviders/page.mdx)
|
||
- [listFulfillments](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillments/page.mdx)
|
||
- [listFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillmentSets/page.mdx)
|
||
- [listGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listGeoZones/page.mdx)
|
||
- [listServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listServiceZones/page.mdx)
|
||
- [listShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionRules/page.mdx)
|
||
- [listShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptions/page.mdx)
|
||
- [listShippingOptionsForContext](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionsForContext/page.mdx)
|
||
- [listShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionTypes/page.mdx)
|
||
- [listShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingProfiles/page.mdx)
|
||
- [restoreFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreFulfillmentSets/page.mdx)
|
||
- [restoreGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreGeoZones/page.mdx)
|
||
- [restoreServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreServiceZones/page.mdx)
|
||
- [restoreShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingOptions/page.mdx)
|
||
- [restoreShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingOptionTypes/page.mdx)
|
||
- [restoreShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingProfiles/page.mdx)
|
||
- [retrieveFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillment/page.mdx)
|
||
- [retrieveFulfillmentOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillmentOptions/page.mdx)
|
||
- [retrieveFulfillmentSet](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillmentSet/page.mdx)
|
||
- [retrieveGeoZone](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveGeoZone/page.mdx)
|
||
- [retrieveServiceZone](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveServiceZone/page.mdx)
|
||
- [retrieveShippingOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOption/page.mdx)
|
||
- [retrieveShippingOptionRule](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOptionRule/page.mdx)
|
||
- [retrieveShippingOptionType](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOptionType/page.mdx)
|
||
- [retrieveShippingProfile](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingProfile/page.mdx)
|
||
- [softDeleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteFulfillmentSets/page.mdx)
|
||
- [softDeleteGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteGeoZones/page.mdx)
|
||
- [softDeleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteServiceZones/page.mdx)
|
||
- [softDeleteShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingOptions/page.mdx)
|
||
- [softDeleteShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingOptionTypes/page.mdx)
|
||
- [softDeleteShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingProfiles/page.mdx)
|
||
- [updateFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateFulfillment/page.mdx)
|
||
- [updateFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateFulfillmentSets/page.mdx)
|
||
- [updateGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateGeoZones/page.mdx)
|
||
- [updateServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateServiceZones/page.mdx)
|
||
- [updateShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptionRules/page.mdx)
|
||
- [updateShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptions/page.mdx)
|
||
- [updateShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptionTypes/page.mdx)
|
||
- [updateShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingProfiles/page.mdx)
|
||
- [upsertServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertServiceZones/page.mdx)
|
||
- [upsertShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingOptions/page.mdx)
|
||
- [upsertShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingOptionTypes/page.mdx)
|
||
- [upsertShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingProfiles/page.mdx)
|
||
- [validateFulfillmentData](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentData/page.mdx)
|
||
- [validateFulfillmentOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentOption/page.mdx)
|
||
- [validateShippingOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOption/page.mdx)
|
||
- [validateShippingOptionsForPriceCalculation](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOptionsForPriceCalculation/page.mdx)
|