# REST Resource: regions

- [Resource: Region](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#Region)
  - [JSON representation](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#Region.SCHEMA_REPRESENTATION)
- [PostalCodeArea](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeArea)
  - [JSON representation](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeArea.SCHEMA_REPRESENTATION)
- [PostalCodeRange](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeRange)
  - [JSON representation](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeRange.SCHEMA_REPRESENTATION)
- [GeoTargetArea](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#GeoTargetArea)
  - [JSON representation](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#GeoTargetArea.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/shopping-content/reference/rest/v2.1/regions#METHODS_SUMMARY)

## Resource: Region

Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.

| JSON representation |
|---|
| ``` { "regionId": string, "merchantId": string, "displayName": string, "postalCodeArea": { object (`https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeArea`) }, "geotargetArea": { object (`https://developers.google.com/shopping-content/reference/rest/v2.1/regions#GeoTargetArea`) }, "regionalInventoryEligible": boolean, "shippingEligible": boolean } ``` |

| Fields ||
|---|---|
| `regionId` | `string` Output only. Immutable. The ID uniquely identifying each region. |
| `merchantId` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Immutable. Merchant that owns the region. |
| `displayName` | `string` The display name of the region. |
| `postalCodeArea` | ``object (`https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeArea`)`` A list of postal codes that defines the region area. |
| `geotargetArea` | ``object (`https://developers.google.com/shopping-content/reference/rest/v2.1/regions#GeoTargetArea`)`` A list of geotargets that defines the region area. |
| `regionalInventoryEligible` | `boolean` Output only. Indicates if the region is eligible to use in the Regional pos.inventory configuration. |
| `shippingEligible` | `boolean` Output only. Indicates if the region is eligible to use in the Shipping Services configuration. |

## PostalCodeArea

A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.

| JSON representation |
|---|
| ``` { "regionCode": string, "postalCodes": [ { object (`https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeRange`) } ] } ``` |

| Fields ||
|---|---|
| `regionCode` | `string` Required. CLDR territory code or the country the postal code group applies to. |
| `postalCodes[]` | ``object (`https://developers.google.com/shopping-content/reference/rest/v2.1/regions#PostalCodeRange`)`` Required. A range of postal codes. |

## PostalCodeRange

A range of postal codes that defines the region area.

| JSON representation |
|---|
| ``` { "begin": string, "end": string } ``` |

| Fields ||
|---|---|
| `begin` | `string` Required. A postal code or a pattern of the form prefix\* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410\*", "9\*". |
| `end` | `string` Optional. A postal code or a pattern of the form prefix\* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. |

## GeoTargetArea

A list of geotargets that defines the region area.

| JSON representation |
|---|
| ``` { "geotargetCriteriaIds": [ string ] } ``` |

| Fields ||
|---|---|
| `geotargetCriteriaIds[]` | `string (https://developers.google.com/discovery/v1/type-format format)` Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state). |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/shopping-content/reference/rest/v2.1/regions/create` | Creates a region definition in your Merchant Center account. |
| ### `https://developers.google.com/shopping-content/reference/rest/v2.1/regions/delete` | Deletes a region definition from your Merchant Center account. |
| ### `https://developers.google.com/shopping-content/reference/rest/v2.1/regions/get` | Retrieves a region defined in your Merchant Center account. |
| ### `https://developers.google.com/shopping-content/reference/rest/v2.1/regions/list` | Lists the regions in your Merchant Center account. |
| ### `https://developers.google.com/shopping-content/reference/rest/v2.1/regions/patch` | Updates a region definition in your Merchant Center account. |