Merchant API에서는 지리적 리전을 서비스의 타겟으로 사용할 수 있습니다.
관련
accounts.products.regionalInventories
리소스 리전을 우편번호 모음 또는 일부 국가에서는 미리 정의된 지리적 타겟을 사용하여 정의할 수 있습니다. 자세한 내용은
리전 설정을 참고하세요.
리전을 만들고 업데이트하려면 다음 메서드를 사용하면 됩니다.
리전 가져오기
판매자 센터 계정에 정의된 리전을 가져오려면
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"
}
]
}
모든 리전 나열
판매자 센터 계정의 리전을 나열하려면
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
},
]
}
리전 삽입
판매자 센터 계정에 리전 정의를 삽입하려면
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
}
리전 업데이트
판매자 센터 계정의 리전 정의를 업데이트하려면
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
}
리전 삭제
판매자 센터 계정에서 리전 정의를 삭제하려면
accounts.regions.delete
메서드를 사용하세요. 이 메서드를 실행하려면 관리자 액세스 권한이 필요합니다.
샘플 요청은 다음과 같습니다.
DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/102959835/regions/987654 HTTP/1.1
다음은 성공적인 호출의 샘플 응답입니다.
HTTP/1.1 200
{}
일괄 작업
여러 리전을 관리하는 경우 Merchant API는 단일 호출에서 최대 100개의 리전을 만들고, 업데이트하고, 삭제할 수 있는 일괄 엔드포인트를 제공합니다. 자세한 내용은 리전 일괄 처리 관리를 참고하세요.