Listar subcategorias

Retorna o catálogo completo de subcategorias que classificam o ramo de atividade de um local. Esta conta retorna aproximadamente 6.000 entradas, portanto, trate o catálogo como uma lista de consulta grande e pouco variável, busque-o uma vez, armazene-o em cache e atualize-o periodicamente, em vez de consultá-lo diretamente a cada criação ou atualização.

Cada item contém:

• databaseId: o número inteiro a ser passado como subCategoryId ao criar ou atualizar um local e incluído no array additionalCategoryIds para categorias complementares.
• id: o identificador Relay codificado em Base64 para o mesmo registro.
• key: um slug do nome da categoria adequado para uso em URLs.
• name: o rótulo legível por pessoas.
• primary: indica se a categoria pode ser a subcategoria principal de um local.

Determinar a categoria antes de criar um local

Ao cadastrar um local, você geralmente sabe o tipo de negócio como texto livre ("serviço de impressão 3D"), mas createLocation espera um subCategoryId numérico. O procedimento é: obtenha esta lista uma vez, crie um mapeamento de name → databaseId no seu próprio código e consulte o id no momento da criação.

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

Para associar um local a mais de uma categoria, passe a categoria principal em subCategoryId e até 9 ids complementares em additionalCategoryIds. Consulte Criar um local e Atualizar um local para saber como esses campos são utilizados.

A resposta é um único array sem paginação. Ela é contabilizada no limite de requisições da sua conta como qualquer outra chamada, portanto, armazene-a em cache em vez de buscá-la novamente para cada local; uma resposta 429 inclui um cabeçalho Retry-After.