GET/api/v4/sub-categories

Daftar subkategori

Mengembalikan katalog lengkap subkategori yang digunakan untuk mengklasifikasikan lokasi saat membuat atau memperbaruinya.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Endpoint ini tidak menerima parameter.

Respons

200The full list of subcategory objects.
Response
{  "data": {    "subcategories": [      {        "databaseId": 639,        "id": "U3ViQ2F0ZWdvcnk6NjM5",        "key": "3d-printing",        "name": "3D Printing",        "primary": true      },      {        "databaseId": 4589,        "id": "U3ViQ2F0ZWdvcnk6NDU4OQ==",        "key": "3d-printing-service",        "name": "3D printing service",        "primary": true      },      {        "databaseId": 3268,        "id": "U3ViQ2F0ZWdvcnk6MzI2OA==",        "key": "aadhaar-center",        "name": "Aadhaar center",        "primary": true      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Mengembalikan katalog lengkap subkategori yang mengklasifikasikan bidang usaha suatu lokasi. Akun ini mengembalikan sekitar 6,000 entri, jadi perlakukan katalog ini sebagai referensi berukuran besar yang jarang berubah, ambil sekali, simpan dalam cache, dan perbarui secara berkala alih-alih memanggilnya langsung pada setiap operasi pembuatan atau pembaruan.

Setiap item memuat:

  • databaseId: bilangan bulat yang diteruskan sebagai subCategoryId saat membuat atau memperbarui lokasi, dan disertakan dalam array additionalCategoryIds untuk kategori tambahan.
  • id: pengenal Relay yang dikodekan dalam Base64 untuk record yang sama.
  • key: slug nama kategori yang sesuai untuk URL.
  • name: label yang dapat dibaca manusia.
  • primary: apakah kategori tersebut memenuhi syarat untuk menjadi subkategori utama suatu lokasi.

Menentukan kategori sebelum membuat lokasi

Saat menyiapkan lokasi, Anda biasanya mengetahui jenis usahanya dalam bentuk teks bebas ("layanan pencetakan 3D"), tetapi createLocation memerlukan subCategoryId numerik. Polanya adalah: ambil daftar ini sekali, buat pemetaan name → databaseId dalam kode Anda sendiri, lalu cari id saat pembuatan.

JavaScript
const res = await fetch('https://listingsapi.com/api/v4/sub-categories', {  headers: { Authorization: 'API ' + process.env.LISTINGSAPI_KEY },});const { data } = await res.json();const byName = new Map(data.subcategories.map((s) => [s.name.toLowerCase(), s.databaseId])); const subCategoryId = byName.get('3d printing service'); // 4589

Untuk menandai lokasi dengan lebih dari satu kategori, teruskan kategori utama dalam subCategoryId dan hingga 9 id tambahan dalam additionalCategoryIds. Lihat Membuat lokasi dan Memperbarui lokasi untuk mengetahui cara field ini digunakan.

Respons berupa satu array tanpa paginasi. Panggilan ini diperhitungkan dalam batas laju akun Anda seperti panggilan lainnya, jadi simpan hasilnya dalam cache alih-alih mengambilnya kembali untuk setiap lokasi; respons 429 menyertakan header Retry-After.

Request
curl -X GET 'https://listingsapi.com/api/v4/sub-categories' \  -H "Authorization: API $LISTINGSAPI_KEY"