REST Resource: accounts.regions

Recurso: Region

Representa una región geográfica que puedes usar como destino con los servicios RegionalInventory y ShippingSettings. Puedes definir regiones como colecciones de códigos postales o, en algunos países, mediante segmentaciones geográficas predefinidas. Si quieres obtener más detalles, consulta Configura regiones .

Representación JSON
{
  "name": string,
  "postalCodeArea": {
    object (PostalCodeArea)
  },
  "geotargetArea": {
    object (GeoTargetArea)
  },
  "regionalInventoryEligible": boolean,
  "shippingEligible": boolean,
  "displayName": string
}
Campos
name

string

Identificador. El nombre del recurso de la región. Formato: accounts/{account}/regions/{region}

postalCodeArea

object (PostalCodeArea)

Opcional. Es una lista de códigos postales que define el área de la región.

geotargetArea

object (GeoTargetArea)

Opcional. Una lista de orientaciones geográficas que define el área de la región.

regionalInventoryEligible

boolean

Solo salida. Indica si la región es apta para usarse en la configuración del inventario regional.

shippingEligible

boolean

Solo salida. Indica si la región es apta para su uso en la configuración de los servicios de envío.

displayName

string

Opcional. Es el nombre visible de la región.

PostalCodeArea

Es una lista de códigos postales que define el área de la región. Nota: Se puede acceder a todas las regiones definidas con códigos postales a través del recurso ShippingSettings.postalCodeGroups de la cuenta.

Representación JSON
{
  "regionCode": string,
  "postalCodes": [
    {
      object (PostalCodeRange)
    }
  ]
}
Campos
regionCode

string

Obligatorio. Es el código de territorio de CLDR o el país al que se aplica el grupo de códigos postales.

postalCodes[]

object (PostalCodeRange)

Obligatorio. Un intervalo de códigos postales.

PostalCodeRange

Un intervalo de códigos postales que define el área de la región.

Representación JSON
{
  "begin": string,
  "end": string
}
Campos
begin

string

Obligatorio. Un código postal o un patrón con el prefijo de formulario* que denota el límite inferior inclusivo del rango que define el área. Valores de ejemplo: 94108, 9410*, 9*.

end

string

Opcional. Un código postal o un patrón con el formato prefix* que denota el límite superior inclusivo del rango que define el área. Debe tener la misma longitud que postalCodeRangeBegin: si postalCodeRangeBegin es un código postal, entonces postalCodeRangeEnd también debe ser un código postal. si postalCodeRangeBegin es un patrón, entonces postalCodeRangeEnd debe ser un patrón con la misma longitud de prefijo. Opcional: Si no se establece, el área se define como todos los códigos postales que coinciden con postalCodeRangeBegin.

GeoTargetArea

Una lista de orientaciones geográficas que define el área de la región.

Representación JSON
{
  "geotargetCriteriaIds": [
    string
  ]
}
Campos
geotargetCriteriaIds[]

string (int64 format)

Obligatorio. Una lista no vacía de IDs de ubicación. Todas deben ser del mismo tipo de ubicación (por ejemplo, un estado).

Métodos

create

Crea una definición de región en tu cuenta de Merchant Center.

delete

Borra una definición de región de tu cuenta de Merchant Center.

get

Recupera una región definida en su cuenta de Merchant Center.

list

Muestra una lista de las regiones en tu cuenta de Merchant Center.

patch

Actualiza una definición de región en tu cuenta de Merchant Center.