retrieveFulfillment - Fulfillment Module Reference

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

This method retrieves a fulfillment by its ID.

Example

A simple example that retrieves a fulfillment by its ID:

const fulfillment =
  await fulfillmentModuleService.retrieveFulfillment(
    "ful_123"
  )

To specify relations that should be retrieved:

const fulfillment =
  await fulfillmentModuleService.retrieveFulfillment(
    "ful_123",
    {
      relations: ["shipping_option"],
    }
  )

Parameters

idstringRequired

The ID of the fulfillment.

configFindConfig<FulfillmentDTO>

The configurations determining how the fulfillment is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a fulfillment.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<FulfillmentDTO>Required

The retrieved fulfillment.