Trong Merchant API, bạn có thể sử dụng các khu vực địa lý làm mục tiêu cho các dịch vụ liên quan đến tài nguyên accounts.products.regionalInventories. Bạn có thể xác định khu vực là tập hợp mã bưu chính hoặc sử dụng mục tiêu địa lý được xác định trước ở một số quốc gia. Để biết thêm thông tin, hãy xem bài viết Thiết lập khu vực.
Để tạo và cập nhật khu vực, bạn có thể sử dụng các phương thức sau:
Truy xuất một khu vực
Để truy xuất một khu vực được xác định trong tài khoản Merchant Center, hãy sử dụng phương thức accounts.regions.get.
Sau đây là một yêu cầu mẫu:
GET https://merchantapi.googleapis.com/accounts/v1/accounts/125222396/regions/234567
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
HTTP/1.1 200
{
"name": "accounts/125222396/regions/234567",
"displayName": "Canada",
"postalCodeArea": {
"regionCode": "CA",
"postalCodes": [
{
"begin": "L6A"
}
]
}
Liệt kê tất cả các khu vực
Để liệt kê các khu vực trong tài khoản Merchant Center, hãy sử dụng phương thức accounts.regions.list.
Sau đây là một yêu cầu mẫu:
GET https://merchantapi.googleapis.com/accounts/v1/accounts/125222396/regions?pageSize=100
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
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
},
]
}
Chèn khu vực
Để chèn một định nghĩa khu vực vào tài khoản Merchant Center, hãy sử dụng phương thức accounts.regions.create. Bạn phải có quyền truy cập của quản trị viên để thực thi phương thức này.
Sau đây là một yêu cầu mẫu:
POST https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions?regionId=987654
{
"displayName": "TestRegion",
"name": "987654",
"postalCodeArea": {
"postalCodes": [
{
"begin": "98109"
}
],
"regionCode": "US"
}
}
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
{
"name": "accounts/102959835/regions/987654",
"displayName": "TestRegion",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "98109"
}
]
},
"regionalInventoryEligible": true,
"shippingEligible": true
}
Cách tạo một khu vực mới bằng AreaCode:
Sau đây là một yêu cầu mẫu:
POST https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions?regionId=168888 HTTP/1.1
{
"displayName": "WA_test",
"name": "168888",
"geotargetArea": {
"geotargetCriteriaIds": [
20101
]
}
}
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
{
"name": "accounts/102959835/regions/168888",
"displayName": "WA_test",
"geotargetArea": {
"geotargetCriteriaIds": [
"20101"
]
},
"regionalInventoryEligible": true,
"shippingEligible": false
}
Cách cập nhật displayName và GeoTargetCriteriaIds cho khu vực đã tạo:
Sau đây là một yêu cầu mẫu:
PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/168888?updateMask=displayName%2CgeotargetArea HTTP/1.1
{
"displayName": "BR_test",
"geotargetArea": {
"geotargetCriteriaIds": [
20100
]
}
}
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
HTTP/1.1 200
{
"name": "accounts/102959835/regions/168888",
"displayName": "BR_test",
"geotargetArea": {
"geotargetCriteriaIds": [
"20100"
]
},
"regionalInventoryEligible": true,
"shippingEligible": false
}
Cập nhật vùng
Để cập nhật định nghĩa khu vực trong tài khoản Merchant Center, hãy sử dụng phương thức accounts.regions.patch. Bạn phải có quyền truy cập của quản trị viên để thực thi phương thức này.
Sau đây là một yêu cầu mẫu:
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"
}
}
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
{
"name": "accounts/102959835/regions/987654",
"displayName": "Test",
"postalCodeArea": {
"regionCode": "US",
"postalCodes": [
{
"begin": "98108"
}
]
},
"regionalInventoryEligible": true,
"shippingEligible": true
}
Xoá vùng
Để xoá một định nghĩa khu vực khỏi tài khoản Merchant Center, hãy sử dụng phương thức accounts.regions.delete. Bạn phải có quyền truy cập của quản trị viên để thực thi phương thức này.
Sau đây là một yêu cầu mẫu:
DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/987654 HTTP/1.1
Sau đây là một phản hồi mẫu từ một lệnh gọi thành công:
HTTP/1.1 200
{}
Thao tác theo đợt
Nếu bạn đang quản lý nhiều khu vực, Merchant API sẽ cung cấp các điểm cuối hàng loạt cho phép bạn tạo, cập nhật và xoá tối đa 100 khu vực trong một lệnh gọi duy nhất. Để biết thêm thông tin, hãy xem bài viết Quản lý việc phân vùng theo khu vực.