יצירה ועדכון של אזורים

ב-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
{}

פעולות אצווה

אם אתם מנהלים כמה אזורים, Merchant API מספק נקודות קצה של אצווה שמאפשרות לכם ליצור, לעדכן ולמחוק עד 100 אזורים בקריאה אחת. מידע נוסף זמין במאמר בנושא ניהול של עיבוד באצווה לפי אזור.