Skip to content

여러 카탈로그 항목 세부 정보 나열

get

/catalogs/{catalog_name}/items

이 엔드포인트를 사용하여 여러 카탈로그 항목과 해당 콘텐츠를 반환할 수 있습니다.

See me in Postman

필수 구성 요소

이 엔드포인트를 사용하려면 catalogs.get_items 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트는 API 속도 제한에 설명된 대로 모든 동기식 카탈로그 항목 엔드포인트 간에 분당 50건의 요청을 공유할 수 있는 속도 제한이 있습니다.

경로 매개변수

쿼리 매개변수

이 엔드포인트를 호출할 때마다 50개의 항목이 반환된다는 점에 유의하세요. 50개 이상의 항목이 있는 카탈로그의 경우 다음 예제 응답과 같이 Link 헤더를 사용하여 다음 페이지에서 데이터를 검색합니다.

요청 매개변수

이 엔드포인트에 대한 요청 본문이 없습니다.

요청 예시

커서 없음

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

커서 포함

1
2
3

curl --location --request GET 'https://rest.iad-03.braze.com/catalogs/restaurants/items?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

응답

이 엔드포인트에 대한 상태 코드 응답은 200, 400, 404 의 세 가지가 있습니다 .

성공 응답의 예

200 상태 코드는 다음과 같은 응답 헤더와 본문을 반환할 수 있습니다.

1

Link: </catalogs/all_restaurants/items?cursor=c2tpcDow>; rel="prev",</catalogs/all_restaurants/items?cursor=c2tpcDoxMDA=>; rel="next"

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

{
  "items": [
    {
      "id": "restaurant1",
      "Name": "Restaurant1",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant2",
      "Name": "Restaurant2",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 10,
      "Loyalty_Program": true,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    },
    {
      "id": "restaurant3",
      "Name": "Restaurant3",
      "City": "New York",
      "Cuisine": "American",
      "Rating": 5,
      "Loyalty_Program": false,
      "Open_Time": "2022-11-02T09:03:19.967Z"
    }
  ],
  "message": "success"
}

오류 응답의 예

400 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다. 발생할 수 있는 오류에 대한 자세한 내용은 문제 해결을 참조하세요.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "errors": [
    {
      "id": "invalid-cursor",
      "message": "'cursor' is not valid",
      "parameters": [
        "cursor"
      ],
      "parameter_values": [
        "bad-cursor"
      ]
    }
  ],
  "message": "Invalid Request"
}

문제 해결

다음 표에는 반환될 수 있는 오류와 관련 문제 해결 단계가 나와 있습니다.

Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!