Crea y actualiza regiones

Esta guía representa una región geográfica que puedes usar como objetivo para un servicio relacionado con el recurso accounts.products.regionalInventories. Puedes definir las regiones como colecciones de códigos postales o, en algunos países, con geosegmentaciones predefinidas. Para obtener más información, consulta Cómo configurar regiones.

Para crear y actualizar regiones, puedes usar los siguientes métodos:

• Get
• List
• Create
• Patch
• Delete

Cómo recuperar una región

Para recuperar una región definida en tu cuenta de Merchant Center, usa el método accounts.regions.get.

Esta es una solicitud de ejemplo:

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/125222396/regions/234567?key=[YOUR_API_KEY]

Esta es una respuesta de ejemplo de una llamada correcta:

HTTP/1.1 200

{
  "name": "accounts/125222396/regions/234567",
  "displayName": "Canada",
  "postalCodeArea": {
    "regionCode": "CA",
    "postalCodes": [
      {
        "begin": "L6A"
      }
    ]
  }

Cómo enumerar todas las regiones

Para enumerar las regiones de tu cuenta de Merchant Center, usa el método accounts.regions.list.

Esta es una solicitud de ejemplo:

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/125222396/regions?pageSize=100&key=[YOUR_API_KEY]

Esta es una respuesta de ejemplo de una llamada correcta:

HTTP/1.1 200

{
  "regions": [
    {
      "name": "accounts/125222396/regions/234567",
      "displayName": "Canada",
      "postalCodeArea": {
        "regionCode": "CA",
        "postalCodes": [
          {
            "begin": "L6A"
          }
        ]
      },
      "regionalInventoryEligible": true,
      "shippingEligible": true
    },
    {
      "name": "accounts/125222396/regions/Inline region",
      "displayName": "Inline region",
      "postalCodeArea": {
        "regionCode": "CA",
        "postalCodes": [
          {
            "begin": "M7B"
          }
        ]
      },
      "regionalInventoryEligible": false,
      "shippingEligible": true
    },
  ]
}

Cómo insertar una región

Para insertar una definición de región en tu cuenta de Merchant Center, usa el método accounts.regions.create. Para ejecutar este método, se requiere acceso de administrador.

Esta es una solicitud de ejemplo:

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions?regionId=987654&key=[YOUR_API_KEY]

{
  "displayName": "TestRegion",
  "name": "987654",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98109"
      }
    ],
    "regionCode": "US"
  }
}

Esta es una respuesta de ejemplo de una llamada correcta:

{
     "name": "accounts/102959835/regions/987654",
  "displayName": "TestRegion",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "begin": "98109"
      }
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": true
}

Para crear una región nueva con AreaCode, sigue estos pasos:

Esta es una solicitud de ejemplo:

POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions?regionId=168888&key=[YOUR_API_KEY] HTTP/1.1

{
  "displayName": "WA_test",
  "name": "168888",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      20101
    ]
  }
}

Esta es una respuesta de ejemplo de una llamada correcta:

{
  "name": "accounts/102959835/regions/168888",
  "displayName": "WA_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      "20101"
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": false
}

Para actualizar displayName y GeoTargetCriteriaIds de la región creada, haz lo siguiente:

Esta es una solicitud de ejemplo:

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea&key=[YOUR_API_KEY] HTTP/1.1

{
  "displayName": "BR_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      20100
    ]
  }
}

Esta es una respuesta de ejemplo de una llamada correcta:

HTTP/1.1 200

{
  "name": "accounts/102959835/regions/168888",
  "displayName": "BR_test",
  "geotargetArea": {
    "geotargetCriteriaIds": [
      "20100"
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": false
}

Cómo actualizar una región

Para actualizar la definición de una región en tu cuenta de Merchant Center, usa el método accounts.regions.patch. Para ejecutar este método, se requiere acceso de administrador.

Esta es una solicitud de ejemplo:

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/987654?updateMask=displayName%2CpostalCodeArea&key=[YOUR_API_KEY] HTTP/1.1

Authorization: Bearer [YOUR_ACCESS_TOKEN]
Accept: application/json
Content-Type: application/json

{
  "displayName": "Test",
  "postalCodeArea": {
    "postalCodes": [
      {
        "begin": "98108"
      }
    ],
    "regionCode": "US"
  }
}

Esta es una respuesta de ejemplo de una llamada correcta:

{
  "name": "accounts/102959835/regions/987654",
  "displayName": "Test",
  "postalCodeArea": {
    "regionCode": "US",
    "postalCodes": [
      {
        "begin": "98108"
      }
    ]
  },
  "regionalInventoryEligible": true,
  "shippingEligible": true
}

Cómo borrar una región

Para borrar una definición de región de tu cuenta de Merchant Center, usa el método accounts.regions.delete. Para ejecutar este método, se requiere acceso de administrador.

Esta es una solicitud de ejemplo:

DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/102959835/regions/987654?key=[YOUR_API_KEY] HTTP/1.1

Esta es una respuesta de ejemplo de una llamada correcta:

HTTP/1.1 200
{}