Criar e atualizar regiões

Na API Merchant, é possível usar regiões geográficas como destinos para serviços relacionados ao accounts.products.regionalInventories recurso. Você pode definir regiões como coleções de CEPs ou, em alguns países, usando geotargets predefinidos. Para mais informações, consulte Configurar regiões.

Para criar e atualizar regiões, use os seguintes métodos:

Recuperar uma região

Para recuperar uma região definida na sua conta do Merchant Center, use o accounts.regions.get método.

Confira um exemplo de solicitação:

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

Confira um exemplo de resposta de uma chamada bem-sucedida:

HTTP/1.1 200

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

Listar todas as regiões

Para listar as regiões na sua conta do Merchant Center, use o accounts.regions.list método.

Confira um exemplo de solicitação:

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

Confira um exemplo de resposta de uma chamada bem-sucedida:

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
    },
  ]
}

Inserir uma região

Para inserir uma definição de região na sua conta do Merchant Center, use o accounts.regions.create método. A execução desse método requer acesso de administrador.

Confira um exemplo de solicitação:

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

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

Confira um exemplo de resposta de uma chamada bem-sucedida:

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

Para criar uma região com AreaCode:

Confira um exemplo de solicitação:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions?regionId=168888 HTTP/1.1

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

Confira um exemplo de resposta de uma chamada bem-sucedida:

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

Para atualizar o displayName e os GeoTargetCriteriaIds da região criada:

Confira um exemplo de solicitação:

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea HTTP/1.1

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

Confira um exemplo de resposta de uma chamada bem-sucedida:

HTTP/1.1 200

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

Atualizar uma região

Para atualizar uma definição de região na sua conta do Merchant Center, use o accounts.regions.patch método. A execução desse método requer acesso de administrador.

Confira um exemplo de solicitação:

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"
  }
}

Confira um exemplo de resposta de uma chamada bem-sucedida:

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

Excluir uma região

Para excluir uma definição de região da sua conta do Merchant Center, use o accounts.regions.delete método. A execução desse método requer acesso de administrador.

Confira um exemplo de solicitação:

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

Confira um exemplo de resposta de uma chamada bem-sucedida:

HTTP/1.1 200
{}

Operações em lote

Se você estiver gerenciando várias regiões, a API Merchant vai fornecer endpoints em lote que permitem criar, atualizar e excluir até 100 regiões em uma única chamada. Para mais informações, consulte Gerenciar lotes de regiões.

Anterior
Manage Terms of Service
Avançar
Manage region batching