สร้างและอัปเดตภูมิภาค

ใน 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

ตัวอย่างการตอบกลับจากการเรียกใช้ที่สำเร็จมีดังนี้

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

ตัวอย่างการตอบกลับจากการเรียกใช้ที่สำเร็จมีดังนี้

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

{
  "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 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 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 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 HTTP/1.1

ตัวอย่างการตอบกลับจากการเรียกใช้ที่สำเร็จมีดังนี้

HTTP/1.1 200
{}

การทำงานเป็นแบตช์

หากคุณจัดการภูมิภาคหลายแห่ง Merchant API มีปลายทางแบบแบตช์ที่ช่วยให้คุณสร้าง อัปเดต และลบภูมิภาคได้สูงสุด 100 แห่งในการเรียกใช้ครั้งเดียว ดูข้อมูลเพิ่มเติมได้ที่ จัดการการจัดกลุ่มภูมิภาค