Creare e aggiornare le regioni

Questa guida rappresenta una regione geografica che puoi utilizzare come destinazione per un servizio correlato alla risorsa accounts.products.regionalInventories. Puoi definire le regioni come raccolte di codici postali o, in alcuni paesi, utilizzando i geotarget predefiniti. Per ulteriori informazioni, consulta Configurare le regioni.

Per creare e aggiornare le regioni, puoi utilizzare i seguenti metodi:

• Get
• List
• Create
• Patch
• Delete

Recuperare una regione

Per recuperare una regione definita nel tuo account Merchant Center, utilizza il metodo accounts.regions.get.

Ecco una richiesta di esempio:

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

HTTP/1.1 200

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

Elenca tutte le regioni

Per elencare le regioni nel tuo account Merchant Center, utilizza il metodo accounts.regions.list.

Ecco una richiesta di esempio:

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

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

Inserire una regione

Per inserire una definizione di regione nel tuo account Merchant Center, utilizza il metodo accounts.regions.create. L'esecuzione di questo metodo richiede l'accesso amministrativo.

Ecco una richiesta di esempio:

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

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

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

Per creare una nuova regione con AreaCode:

Ecco una richiesta di esempio:

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

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

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

Per aggiornare displayName e GeoTargetCriteriaIds per la regione creata:

Ecco una richiesta di esempio:

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

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

HTTP/1.1 200

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

Aggiornare una regione

Per aggiornare una definizione di regione nel tuo account Merchant Center, utilizza il metodo accounts.regions.patch. L'esecuzione di questo metodo richiede l'accesso amministrativo.

Ecco una richiesta di esempio:

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

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

Eliminare una regione

Per eliminare una definizione di regione dal tuo account Merchant Center, utilizza il metodo accounts.regions.delete. L'esecuzione di questo metodo richiede l'accesso amministrativo.

Ecco una richiesta di esempio:

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

Ecco un esempio di risposta di una chiamata andata a buon fine:

HTTP/1.1 200
{}