카탈로그 항목 세부 정보 나열
get
/catalogs/{catalog_name}/items/{item_id}
이 엔드포인트를 사용하여 카탈로그 항목과 해당 콘텐츠를 반환합니다.
필수 구성 요소
이 엔드포인트를 사용하려면 catalogs.get_item 권한이 있는 API 키가 필요합니다.
사용량 제한
이 엔드포인트는 API 속도 제한에 설명된 대로 모든 동기식 카탈로그 항목 엔드포인트 간에 분당 50건의 요청을 공유할 수 있는 속도 제한이 있습니다.
경로 매개변수
| 매개변수 | 필수 | 데이터 유형 | 설명 |
|---|---|---|---|
catalog_name |
필수 | 문자열 | 카탈로그의 이름입니다. |
item_id |
필수 | 문자열 | 카탈로그 항목의 ID입니다. |
요청 매개변수
이 엔드포인트에 대한 요청 본문이 없습니다.
요청 예시
1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
응답
이 엔드포인트에 대한 상태 코드 응답은 200 와 404 두 가지입니다.
성공 응답의 예
200 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"items": [
{
"id": "restaurant3",
"Name": "Restaurant1",
"City": "New York",
"Cuisine": "American",
"Rating": 5,
"Loyalty_Program": true,
"Open_Time": "2022-11-01T09:03:19.967Z"
}
],
"message": "success"
}
오류 응답의 예
상태 코드 404 는 다음과 같은 응답을 반환할 수 있습니다. 발생할 수 있는 오류에 대한 자세한 내용은 문제 해결을 참조하세요.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"errors": [
{
"id": "item-not-found",
"message": "Could not find item",
"parameters": [
"item_id"
],
"parameter_values": [
"restaurant34"
]
}
],
"message": "Invalid Request"
}
문제 해결
다음 표에는 해당하는 경우 반환될 수 있는 오류 및 관련 문제 해결 단계가 나와 있습니다.
| 오류 | 문제 해결 |
|---|---|
catalog-not-found |
카탈로그 이름이 유효한지 확인합니다. |
item-not-found |
해당 품목이 카탈로그에 있는지 확인합니다. |
GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!