REST Resource: accounts.regions

    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, radius areas or, in some countries, using predefined geotargets.

    A region must be defined by specifying exactly one of postalCodeArea , geotargetArea , or radiusArea .

    For more information, see Set up regions for more information.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "postalCodeArea" 
 : 
 { 
 object (  PostalCodeArea 
 
) 
 } 
 , 
 "geotargetArea" 
 : 
 { 
 object (  GeoTargetArea 
 
) 
 } 
 , 
 "regionalInventoryEligible" 
 : 
 boolean 
 , 
 "shippingEligible" 
 : 
 boolean 
 , 
 "radiusArea" 
 : 
 { 
 object (  RadiusArea 
 
) 
 } 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. The resource name of the region. Format: accounts/{account}/regions/{region}

    postalCodeArea

    object ( PostalCodeArea )

    Optional. A list of postal codes that defines the region area.
    geotargetArea

    object ( GeoTargetArea )

    Optional. A list of geotargets that defines the region area.
    regionalInventoryEligible

    boolean

    Output only. Indicates if the region is eligible for use in the Regional Inventory configuration.
    shippingEligible

    boolean

    Output only. Indicates if the region is eligible for use in the Shipping Services configuration.
    radiusArea

    object ( RadiusArea )

    Optional. A radius area that defines the region area.
    displayName

    string

    Optional. The display name of the region.

    PostalCodeArea

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

    JSON representation 
     { 
 "regionCode" 
 : 
 string 
 , 
 "postalCodes" 
 : 
 [ 
 { 
 object (  PostalCodeRange 
 
) 
 } 
 ] 
 }
    Fields
    regionCode

    string

    Required. CLDR territory code or the country the postal code group applies to.
    postalCodes[]

    object ( 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 ( int64 format)

    Required. A non-empty list of location IDs . They must all be of the same location type (for example, state).

    RadiusArea

    A radius area that defines the region area.

    JSON representation 
     { 
 "regionCode" 
 : 
 string 
 , 
 "latLng" 
 : 
 { 
 object (  LatLng 
 
) 
 } 
 , 
 "radius" 
 : 
 number 
 , 
 "radiusUnits" 
 : 
 enum (  RadiusUnits 
 
) 
 }
    Fields
    regionCode

    string

    Required. CLDR territory code or the country the radius area applies to.
    latLng

    object ( LatLng )

    Required. The center of the radius area. It represents a latitude/longitude pair in decimal degrees format.
    radius

    number

    Required. The radius distance of the area.
    radiusUnits

    enum ( RadiusUnits )

    Optional. The unit of the radius.

    RadiusUnits

    The unit of measurement of the radius. Default is KILOMETERS.

    Enums
    RADIUS_UNITS_UNSPECIFIED Unused default value
    MILES The distance is measured in miles.
    KILOMETERS The distance is measured in kilometers.

    Methods

    batchCreate

    		Creates one or more regions in your Merchant Center account.

    batchDelete

    		Deletes multiple regions by name from your Merchant Center account.

    batchUpdate

    		Updates one or more regions in your Merchant Center account.

    create

    		Creates a region definition in your Merchant Center account.

    delete

    		Deletes a region definition from your Merchant Center account.

    get

    		Retrieves a region defined in your Merchant Center account.

    list

    		Lists the regions in your Merchant Center account.

    patch

    		Updates a region definition in your Merchant Center account.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: