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 ( |
Fields | |
---|---|
regionId |
Output only. Immutable. The ID uniquely identifying each region. |
merchantId |
Output only. Immutable. Merchant that owns the region. |
displayName |
The display name of the region. |
postalCodeArea |
A list of postal codes that defines the region area. |
geotargetArea |
A list of geotargets that defines the region area. |
regionalInventoryEligible |
Output only. Indicates if the region is eligible to use in the Regional pos.inventory configuration. |
shippingEligible |
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 ( |
Fields | |
---|---|
regionCode |
Required. CLDR territory code or the country the postal code group applies to. |
postalCodes[] |
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 |
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 |
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[] |
Required. A non-empty list of location IDs. They must all be of the same location type (e.g., state). |
Methods |
|
---|---|
|
Creates a region definition in your Merchant Center account. |
|
Deletes a region definition from your Merchant Center account. |
|
Retrieves a region defined in your Merchant Center account. |
|
Lists the regions in your Merchant Center account. |
|
Updates a region definition in your Merchant Center account. |