Créer et mettre à jour des régions

Dans l'API Merchant, vous pouvez utiliser des régions géographiques comme cibles pour les services liés à la ressource accounts.products.regionalInventories. Vous pouvez définir des régions comme des ensembles de codes postaux ou, dans certains pays, à l'aide de cibles géographiques prédéfinies. Pour en savoir plus, consultez Configurer des régions.

Pour créer et mettre à jour des régions, vous pouvez utiliser les méthodes suivantes :

• Get
• List
• Create
• Patch
• Delete

Récupérer une région

Pour récupérer une région définie dans votre compte Merchant Center, utilisez la méthode accounts.regions.get.

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

HTTP/1.1 200

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

Lister toutes les régions

Pour lister les régions de votre compte Merchant Center, utilisez la méthode accounts.regions.list.

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

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

Insérer une région

Pour insérer une définition de région dans votre compte Merchant Center, utilisez la méthode accounts.regions.create. L'exécution de cette méthode nécessite un accès administrateur.

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

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

Pour créer une région avec AreaCode :

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

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

Pour mettre à jour displayName et GeoTargetCriteriaIds pour la région créée :

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

HTTP/1.1 200

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

Modifier une région

Pour modifier la définition d'une région dans votre compte Merchant Center, utilisez la méthode accounts.regions.patch. L'exécution de cette méthode nécessite un accès administrateur.

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

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

Supprimer une région

Pour supprimer une définition de région de votre compte Merchant Center, utilisez la méthode accounts.regions.delete. L'exécution de cette méthode nécessite un accès administrateur.

Voici un exemple de requête :

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

Voici un exemple de réponse à un appel réussi :

HTTP/1.1 200
{}

Opérations par lot

Si vous gérez plusieurs régions, l'API Merchant fournit des points de terminaison par lot qui vous permettent de créer, de mettre à jour et de supprimer jusqu'à 100 régions en un seul appel. Pour en savoir plus, consultez Gérer le traitement par lot des régions.