Как создавать и обновлять регионы

В Merchant API можно использовать географические регионы в качестве целей для сервисов, связанных с ресурсом accounts.products.regionalInventories. Регионы можно задавать как наборы почтовых индексов или, в некоторых странах, с помощью предопределенных геоцелей. Подробнее о том, как настроить регионы…

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

Как получить регион

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

Пример запроса:

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

Ниже приведен пример ответа на успешный вызов.

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

Ниже приведен пример ответа на успешный вызов.

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

{
  "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 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 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 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 HTTP/1.1

Ниже приведен пример ответа на успешный вызов.

HTTP/1.1 200
{}

Массовые операции

Если вы управляете несколькими регионами, Merchant API предоставляет пакетные конечные точки, которые позволяют создавать, обновлять и удалять до 100 регионов за один вызов. Подробнее об управлении пакетной обработкой регионов…

Далее
Manage region batching