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

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

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

• Get
• List
• Create
• Patch
• Delete

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

Чтобы получить регион, определенный в вашей учетной записи 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
{}

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

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