Endpoint ·
GET /tagsEndpoint de solo consulta: devuelve información y no modifica nada. No se manda dentro del array
actions — se llama directo.name exacto de una etiqueta antes de usarla: las acciones
assign_label y remove_label identifican cada etiqueta por nombre, así que
conviene leer el catálogo primero en vez de adivinar el texto.
Parámetros
slug— slug del negocio, en el path. Case-insensitive, debe coincidir con el negocio del token (obligatorio).search— substring del nombre, case-insensitive. Opcional, de 1 a 100 caracteres. El asterisco*funciona como comodín y coincide con cualquier secuencia de caracteres:fact*mxencuentra tantoFacturas MXcomoFacturación MX. Los caracteres%y_se buscan literalmente.cursor— cursor opaco devuelto por la página anterior ennext_cursor. Opcional; omitirlo pide la primera página. No reutilizar cursores entre endpoints distintos: aunque el formato sea idéntico, cada endpoint lo interpreta sobre su propio conjunto de datos.limit— etiquetas por página. Opcional, entero de 1 a 500, por defecto 100.
GET /tags sin query params devuelve
la primera página completa.
Respuesta
items— arreglo de etiquetas, cada una connameycolor.next_cursor— cursor de la página siguiente, para pasarlo como?cursor=. Esnullcuandohas_moreesfalse.has_more— indica si hay más resultados después de esta página. Repetir la llamada con elnext_cursorhasta que seafalse.
Ejemplo
Una lectura simple, sin cuerpo: pide el catálogo y no cambia nada en el negocio.name que devuelve esta consulta es el que después se manda en la acción.
Errores
El catálogo completo está en Errores.
Con el nombre en la mano, la acción que lo consume es
Asignar etiqueta o
Quitar etiqueta.