Создание и обновление регионов

В Merchant API вы можете использовать географические регионы в качестве целевых объектов для сервисов, связанных с ресурсом accounts.products.regionalInventories . Вы можете определить регионы как наборы почтовых индексов или, в некоторых странах, используя предопределенные геолокационные целевые объекты. Для получения дополнительной информации см. раздел «Настройка регионов» .

Для создания и обновления регионов можно использовать следующие методы:

Получить регион

Чтобы получить информацию о регионе, определенном в вашем аккаунте Merchant Center, используйте метод accounts.regions.get .

Вот пример запроса:

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

Вот пример ответа после успешного звонка:

HTTP/1.1 200

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

Перечислите все регионы

Чтобы отобразить список регионов в вашем аккаунте Merchant Center, используйте метод accounts.regions.list .

Вот пример запроса:

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

Вот пример ответа после успешного звонка:

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

Вставить область

Для добавления определения региона в вашу учетную запись Merchant Center используйте метод accounts.regions.create . Для выполнения этого метода требуются права администратора.

Вот пример запроса:

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

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

Вот пример ответа после успешного звонка:

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

Для создания нового региона с использованием AreaCode :

Вот пример запроса:

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

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

Вот пример ответа после успешного звонка: 

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

Чтобы обновить значения displayName и GeoTargetCriteriaIds для созданного региона:

Вот пример запроса: 

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

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

Вот пример ответа после успешного звонка: 

HTTP/1.1 200

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

Обновить регион

Для обновления определения региона в вашем аккаунте Merchant Center используйте метод accounts.regions.patch . Для выполнения этого метода требуются права администратора.

Вот пример запроса: 

PATCH https://merchantapi.googleapis.com/accounts/v1/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"
  }
}

Вот пример ответа после успешного звонка: 

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

Удалить регион

Для удаления определения региона из вашей учетной записи Merchant Center используйте метод accounts.regions.delete . Для выполнения этого метода требуются права администратора.

Вот пример запроса: 

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

Вот пример ответа после успешного звонка: 

HTTP/1.1 200
{}

Пакетные операции

Если вы управляете несколькими регионами, Merchant API предоставляет пакетные конечные точки, позволяющие создавать, обновлять и удалять до 100 регионов за один вызов. Для получения дополнительной информации см. раздел «Управление пакетной обработкой регионов» .

Назад
Manage Merchant Center email notifications
Далее
Manage region batching