Crea y actualiza regiones

En la API de Merchant, puedes usar regiones geográficas como objetivos para los servicios relacionados con el accounts.products.regionalInventories recurso. Puedes definir regiones como colecciones de códigos postales o, en algunos países, con segmentaciones geográficas predefinidas. Para obtener más información, consulta Cómo configurar regiones.

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

Cómo recuperar una región

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

A continuación, se muestra una solicitud de ejemplo:

GET https://merchantapi.googleapis.com/accounts/v1/accounts/125222396/regions/234567

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 accounts.regions.list método.

A continuación, se muestra una solicitud de ejemplo:

GET https://merchantapi.googleapis.com/accounts/v1/accounts/125222396/regions?pageSize=100

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 accounts.regions.create método. La ejecución de este método requiere acceso de administrador.

A continuación, se muestra una solicitud de ejemplo:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions?regionId=987654

{
  "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, haz lo siguiente:

A continuación, se muestra una solicitud de ejemplo:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions?regionId=168888 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 el displayName y los GeoTargetCriteriaIds de la región creada, haz lo siguiente:

A continuación, se muestra una solicitud de ejemplo:

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea 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 una definición de región en tu cuenta de Merchant Center, usa el accounts.regions.patch método. La ejecución de este método requiere acceso de administrador.

A continuación, se muestra una solicitud de ejemplo:

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/987654?updateMask=displayName%2CpostalCodeArea 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 accounts.regions.delete método. La ejecución de este método requiere acceso de administrador.

A continuación, se muestra una solicitud de ejemplo:

DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/987654 HTTP/1.1

Esta es una respuesta de ejemplo de una llamada correcta:

HTTP/1.1 200
{}

Operaciones por lotes

Si administras varias regiones, la API de Merchant proporciona extremos por lotes que te permiten crear, actualizar y borrar hasta 100 regiones en una sola llamada. Para obtener más información, consulta Cómo administrar el procesamiento por lotes de regiones.

Anterior
Manage Terms of Service
Siguiente
Manage region batching