retrieveServiceZone - Fulfillment Module Reference

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

This method retrieves a service zone by its ID.

Example

A simple example that retrieves a service zone by its ID:

const serviceZone =
  await fulfillmentModuleService.retrieveServiceZone(
    "serzo_123"
  )

To specify relations that should be retrieved:

const serviceZone =
  await fulfillmentModuleService.retrieveServiceZone(
    "serzo_123",
    {
      relations: ["shipping_options"],
    }
  )

Parameters

idstringRequired

The ID of the service zone.

configFindConfig<ServiceZoneDTO>

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

sharedContextContext

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

Returns

PromisePromise<ServiceZoneDTO>Required

The retrieved service zone.