retrieveGeoZone - Fulfillment Module Reference

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

This method retrieves a geo zone by its ID.

Example

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

const geoZone =
  await fulfillmentModuleService.retrieveGeoZone("fgz_123")

To specify relations that should be retrieved:

const geoZone =
  await fulfillmentModuleService.retrieveGeoZone("fgz_123", {
    relations: ["service_zone"],
  })

Parameters

idstringRequired

The ID of the geo zone.

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 retrieved geo zone.