Regionen erstellen und aktualisieren

In der Merchant API können Sie geografische Regionen als Ziele für Dienste verwenden, die mit der Ressource accounts.products.regionalInventories zusammenhängen. Sie können Regionen als Sammlungen von Postleitzahlen oder in einigen Ländern mithilfe vordefinierter geografischer Ausrichtungen definieren. Weitere Informationen finden Sie unter Regionen einrichten.

Sie haben folgende Möglichkeiten, Regionen zu erstellen und zu aktualisieren:

• Get
• List
• Create
• Patch
• Delete

Region abrufen

Verwenden Sie die Methode accounts.regions.get, um eine in Ihrem Merchant Center-Konto definierte Region abzurufen.

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

HTTP/1.1 200

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

Alle Regionen auflisten

Verwenden Sie die Methode accounts.regions.list, um die Regionen in Ihrem Merchant Center-Konto aufzulisten.

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

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

Region einfügen

Verwenden Sie die Methode accounts.regions.create, um eine Regionsdefinition in Ihr Merchant Center-Konto einzufügen. Für diese Methode ist Administratorzugriff erforderlich.

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

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

So erstellen Sie eine neue Region mit AreaCode:

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

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

So aktualisieren Sie die displayName und GeoTargetCriteriaIds für die erstellte Region:

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

HTTP/1.1 200

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

Region aktualisieren

Mit der Methode accounts.regions.patch können Sie eine Regionsdefinition in Ihrem Merchant Center-Konto aktualisieren. Für diese Methode ist Administratorzugriff erforderlich.

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

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

Region löschen

Verwenden Sie zum Löschen einer Regionsdefinition aus Ihrem Merchant Center-Konto die Methode accounts.regions.delete. Für diese Methode ist Administratorzugriff erforderlich.

Hier ein Beispiel für eine Anfrage:

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

Hier ist eine Beispielantwort für einen erfolgreichen Aufruf:

HTTP/1.1 200
{}

Batchvorgänge

Wenn Sie mehrere Regionen verwalten, bietet die Merchant API Batch-Endpunkte, mit denen Sie bis zu 100 Regionen in einem einzigen Aufruf erstellen, aktualisieren und löschen können. Weitere Informationen finden Sie unter Regionen-Batching verwalten.