listGeoZones - Fulfillment Module Reference

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

This method retrieves a paginated list of geo zones based on optional filters and configuration.

Example

To retrieve a list of geo zones using their IDs:

const geoZones = await fulfillmentModuleService.listGeoZones({
  id: ["fgz_123", "fgz_321"],
})

To specify relations that should be retrieved within the geo zone:

const geoZones = await fulfillmentModuleService.listGeoZones(
  {
    id: ["fgz_123", "fgz_321"],
  },
  {
    relations: ["service_zone"],
  }
)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const geoZones = await fulfillmentModuleService.listGeoZones(
  {
    id: ["fgz_123", "fgz_321"],
  },
  {
    relations: ["service_zone"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableGeoZoneProps

The filters to apply on the retrieved geo zones.

configFindConfig<GeoZoneDTO>

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

sharedContextContext

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

Returns

PromisePromise<GeoZoneDTO[]>Required

The list of geo zones.