ایجاد و به روز رسانی مناطق

در رابط برنامه‌نویسی کاربردی فروشنده (Merchant API) می‌توانید از مناطق جغرافیایی به عنوان هدف برای سرویس‌های مرتبط با منبع accounts.products.regionalInventories استفاده کنید. می‌توانید مناطق را به عنوان مجموعه‌ای از کدهای پستی یا در برخی کشورها با استفاده از اهداف جغرافیایی از پیش تعریف شده تعریف کنید. برای اطلاعات بیشتر، به بخش «تنظیم مناطق» مراجعه کنید.

برای ایجاد و به‌روزرسانی مناطق، می‌توانید از روش‌های زیر استفاده کنید:

• Get
• List
• Create
• Patch
• Delete

بازیابی یک منطقه

برای بازیابی منطقه‌ای که در حساب مرکز بازرگانان شما تعریف شده است، از متد 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"
      }
    ]
  }

فهرست همه مناطق

برای فهرست کردن مناطق در حساب مرکز بازرگانان خود، از متد 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
    },
  ]
}

درج منطقه

برای درج تعریف منطقه در حساب مرکز فروشندگان خود، از متد 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
}

به‌روزرسانی یک منطقه

برای به‌روزرسانی تعریف منطقه در حساب مرکز فروشندگان خود، از متد 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
}

حذف یک منطقه

برای حذف تعریف منطقه از حساب مرکز فروشندگان خود، از متد 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 نقاط پایانی دسته‌ای را ارائه می‌دهد که به شما امکان می‌دهد تا ۱۰۰ منطقه را در یک فراخوانی واحد ایجاد، به‌روزرسانی و حذف کنید. برای اطلاعات بیشتر، به مدیریت دسته‌ای منطقه مراجعه کنید.