retrieve - Fulfillment Module Reference

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

This method retrieves a fulfillment set by its ID.

Example

A simple example that retrieves a fulfillment set by its ID:

const fulfillmentSet = await fulfillmentModuleService.retrieve("fuset_123")

To specify relations that should be retrieved:

const fulfillmentSet = await fulfillmentModuleService.retrieve("fuset_123", {
  relations: ["service_zones"],
})

Parameters

idstringRequired

The ID of the fulfillment set.

configFindConfig<FulfillmentSetDTO>

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

sharedContextContext

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

Returns

PromisePromise<FulfillmentSetDTO>Required

The retrieved fulfillment set.