upsertRegions - Region Module Reference

This documentation provides a reference to the upsertRegions method. This belongs to the Region Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

upsertRegions(data, sharedContext?): Promise<RegionDTO[]>#

This method updates or creates regions if they don't exist.

Example#

Code
1const region = await regionModuleService.upsertRegions([2  {3    id: "reg_123",4    automatic_taxes: false,5  },6  {7    name: "Europe",8    currency_code: "eur",9  },10])

Parameters#

dataUpsertRegionDTO[]

The attributes in the regions to be created or updated.

sharedContextContextOptional

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

Returns#

PromisePromise<RegionDTO[]>

The created or updated regions.

upsertRegions(data, sharedContext?): Promise<RegionDTO>#

This method updates or creates a region if it doesn't exist.

Example#

Code
1const region = await regionModuleService.upsertRegions({2  id: "reg_123",3  automatic_taxes: false,4})

Parameters#

dataUpsertRegionDTO

The attributes in the region to be created or updated.

sharedContextContextOptional

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

Returns#

PromisePromise<RegionDTO>

The created or updated region.

Was this page helpful?