HubSpot CRM V2 (publicador independiente) (versión preliminar)
Con HubSpot CRM fácil de usar, nunca tendrás que actualizar manualmente los informes o preguntarte cómo tu equipo está realizando un seguimiento de las cuotas. Obtenga una vista en tiempo real de toda la canalización de ventas en un panel visual. HubSpot CRM organizará, enriquecerá y realizará un seguimiento automático de cada contacto en una escala de tiempo ordenada.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://www.hubspot.com/products/crm |
| Directiva de privacidad | hhttps://legal.hubspot.com/privacy-policy |
| Categorías | Ventas y CRM |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Token de acceso (con el formato "Portador ${YOUR_TOKEN}") | securestring | Token de acceso (con el formato "Bearer ${YOUR_TOKEN}") para esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de un descuento |
Realice una actualización parcial de un objeto identificado por discountidentifier. discountId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualización de un destino objetivo |
Realice una actualización parcial de un objeto identificado por goalTargetidentifier. goalTargetId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualización de un impuesto |
Realice una actualización parcial de un objeto identificado por taxidentifier. taxId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualización de un lote de comillas |
Actualice un lote de comillas. |
| Actualización de un lote de descuentos |
Actualice un lote de descuentos. |
| Actualización de un lote de destinos de objetivo |
Actualice un lote de destinos de objetivo. |
| Actualización de un lote de elementos de línea |
Actualizar un lote de elementos de línea. |
| Actualización de un lote de impuestos |
Actualizar un lote de impuestos. |
| Actualización de un lote de objetos |
Actualizar un lote de objetos. |
| Actualización de un lote de ofertas |
Actualice un lote de ofertas. |
| Actualización de un lote de productos |
Actualizar un lote de productos. |
| Actualización de un lote de tarifas |
Actualice un lote de tarifas. |
| Actualización de un lote de vales |
Actualice un lote de vales. |
| Actualización de un producto |
Realice una actualización parcial de un objeto identificado por productidentifier. productId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualización de una cita |
Realice una actualización parcial de un objeto identificado por quoteidentifier. quoteId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualización de una empresa por identificador |
Realice una actualización parcial de un objeto identificado por companyidentifier. companyId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualización de una tarifa por identificador |
Realice una actualización parcial de un objeto identificado por feeidentifier. feeId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar un contacto por identificador |
Realice una actualización parcial de un objeto identificado por contactidentifier. contactId hace referencia al identificador de objeto interno. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar un elemento de línea |
Realice una actualización parcial de un objeto identificado por lineItemidentifier. lineItemId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar un envío de comentarios |
Realice una actualización parcial de un objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar un lote de contactos |
Actualizar un lote de contactos. |
| Actualizar un lote de empresas |
Actualizar un lote de empresas. |
| Actualizar un lote de envíos de comentarios |
Actualizar un lote de envíos de comentarios. |
| Actualizar un objeto |
Realice una actualización parcial de un objeto identificado por objectidentifier. objectId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar un vale |
Realice una actualización parcial de un objeto identificado por ticketidentifier. ticketId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar una oferta |
Realice una actualización parcial de un objeto identificado por dealidentifier. dealId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía. |
| Actualizar una tarjeta |
Actualice una definición de tarjeta con nuevos detalles. |
| Agregar o quitar registros de una lista |
Agregue o quite los registros que ya se han creado en el sistema a o desde una lista. Este punto de conexión solo funciona para listas que tienen un |
| Agregar registros a una lista |
Agregue los registros proporcionados a la lista. Los registros que no existen o que ya son miembros de la lista se omiten. Este punto de conexión solo funciona para listas que tienen un |
| Agregar todos los registros de una lista de origen a una lista de destino |
Agregue todos los registros de una lista de origen (especificado por |
| Archivar un contacto por identificador |
Mueva un objeto identificado por contactId a la papelera de reciclaje. |
| Archivar un descuento |
Mueva un objeto identificado por discountId a la papelera de reciclaje. |
| Archivar un destino objetivo |
Mueva un objeto identificado por goalTargetId a la papelera de reciclaje. |
| Archivar un elemento de línea |
Mueva un objeto identificado por lineItemId a la papelera de reciclaje. |
| Archivar un envío de comentarios |
Mueva un objeto identificado por feedbackSubmissionId a la papelera de reciclaje. |
| Archivar un impuesto |
Mueva un objeto identificado por taxId a la papelera de reciclaje. |
| Archivar un lote de comillas por identificador |
Archivar un lote de comillas por identificador. |
| Archivar un lote de contactos por identificador |
Archivar un lote de contactos por identificador. |
| Archivar un lote de descuentos por identificador |
Archivar un lote de descuentos por identificador. |
| Archivar un lote de destinos de objetivo por identificador |
Archivar un lote de destinos de objetivo por identificador. |
| Archivar un lote de elementos de línea por identificador |
Archivar un lote de elementos de línea por identificador. |
| Archivar un lote de empresas por identificador |
Archivar un lote de empresas por identificador. |
| Archivar un lote de envíos de comentarios por identificador |
Archivar un lote de envíos de comentarios por identificador. |
| Archivar un lote de impuestos por identificador |
Archivar un lote de impuestos por identificador. |
| Archivar un lote de objetos por identificador |
Archivar un lote de objetos por identificador. |
| Archivar un lote de ofertas por identificador |
Archivar un lote de ofertas por identificador. |
| Archivar un lote de productos por identificador |
Archivar un lote de productos por identificador. |
| Archivar un lote de tarifas por identificador |
Archivar un lote de tarifas por identificador. |
| Archivar un lote de vales por identificador |
Archivar un lote de vales por identificador. |
| Archivar un objeto |
Mueva un objeto identificado por objectId a la papelera de reciclaje. |
| Archivar un producto |
Mueva un objeto identificado por productId a la papelera de reciclaje. |
| Archivar un vale |
Mueva un objeto identificado por ticketId a la papelera de reciclaje. |
| Archivar una cita por identificador |
Mueva un objeto identificado por quoteId a la papelera de reciclaje. |
| Archivar una cuota por identificador |
Mueva un objeto identificado por feeId a la papelera de reciclaje. |
| Archivar una empresa por identificador |
Mueva un objeto identificado por companyId a la papelera de reciclaje. |
| Archivar una oferta por identificador |
Mueva un objeto identificado por dealId a la papelera de reciclaje. |
| Buscar comillas |
Recupera una lista de comillas. |
| Buscar contactos |
Recuperar una lista de contactos. |
| Buscar elementos de línea |
Recuperar una lista de elementos de línea. |
| Buscar ofertas |
Recuperar una lista de ofertas. |
| Buscar por tipo de objeto |
Recupere una lista de objetos por tipo de objeto. |
| Buscar productos |
Recuperar una lista de productos. |
| Buscar vales |
Recupera una lista de vales. |
| Búsqueda de tarifas |
Recupera una lista de tarifas. |
| Cancelación de una importación activa |
Esto permite que un desarrollador cancele una importación activa. |
| Capturar pertenencias a listas |
Capture las pertenencias de una lista ordenadas por de |
| Combinar dos comillas |
Combine dos comillas con el mismo tipo. |
| Combinar dos contactos |
Combine dos contactos con el mismo tipo. |
| Combinar dos descuentos |
Combine dos descuentos con el mismo tipo. |
| Combinar dos destinos de objetivo |
Combine dos destinos de objetivo con el mismo tipo. |
| Combinar dos elementos de línea |
Combine dos elementos de línea con el mismo tipo. |
| Combinar dos empresas |
Combine dos empresas con el mismo tipo. |
| Combinar dos envíos de comentarios |
Combine dos envíos de comentarios con el mismo tipo. |
| Combinar dos impuestos |
Combine dos impuestos con el mismo tipo. |
| Combinar dos objetos |
Combine dos objetos con el mismo tipo. |
| Combinar dos ofertas |
Combinar dos ofertas con el mismo tipo. |
| Combinar dos productos |
Combine dos productos con el mismo tipo. |
| Combinar dos tarifas |
Combine dos tarifas con el mismo tipo. |
| Combinar dos vales |
Combine dos vales con el mismo tipo. |
| Creación de asociaciones por lotes |
Batch crea asociaciones para objetos. |
| Creación de etiquetas de asociación |
Establezca etiquetas de asociación entre dos registros. |
| Creación de un contacto |
Cree un contacto con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de un descuento |
Cree un descuento con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de un destino objetivo |
Cree un destino de objetivo con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de un impuesto |
Cree un impuesto con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de un lote de contactos |
Cree un lote de contactos. |
| Creación de un lote de descuentos |
Cree un lote de descuentos. |
| Creación de un lote de destinos de objetivo |
Cree un lote de destinos de objetivo. |
| Creación de un lote de empresas |
Cree un lote de empresas. |
| Creación de un lote de impuestos |
Cree un lote de impuestos. |
| Creación de un lote de objetos |
Cree un lote de objetos. |
| Creación de un lote de ofertas |
Cree un lote de ofertas. |
| Creación de un lote de productos |
Cree un lote de productos. |
| Creación de un lote de tarifas |
Cree un lote de tarifas. |
| Creación de un lote de vales |
Cree un lote de vales. |
| Creación de un objeto |
Cree un objeto CRM con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de un vale |
Cree un vale con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de una cuota |
Cree una tarifa con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de una empresa |
Cree una empresa con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Creación de una oferta |
Cree una oferta con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Crear asociaciones predeterminadas |
Cree el tipo de asociación predeterminado (más genérico) entre dos tipos de objeto. |
| Crear asociación predeterminada |
Cree el tipo de asociación predeterminado (más genérico) entre dos tipos de objeto. |
| Crear cita |
Cree una cita con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Crear un elemento de línea |
Cree un elemento de línea con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Crear un envío de comentarios |
Cree un envío de comentarios con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Crear un lote de comillas |
Cree un lote de comillas. |
| Crear un lote de elementos de línea |
Cree un lote de elementos de línea. |
| Crear un lote de envíos de comentarios |
Cree un lote de envíos de comentarios. |
| Crear un producto |
Cree un producto con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador. |
| Crear una nueva tarjeta |
Define una nueva tarjeta que se activará en una cuenta cuando se instale esta aplicación. |
| Descuentos de búsqueda |
Recupera una lista de descuentos. |
| Eliminación de asociaciones por lotes |
Eliminar asociaciones por lotes para objetos. |
| Eliminación de un tipo de objeto para seguir el RGPD |
Elimine permanentemente un tipo de objeto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminación de una cuota para seguir el RGPD |
Elimine permanentemente una tarifa y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminación de una empresa para seguir el RGPD |
Elimine permanentemente una empresa y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminación de una oferta para seguir el RGPD |
Elimine permanentemente una oferta y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar asociaciones |
Elimina todas las asociaciones entre dos registros. |
| Eliminar etiquetas de asociación específicas |
Eliminar por lotes etiquetas de asociación específicas para objetos. Al eliminar una asociación sin etiqueta, también se eliminarán todas las asociaciones etiquetadas entre esos dos objetos. |
| Eliminar todos los registros de una lista |
Quite todos los registros de una lista. Nota: La lista no se elimina. Este punto de conexión solo funciona para listas que tienen un |
| Eliminar un contacto para seguir el RGPD |
Elimine permanentemente un contacto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un descuento para seguir el RGPD |
Elimine permanentemente un descuento y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un elemento de línea para seguir el RGPD |
Elimine permanentemente un elemento de línea y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un envío de comentarios para seguir el RGPD |
Elimine permanentemente un envío de comentarios y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un impuesto para seguir el RGPD |
Elimine permanentemente un impuesto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un objetivo objetivo para seguir el RGPD |
Elimine permanentemente un objetivo y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un producto para seguir el RGPD |
Elimine permanentemente un producto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar un vale para seguir el RGPD |
Elimine permanentemente un vale y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar una cita para seguir el RGPD |
Elimine permanentemente una cita y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro. |
| Eliminar una tarjeta |
Elimina permanentemente una definición de tarjeta con el identificador especificado. Una vez eliminados, las solicitudes de captura de datos para esta tarjeta ya no se enviarán al servicio. Esto no se puede deshacer. |
| Empresas de búsqueda |
Recuperar una lista de empresas. |
| Enumerar asociaciones para un objeto |
Enumera todas las asociaciones de un objeto por tipo de objeto. Limite 500 por llamada. |
| Enumerar comillas |
Recuperar una página de comillas. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Enumerar descuentos |
Recuperar una página de descuentos. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Enumerar envíos de comentarios |
Recuperar una página de envíos de comentarios. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Enumerar tipos de asociación |
Enumere todos los tipos de asociación válidos disponibles entre dos tipos de objeto. |
| Envío de comentarios de búsqueda |
Recupera una lista de envíos de comentarios. |
| Impuestos de búsqueda |
Recuperar una lista de impuestos. |
| Iniciar una exportación |
Comienza a exportar datos de CRM para el portal tal como se especifica en el cuerpo de la solicitud. |
| Iniciar una nueva importación |
Comienza a importar datos de los recursos de archivo especificados. Esto carga el archivo correspondiente y usa el objeto de solicitud de importación para convertir filas de los archivos en objetos . |
| Leer asociaciones por lotes |
Asociaciones de lectura por lotes para objetos a un tipo de objeto específico. El campo 'after' de un objeto de paginación devuelto se puede agregar junto con el 'id' para recuperar la página siguiente de asociaciones de ese objectidentifier. El campo 'link' está en desuso y debe omitirse. |
| Listas de búsqueda |
Buscar listas por nombre de lista o página a través de todas las listas proporcionando un valor vacío |
| Objetivos de búsqueda |
Recuperar una lista de destinos de objetivo. |
| Obtención de empresas por identificador |
Recupere un lote de empresas por identificador interno o valores de propiedad únicos. |
| Obtención de errores de importación |
Recupere una lista de errores para una importación. |
| Obtención de importaciones activas |
Devuelve una lista paginada de importaciones activas para esta cuenta. |
| Obtención de la información sobre cualquier importación |
Resumen completo de un registro de importación, incluidas las actualizaciones. |
| Obtención de objetivos |
Recuperar una página de destinos de objetivo. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de tarifas |
Recuperar una página de tarifas. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de un lote de destinos de objetivo por identificador |
Recupere un lote de destinos de objetivo por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de elementos de línea por identificador |
Recupere un lote de elementos de línea por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de objetos por identificador |
Recupere un lote de objetos por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de ofertas por identificador |
Recupere un lote de ofertas por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de productos por identificador |
Recupere un lote de productos por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de tarifas por identificador |
Recupere un lote de tarifas por identificador interno o valores de propiedad únicos. |
| Obtención de un lote de vales por identificador |
Recupere un lote de vales por identificador interno o valores de propiedad únicos. |
| Obtención de un objetivo por identificador |
Recupere un objeto identificado por goalTargetidentifier. goalTargetId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de un objeto por identificador |
Recupere un objeto identificado por objectidentifier. objectId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de un producto |
Recupere un objeto identificado por productidentifier. productId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de un propietario por identificador |
Recupere un propietario mediante un identificador especificado o useridentifier. |
| Obtención de una cuota por identificador |
Recupere un objeto identificado por feeidentifier. feeId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de una empresa por identificador |
Recupere un objeto identificado por companyidentifier. companyId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtención de una respuesta de detalles de tarjeta de ejemplo |
Devuelve una respuesta de detalle de tarjeta de ejemplo. Esta es la carga con los detalles mostrados de una tarjeta que se mostrará a un usuario. Una aplicación debe enviar esto en respuesta a la solicitud de captura de datos. |
| Obtención del estado del identificador de tarea |
Recupere el estado de un identificador de tarea. |
| Obtener contactos |
Recuperar una página de contactos. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener elemento de línea |
Recupere un objeto identificado por lineItemidentifier. lineItemId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener elementos de línea |
Recuperar una página de elementos de línea. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener empresas |
Recuperar una página de empresas. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener impuestos |
Recuperar una página de impuestos. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener objetos |
Recuperar una página de objetos. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener ofertas |
Recuperar una página de ofertas. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener productos |
Recuperar una página de productos. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener propietarios |
Recuperar una lista de propietarios. |
| Obtener todas las tarjetas |
Devuelve una lista de tarjetas para una aplicación determinada. |
| Obtener un contacto por identificador |
Recupere un objeto identificado por contactidentifier. contactId hace referencia al identificador de objeto interno. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener un descuento |
Recupere un objeto identificado por discountidentifier. discountId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener un envío de comentarios |
Recupere un objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener un impuesto por identificador |
Recupere un objeto identificado por taxidentifier. taxId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener un lote de comillas por identificador |
Recupere un lote de comillas por identificador interno o valores de propiedad únicos. |
| Obtener un lote de contactos por identificador |
Recupere un lote de contactos por identificador interno o valores de propiedad únicos. |
| Obtener un lote de descuentos por identificador |
Recupere un lote de descuentos por identificador interno o valores de propiedad únicos. |
| Obtener un lote de envíos de comentarios por identificador |
Recupere un lote de envíos de comentarios por identificador interno o valores de propiedad únicos. |
| Obtener un lote de impuestos por identificador |
Recupere un lote de impuestos por identificador interno o valores de propiedad únicos. |
| Obtener un vale |
Recupere un objeto identificado por ticketidentifier. ticketId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener una oferta |
Recupere un objeto identificado por dealidentifier. dealId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener una oferta por identificador |
Recupere un objeto identificado por quoteidentifier. quoteId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Obtener una tarjeta |
Devuelve la definición de una tarjeta con el identificador especificado. |
| Obtener vales |
Recuperar una página de vales. Controle lo que se devuelve a través del parámetro de consulta properties. |
| Quitar registros de una lista |
Quite los registros proporcionados de la lista. Los registros que no existen o que no son miembros de la lista se omiten. Este punto de conexión solo funciona para listas que tienen un |
Actualización de un descuento
Realice una actualización parcial de un objeto identificado por discountidentifier. discountId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de descuento
|
discountId | True | string |
El identificador del descuento. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización de un destino objetivo
Realice una actualización parcial de un objeto identificado por goalTargetidentifier. goalTargetId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de destino del objetivo
|
goalTargetId | True | string |
Identificador de destino objetivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización de un impuesto
Realice una actualización parcial de un objeto identificado por taxidentifier. taxId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. fiscal
|
taxId | True | string |
Identificador fiscal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización de un lote de comillas
Actualice un lote de comillas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de descuentos
Actualice un lote de descuentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de destinos de objetivo
Actualice un lote de destinos de objetivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de elementos de línea
Actualizar un lote de elementos de línea.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de impuestos
Actualizar un lote de impuestos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de objetos
Actualizar un lote de objetos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de ofertas
Actualice un lote de ofertas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de productos
Actualizar un lote de productos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de tarifas
Actualice un lote de tarifas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un lote de vales
Actualice un lote de vales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualización de un producto
Realice una actualización parcial de un objeto identificado por productidentifier. productId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. del producto
|
productId | True | string |
Identificador del producto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización de una cita
Realice una actualización parcial de un objeto identificado por quoteidentifier. quoteId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de cita
|
quoteId | True | string |
Identificador de comillas. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización de una empresa por identificador
Realice una actualización parcial de un objeto identificado por companyidentifier. companyId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de empresa
|
companyId | True | string |
Identificador de la empresa. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualización de una tarifa por identificador
Realice una actualización parcial de un objeto identificado por feeidentifier. feeId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de cuota
|
feeId | True | string |
Identificador de la tarifa. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar un contacto por identificador
Realice una actualización parcial de un objeto identificado por contactidentifier. contactId hace referencia al identificador de objeto interno. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactId | True | string |
Identificador de contacto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar un elemento de línea
Realice una actualización parcial de un objeto identificado por lineItemidentifier. lineItemId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de elemento de línea
|
lineItemId | True | string |
Identificador del elemento de línea. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar un envío de comentarios
Realice una actualización parcial de un objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de envío de comentarios
|
feedbackSubmissionId | True | string |
Identificador de envío de comentarios. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar un lote de contactos
Actualizar un lote de contactos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualizar un lote de empresas
Actualizar un lote de empresas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualizar un lote de envíos de comentarios
Actualizar un lote de envíos de comentarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Actualizar un objeto
Realice una actualización parcial de un objeto identificado por objectidentifier. objectId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Identificador de objeto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar un vale
Realice una actualización parcial de un objeto identificado por ticketidentifier. ticketId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de vale
|
ticketId | True | string |
Identificador del vale. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar una oferta
Realice una actualización parcial de un objeto identificado por dealidentifier. dealId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Los valores de propiedad proporcionados se sobrescribirán. Se omitirán las propiedades de solo lectura y no existentes. Los valores de propiedades se pueden borrar pasando una cadena vacía.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Identificador de la oferta
|
dealId | True | string |
Identificador de la oferta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Actualizar una tarjeta
Actualice una definición de tarjeta con nuevos detalles.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de aplicación
|
appId | True | string |
Identificador de la aplicación. |
|
Id. de tarjeta
|
cardId | True | string |
Identificador de tarjeta. |
|
Title
|
title | string |
Título. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Propiedades que se van a enviar
|
propertiesToSend | array of string |
Propiedades que se van a enviar. |
|
|
Tipo de tarjeta
|
cardType | string |
Tipo de tarjeta. |
|
|
Dirección URL de destino
|
targetUrl | string |
Dirección URL de destino. |
|
|
Función sin servidor
|
serverlessFunction | string |
Función sin servidor. |
|
|
Tipo de datos
|
dataType | string |
Tipo de datos. |
|
|
Etiqueta
|
label | string |
Etiqueta. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Etiqueta
|
label | string |
Etiqueta. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Tipo
|
type | string |
Tipo. |
|
|
Direcciones URL base
|
baseUrls | array of string |
Direcciones URL base. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Direcciones URL base
|
actions.baseUrls | array of string |
Direcciones URL base. |
|
Historial de auditoría
|
auditHistory | array of object | |
|
Tipo de acción
|
auditHistory.actionType | string |
Tipo de acción. |
|
Id. de solicitud
|
auditHistory.applicationId | string |
Identificador de la aplicación. |
|
Origen de autorización
|
auditHistory.authSource | string |
Origen de autorización. |
|
Se ha cambiado en
|
auditHistory.changedAt | string |
Cuando se cambia. |
|
Inicio del identificador de usuario
|
auditHistory.initiatingUserId | string |
Identificador de usuario que inicia. |
|
Id. de tipo de objeto
|
auditHistory.objectTypeId | string |
Identificador de tipo de objeto. |
|
Propiedades
|
display.properties | array of object | |
|
Tipo de datos
|
display.properties.dataType | string |
Tipo de datos. |
|
Etiqueta
|
display.properties.label | string |
Etiqueta. |
|
Nombre
|
display.properties.name | string |
Nombre. |
|
Options
|
display.properties.options | array of object | |
|
Etiqueta
|
display.properties.options.label | string |
Etiqueta. |
|
Nombre
|
display.properties.options.name | string |
Nombre. |
|
Tipo
|
display.properties.options.type | string |
Tipo. |
|
Tipos de objeto
|
fetch.objectTypes | array of object | |
|
Nombre
|
fetch.objectTypes.name | string |
Nombre. |
|
Propiedades que se van a enviar
|
fetch.objectTypes.propertiesToSend | array of string |
Propiedades que se van a enviar. |
|
Dirección URL de destino
|
fetch.targetUrl | string |
Dirección URL de destino. |
|
identificación
|
id | string |
Identificador. |
|
Title
|
title | string |
Título. |
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
Agregar o quitar registros de una lista
Agregue o quite los registros que ya se han creado en el sistema a o desde una lista. Este punto de conexión solo funciona para listas que tienen un processingType de MANUAL o SNAPSHOT.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
listId | True | string |
Identificador de lista. |
|
Identificadores de registro para agregar
|
recordIdsToAdd | array of string |
Identificadores de registro que se van a agregar. |
|
|
Identificadores de registro que se van a quitar
|
recordIdsToRemove | array of string |
Identificadores de registro que se van a quitar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Faltan identificadores de registro
|
recordIdsMissing | array of string |
Faltan los identificadores de registro. |
|
Identificadores de registro quitados
|
recordIdsRemoved | array of string |
Se han quitado los identificadores de registro. |
|
Identificadores de registro agregados
|
recordsIdsAdded | array of string |
Identificadores de registro agregados. |
Agregar registros a una lista
Agregue los registros proporcionados a la lista. Los registros que no existen o que ya son miembros de la lista se omiten. Este punto de conexión solo funciona para listas que tienen un processingType de MANUAL o SNAPSHOT.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
listId | True | string |
Identificador de lista. |
|
body
|
body | True | array of string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Faltan identificadores de registro
|
recordIdsMissing | array of string |
Faltan los identificadores de registro. |
|
Identificadores de registro quitados
|
recordIdsRemoved | array of string |
Se han quitado los identificadores de registro. |
|
Identificadores de registro agregados
|
recordsIdsAdded | array of string |
Identificadores de registro agregados. |
Agregar todos los registros de una lista de origen a una lista de destino
Agregue todos los registros de una lista de origen (especificado por sourceListId) a una lista de destino (especificada por ).listId Los registros que ya son miembros de la lista de destino se omitirán. Los identificadores de lista de origen y destino deben ser diferentes. Las listas de destino y origen deben contener registros del mismo tipo (por ejemplo, contactos, empresas, etc.). Este punto de conexión solo funciona para las listas de destino que tienen un processingType de MANUAL o SNAPSHOT. La lista de origen puede tener cualquier processingType.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
listId | True | string |
Identificador de lista. |
|
Id. de lista de origen
|
sourceListId | True | string |
Identificador de lista de origen. |
Devoluciones
- response
- string
Archivar un contacto por identificador
Mueva un objeto identificado por contactId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactId | True | string |
Identificador de contacto. |
Devoluciones
- response
- string
Archivar un descuento
Mueva un objeto identificado por discountId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de descuento
|
discountId | True | string |
El identificador del descuento. |
Devoluciones
- response
- string
Archivar un destino objetivo
Mueva un objeto identificado por goalTargetId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de destino del objetivo
|
goalTargetId | True | string |
Identificador de destino objetivo. |
Devoluciones
- response
- string
Archivar un elemento de línea
Mueva un objeto identificado por lineItemId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de elemento de línea
|
lineItemId | True | string |
Identificador del elemento de línea. |
Devoluciones
- response
- string
Archivar un envío de comentarios
Mueva un objeto identificado por feedbackSubmissionId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de envío de comentarios
|
feedbackSubmissionId | True | string |
Identificador de envío de comentarios. |
Devoluciones
- response
- string
Archivar un impuesto
Mueva un objeto identificado por taxId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. fiscal
|
taxId | True | string |
Identificador fiscal. |
Devoluciones
- response
- string
Archivar un lote de comillas por identificador
Archivar un lote de comillas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de contactos por identificador
Archivar un lote de contactos por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de descuentos por identificador
Archivar un lote de descuentos por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de destinos de objetivo por identificador
Archivar un lote de destinos de objetivo por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de elementos de línea por identificador
Archivar un lote de elementos de línea por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de empresas por identificador
Archivar un lote de empresas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de envíos de comentarios por identificador
Archivar un lote de envíos de comentarios por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de impuestos por identificador
Archivar un lote de impuestos por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de objetos por identificador
Archivar un lote de objetos por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de ofertas por identificador
Archivar un lote de ofertas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de productos por identificador
Archivar un lote de productos por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de tarifas por identificador
Archivar un lote de tarifas por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un lote de vales por identificador
Archivar un lote de vales por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Archivar un objeto
Mueva un objeto identificado por objectId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Identificador de objeto. |
Devoluciones
- response
- string
Archivar un producto
Mueva un objeto identificado por productId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del producto
|
productId | True | string |
Identificador del producto. |
Devoluciones
- response
- string
Archivar un vale
Mueva un objeto identificado por ticketId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de vale
|
ticketId | True | string |
Identificador del vale. |
Devoluciones
- response
- string
Archivar una cita por identificador
Mueva un objeto identificado por quoteId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de cita
|
quoteId | True | string |
Identificador de comillas. |
Devoluciones
- response
- string
Archivar una cuota por identificador
Mueva un objeto identificado por feeId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de cuota
|
feeId | True | string |
Identificador de la tarifa. |
Devoluciones
- response
- string
Archivar una empresa por identificador
Mueva un objeto identificado por companyId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de empresa
|
companyId | True | string |
Identificador de la empresa. |
Devoluciones
- response
- string
Archivar una oferta por identificador
Mueva un objeto identificado por dealId a la papelera de reciclaje.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de la oferta
|
dealId | True | string |
Identificador de la oferta. |
Devoluciones
- response
- string
Buscar comillas
Recupera una lista de comillas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar contactos
Recuperar una lista de contactos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar elementos de línea
Recuperar una lista de elementos de línea.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar ofertas
Recuperar una lista de ofertas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar por tipo de objeto
Recupere una lista de objetos por tipo de objeto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar productos
Recuperar una lista de productos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Buscar vales
Recupera una lista de vales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Búsqueda de tarifas
Recupera una lista de tarifas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Cancelación de una importación activa
Esto permite que un desarrollador cancele una importación activa.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de importación
|
importId | True | string |
Identificador de importación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Capturar pertenencias a listas
Capture las pertenencias de una lista ordenadas por de recordId los registros de la lista. Los recordIds se ordenan en orden ascendente si se proporciona un after desplazamiento o ningún desplazamiento. Si solo se proporciona un before desplazamiento, los registros se ordenan en orden descendente. El after parámetro offset tendrá prioridad sobre el desplazamiento en un caso en el before que se proporcionan ambos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Antes
|
before | string |
Antes. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Id. de lista
|
listId | True | string |
Identificador de lista. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of string |
Resultados. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
|
Antes
|
paging.prev.before | string |
Antes. |
|
Link
|
paging.prev.link | string |
Vínculo. |
Combinar dos comillas
Combine dos comillas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos contactos
Combine dos contactos con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos descuentos
Combine dos descuentos con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos destinos de objetivo
Combine dos destinos de objetivo con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos elementos de línea
Combine dos elementos de línea con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos empresas
Combine dos empresas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos envíos de comentarios
Combine dos envíos de comentarios con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos impuestos
Combine dos impuestos con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos objetos
Combine dos objetos con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos ofertas
Combinar dos ofertas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos productos
Combine dos productos con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos tarifas
Combine dos tarifas con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Combinar dos vales
Combine dos vales con el mismo tipo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de objeto para combinar
|
objectIdToMerge | string |
Identificador de objeto que se va a combinar. |
|
|
Id. de objeto principal
|
primaryObjectId | string |
Identificador del objeto principal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de asociaciones por lotes
Batch crea asociaciones para objetos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
identificación
|
id | string |
Identificador. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Desde el identificador de objeto
|
results.fromObjectId | string |
El objeto From identfiier. |
|
Id. de tipo de objeto
|
results.fromObjectTypeId | string |
Identificador del tipo de objeto From. |
|
Etiquetas
|
results.labels | array of string |
Etiquetas. |
|
Para el identificador de objeto
|
results.toObjectId | string |
Identificador del objeto To. |
|
Id. de tipo de objeto
|
results.toObjectTypeId | string |
Identificador de tipo de objeto To. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de etiquetas de asociación
Establezca etiquetas de asociación entre dos registros.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Identificador de objeto. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
Para el identificador de objeto
|
toObjectId | True | string |
Identificador del objeto To. |
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Desde el identificador de objeto
|
fromObjectId | string |
Identificador del objeto From. |
|
Id. de tipo de objeto
|
fromObjectTypeId | string |
Identificador del tipo de objeto From. |
|
Etiquetas
|
labels | array of string |
Etiquetas. |
|
Para el identificador de objeto
|
toObjectId | string |
Identificador del objeto To. |
|
Id. de tipo de objeto
|
toObjectTypeId | string |
Identificador de tipo de objeto To. |
Creación de un contacto
Cree un contacto con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de un descuento
Cree un descuento con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
|
|
nostrudcf
|
nostrudcf | string |
nostrudcf. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de un destino objetivo
Cree un destino de objetivo con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de un impuesto
Cree un impuesto con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de un lote de contactos
Cree un lote de contactos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de descuentos
Cree un lote de descuentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de destinos de objetivo
Cree un lote de destinos de objetivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de empresas
Cree un lote de empresas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de impuestos
Cree un lote de impuestos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de objetos
Cree un lote de objetos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de ofertas
Cree un lote de ofertas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de productos
Cree un lote de productos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de tarifas
Cree un lote de tarifas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un lote de vales
Cree un lote de vales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Creación de un objeto
Cree un objeto CRM con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de un vale
Cree un vale con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de una cuota
Cree una tarifa con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de una empresa
Cree una empresa con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Creación de una oferta
Cree una oferta con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear asociaciones predeterminadas
Cree el tipo de asociación predeterminado (más genérico) entre dos tipos de objeto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
identificación
|
id | string |
Identificador. |
|
|
identificación
|
id | string |
Identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Categoría de asociación
|
results.associationSpec.associationCategory | string |
Categoría de asociación. |
|
Id. de tipo de asociación
|
results.associationSpec.associationTypeId | string |
Identificador de tipo de asociación. |
|
identificación
|
results.from.id | string |
Identificador. |
|
identificación
|
results.to.id | string |
Identificador. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Errors
|
numErrors | string |
Número de errores. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
|
Errors
|
errors | array of object | |
|
Categoría
|
errors.category | string |
Categoría. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
Mensaje. |
|
Sub categoría
|
errors.errors.subCategory | string |
Sub categoría. |
|
Código
|
errors.errors.code | string |
El código. |
|
In
|
errors.errors.in | string |
La parte de adentro. |
|
Message
|
errors.message | string |
Mensaje. |
|
Estado
|
errors.status | string |
Estado. |
|
identificación
|
errors.id | string |
Identificador. |
Crear asociación predeterminada
Cree el tipo de asociación predeterminado (más genérico) entre dos tipos de objeto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Desde el identificador de objeto
|
fromObjectId | True | string |
Identificador del objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
Para el identificador de objeto
|
toObjectId | True | string |
Identificador del objeto To. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Categoría de asociación
|
results.associationSpec.associationCategory | string |
Categoría de asociación. |
|
Id. de tipo de asociación
|
results.associationSpec.associationTypeId | string |
Identificador de tipo de asociación. |
|
identificación
|
results.from.id | string |
Identificador. |
|
identificación
|
results.to.id | string |
Identificador. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Errors
|
numErrors | string |
Número de errores. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
|
Errors
|
errors | array of object | |
|
Categoría
|
errors.category | string |
Categoría. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
Mensaje. |
|
Sub categoría
|
errors.errors.subCategory | string |
Sub categoría. |
|
Código
|
errors.errors.code | string |
El código. |
|
In
|
errors.errors.in | string |
La parte de adentro. |
|
Message
|
errors.message | string |
Mensaje. |
|
Estado
|
errors.status | string |
Estado. |
|
identificación
|
errors.id | string |
Identificador. |
Crear cita
Cree una cita con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
|
|
elit_26
|
elit_26 | string |
elit_26. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear un elemento de línea
Cree un elemento de línea con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear un envío de comentarios
Cree un envío de comentarios con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear un lote de comillas
Cree un lote de comillas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Crear un lote de elementos de línea
Cree un lote de elementos de línea.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Crear un lote de envíos de comentarios
Cree un lote de envíos de comentarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Crear un producto
Cree un producto con las propiedades especificadas y devuelva una copia del objeto, incluido el identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Crear una nueva tarjeta
Define una nueva tarjeta que se activará en una cuenta cuando se instale esta aplicación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de aplicación
|
appId | True | string |
Identificador de la aplicación. |
|
Direcciones URL base
|
baseUrls | array of string |
Direcciones URL base. |
|
|
Tipo de datos
|
dataType | string |
Tipo de datos. |
|
|
Etiqueta
|
label | string |
Etiqueta. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Etiqueta
|
label | string |
Etiqueta. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Tipo
|
type | string |
Tipo. |
|
|
Nombre
|
name | string |
Nombre. |
|
|
Propiedades que se van a enviar
|
propertiesToSend | array of string |
Propiedades que se van a enviar. |
|
|
Dirección URL de destino
|
targetUrl | string |
Dirección URL de destino. |
|
|
Tipo de tarjeta
|
cardType | string |
Tipo de tarjeta. |
|
|
Función sin servidor
|
serverlessFunction | string |
Función sin servidor. |
|
|
Title
|
title | string |
Título. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Direcciones URL base
|
actions.baseUrls | array of string |
Direcciones URL base. |
|
Historial de auditoría
|
auditHistory | array of object | |
|
Tipo de acción
|
auditHistory.actionType | string |
Tipo de acción. |
|
Id. de solicitud
|
auditHistory.applicationId | string |
Identificador de la aplicación. |
|
Origen de autorización
|
auditHistory.authSource | string |
Origen de autorización. |
|
Se ha cambiado en
|
auditHistory.changedAt | string |
Cuando se cambia. |
|
Inicio del identificador de usuario
|
auditHistory.initiatingUserId | string |
Identificador de usuario que inicia. |
|
Id. de tipo de objeto
|
auditHistory.objectTypeId | string |
Identificador de tipo de objeto. |
|
Propiedades
|
display.properties | array of object | |
|
Tipo de datos
|
display.properties.dataType | string |
Tipo de datos. |
|
Etiqueta
|
display.properties.label | string |
Etiqueta. |
|
Nombre
|
display.properties.name | string |
Nombre. |
|
Options
|
display.properties.options | array of object | |
|
Etiqueta
|
display.properties.options.label | string |
Etiqueta. |
|
Nombre
|
display.properties.options.name | string |
Nombre. |
|
Tipo
|
display.properties.options.type | string |
Tipo. |
|
Tipos de objeto
|
fetch.objectTypes | array of object | |
|
Nombre
|
fetch.objectTypes.name | string |
Nombre. |
|
Propiedades que se van a enviar
|
fetch.objectTypes.propertiesToSend | array of string |
Propiedades que se van a enviar. |
|
Dirección URL de destino
|
fetch.targetUrl | string |
Dirección URL de destino. |
|
identificación
|
id | string |
Identificador. |
|
Title
|
title | string |
Título. |
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
Descuentos de búsqueda
Recupera una lista de descuentos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Eliminación de asociaciones por lotes
Eliminar asociaciones por lotes para objetos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
identificación
|
id | string |
Identificador. |
|
|
identificación
|
id | string |
Identificador. |
Devoluciones
- response
- string
Eliminación de un tipo de objeto para seguir el RGPD
Elimine permanentemente un tipo de objeto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminación de una cuota para seguir el RGPD
Elimine permanentemente una tarifa y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminación de una empresa para seguir el RGPD
Elimine permanentemente una empresa y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminación de una oferta para seguir el RGPD
Elimine permanentemente una oferta y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar asociaciones
Elimina todas las asociaciones entre dos registros.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Identificador de objeto. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
Para el identificador de objeto
|
toObjectId | True | string |
Identificador del objeto To. |
Devoluciones
- response
- string
Eliminar etiquetas de asociación específicas
Eliminar por lotes etiquetas de asociación específicas para objetos. Al eliminar una asociación sin etiqueta, también se eliminarán todas las asociaciones etiquetadas entre esos dos objetos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
identificación
|
id | string |
Identificador. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Categoría de asociación
|
associationCategory | string |
Categoría de asociación. |
|
|
Id. de tipo de asociación
|
associationTypeId | string |
Identificador de tipo de asociación. |
Devoluciones
- response
- string
Eliminar todos los registros de una lista
Quite todos los registros de una lista. Nota: La lista no se elimina. Este punto de conexión solo funciona para listas que tienen un processingType de MANUAL o SNAPSHOT.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
listId | True | string |
Identificador de lista. |
Devoluciones
- response
- string
Eliminar un contacto para seguir el RGPD
Elimine permanentemente un contacto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un descuento para seguir el RGPD
Elimine permanentemente un descuento y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un elemento de línea para seguir el RGPD
Elimine permanentemente un elemento de línea y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un envío de comentarios para seguir el RGPD
Elimine permanentemente un envío de comentarios y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un impuesto para seguir el RGPD
Elimine permanentemente un impuesto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un objetivo objetivo para seguir el RGPD
Elimine permanentemente un objetivo y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un producto para seguir el RGPD
Elimine permanentemente un producto y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar un vale para seguir el RGPD
Elimine permanentemente un vale y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar una cita para seguir el RGPD
Elimine permanentemente una cita y todo el contenido asociado para seguir el RGPD. Use la propiedad opcional "ID Property" establecida en "email" para identificar el contacto por dirección de correo electrónico. Si no se encuentra la dirección de correo electrónico, la dirección de correo electrónico se agregará a una lista de bloqueados y evitará que se use en el futuro.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de objeto
|
objectId | string |
Identificador de objeto. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
- response
- string
Eliminar una tarjeta
Elimina permanentemente una definición de tarjeta con el identificador especificado. Una vez eliminados, las solicitudes de captura de datos para esta tarjeta ya no se enviarán al servicio. Esto no se puede deshacer.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de aplicación
|
appId | True | string |
Identificador de la aplicación. |
|
Id. de tarjeta
|
cardId | True | string |
Identificador de tarjeta. |
Devoluciones
- response
- string
Empresas de búsqueda
Recuperar una lista de empresas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar asociaciones para un objeto
Enumera todas las asociaciones de un objeto por tipo de objeto. Limite 500 por llamada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Identificador de objeto. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Tipos de asociación
|
results.associationTypes | array of object | |
|
Categoría
|
results.associationTypes.category | string |
Categoría. |
|
Identificador de tipo
|
results.associationTypes.typeId | string |
Identificador de tipo. |
|
Etiqueta
|
results.associationTypes.label | string |
Etiqueta. |
|
Para el identificador de objeto
|
results.toObjectId | string |
Identificador del objeto To. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar comillas
Recuperar una página de comillas. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar descuentos
Recuperar una página de descuentos. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar envíos de comentarios
Recuperar una página de envíos de comentarios. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Enumerar tipos de asociación
Enumere todos los tipos de asociación válidos disponibles entre dos tipos de objeto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
identificación
|
results.id | string |
Identificador. |
|
Nombre
|
results.name | string |
Nombre. |
Envío de comentarios de búsqueda
Recupera una lista de envíos de comentarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Impuestos de búsqueda
Recuperar una lista de impuestos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Iniciar una exportación
Comienza a exportar datos de CRM para el portal tal como se especifica en el cuerpo de la solicitud.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre de exportación
|
exportName | string |
Nombre de exportación. |
|
|
Tipo de exportación
|
exportType | string |
Tipo de exportación. |
|
|
Formato
|
format | string |
El formato. |
|
|
Language
|
language | string |
Idioma. |
|
|
Propiedades del objeto
|
objectProperties | array of string |
Propiedades del objeto. |
|
|
Tipo de objeto
|
objectType | string |
El objeto tyep. |
|
|
Tipo de objeto asociado
|
associatedObjectType | string |
Tipo de objeto asociado. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Query
|
query | string |
Consulta. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador. |
Iniciar una nueva importación
Comienza a importar datos de los recursos de archivo especificados. Esto carga el archivo correspondiente y usa el objeto de solicitud de importación para convertir filas de los archivos en objetos .
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de contenido
|
Content-Type | True | string |
Tipo de contenido. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Identificadores de archivo
|
metadata.fileIds | array of string |
Identificadores de archivo. |
|
Listas de objetos
|
metadata.objectLists | array of object | |
|
Id. de lista
|
metadata.objectLists.listId | string |
Identificador de lista. |
|
Tipo de objeto
|
metadata.objectLists.objectType | string |
Tipo de objeto. |
|
importación de Opt-Out
|
optOutImport | string |
Importación de exclusión. |
|
Estado
|
state | string |
El estado. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Identificador de plantilla
|
importTemplate.templateId | string |
Identificador de plantilla. |
|
Tipo de plantilla
|
importTemplate.templateType | string |
Tipo de plantilla. |
|
Importar origen
|
importSource | string |
Origen de importación. |
|
Nombre de importación
|
importName | string |
Nombre de importación. |
Leer asociaciones por lotes
Asociaciones de lectura por lotes para objetos a un tipo de objeto específico. El campo 'after' de un objeto de paginación devuelto se puede agregar junto con el 'id' para recuperar la página siguiente de asociaciones de ese objectidentifier. El campo 'link' está en desuso y debe omitirse.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
From (Tipo de objeto)
|
fromObjectType | True | string |
Tipo de objeto From. |
|
Tipo de objeto To
|
toObjectType | True | string |
Tipo de objeto To. |
|
identificación
|
id | string |
Identificador. |
|
|
Después
|
after | string |
Vínculo posterior. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
identificación
|
results.from.id | string |
Identificador. |
|
Para
|
results.to | array of object | |
|
Tipos de asociación
|
results.to.associationTypes | array of object | |
|
Categoría
|
results.to.associationTypes.category | string |
Categoría. |
|
Identificador de tipo
|
results.to.associationTypes.typeId | string |
Identificador de tipo. |
|
Etiqueta
|
results.to.associationTypes.label | string |
Etiqueta. |
|
Para el identificador de objeto
|
results.to.toObjectId | string |
Identificador del objeto To. |
|
Después
|
results.paging.next.after | string |
Vínculo posterior. |
|
Link
|
results.paging.next.link | string |
Vínculo. |
|
Antes
|
results.paging.prev.before | string |
Vínculo anterior. |
|
Link
|
results.paging.prev.link | string |
Vínculo. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Listas de búsqueda
Buscar listas por nombre de lista o página a través de todas las listas proporcionando un valor vacío query .
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades adicionales
|
additionalProperties | array of string |
Propiedades adicionales. |
|
|
Desplazar
|
offset | string |
Desplazamiento. |
|
|
Query
|
query | string |
Consulta. |
|
|
Contar
|
count | string |
Recuento. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Tiene más
|
hasMore | boolean |
Si tiene más. |
|
Lists
|
lists | array of object | |
|
Id. de lista
|
lists.listId | string |
Identificador de lista. |
|
Versión de lista
|
lists.listVersion | string |
La versión de la lista. |
|
Nombre
|
lists.name | string |
Nombre. |
|
Id. de tipo de objeto
|
lists.objectTypeId | string |
Identificador de tipo de objeto. |
|
Estado de procesamiento
|
lists.processingStatus | string |
Estado de procesamiento. |
|
Tipo de procesamiento
|
lists.processingType | string |
Tipo de procesamiento. |
|
Actualizado por identificador
|
lists.updatedById | string |
Actualizado por identificador. |
|
Filtros actualizados en
|
lists.filtersUpdatedAt | string |
Cuando se actualizaron los filtros. |
|
Creado en
|
lists.createdAt | string |
Cuando se crea en . |
|
Eliminado en
|
lists.deletedAt | string |
Cuando se elimina. |
|
Creado por id.
|
lists.createdById | string |
Objeto creado por identificador. |
|
Actualizado en
|
lists.updatedAt | string |
Cuando se actualiza en . |
|
Desplazar
|
offset | string |
Desplazamiento. |
|
Total
|
total | string |
Total. |
Objetivos de búsqueda
Recuperar una lista de destinos de objetivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
Página posterior. |
|
|
Operator
|
operator | string |
Operador . |
|
|
Nombre de propiedad
|
propertyName | string |
Nombre de la propiedad. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Valor alto
|
highValue | string |
Valor alto. |
|
|
Valores
|
values | array of string |
Los valores. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Tipo
|
sorts | array of string |
Ordena. |
|
|
Query
|
query | string |
Consulta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Total
|
total | string |
Total. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtención de empresas por identificador
Recupere un lote de empresas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de errores de importación
Recupere una lista de errores para una importación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Id. de importación
|
importId | True | string |
Identificador de importación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
Tipo de error
|
results.errorType | string |
Tipo de error. |
|
identificación
|
results.id | string |
Identificador. |
|
Id. de archivo
|
results.sourceData.fileId | string |
Identificador de archivo. |
|
Número de línea
|
results.sourceData.lineNumber | string |
Número de línea. |
|
Datos de fila
|
results.sourceData.rowData | array of string |
Datos de fila. |
|
Nombre de página
|
results.sourceData.pageName | string |
Nombre de la página. |
|
Tipo de objeto
|
results.objectType | string |
Tipo de objeto. |
|
Valor no válido
|
results.invalidValue | string |
Valor no válido. |
|
Contexto adicional
|
results.extraContext | string |
Contexto adicional. |
|
Id. de tipo de objeto
|
results.objectTypeId | string |
Identificador de tipo de objeto. |
|
Número de columna conocido
|
results.knownColumnNumber | string |
Número de columna conocido. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtención de importaciones activas
Devuelve una lista paginada de importaciones activas para esta cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Después
|
after | string |
El después. |
|
|
Antes
|
before | string |
Antes. |
|
|
Limit
|
limit | string |
El límite. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Identificadores de archivo
|
results.metadata.fileIds | array of string |
Identificadores de archivo. |
|
Listas de objetos
|
results.metadata.objectLists | array of object | |
|
Id. de lista
|
results.metadata.objectLists.listId | string |
Identificador de lista. |
|
Tipo de objeto
|
results.metadata.objectLists.objectType | string |
Tipo de objeto. |
|
importación de Opt-Out
|
results.optOutImport | string |
Importación de exclusión. |
|
Estado
|
results.state | string |
El estado. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Identificador de plantilla
|
results.importTemplate.templateId | string |
Identificador de plantilla. |
|
Tipo de plantilla
|
results.importTemplate.templateType | string |
Tipo de plantilla. |
|
Importar origen
|
results.importSource | string |
Origen de importación. |
|
Nombre de importación
|
results.importName | string |
Nombre de importación. |
|
Después
|
paging.next.after | string |
El después. |
|
Link
|
paging.next.link | string |
Vínculo. |
|
Antes
|
paging.prev.before | string |
Antes. |
|
Link
|
paging.prev.link | string |
Vínculo. |
Obtención de la información sobre cualquier importación
Resumen completo de un registro de importación, incluidas las actualizaciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de importación
|
importId | True | string |
Identificador de importación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Identificadores de archivo
|
metadata.fileIds | array of string |
Identificadores de archivo. |
|
Listas de objetos
|
metadata.objectLists | array of object | |
|
Id. de lista
|
metadata.objectLists.listId | string |
Identificador de lista. |
|
Tipo de objeto
|
metadata.objectLists.objectType | string |
Tipo de objeto. |
|
importación de Opt-Out
|
optOutImport | string |
Importación de exclusión. |
|
Estado
|
state | string |
El estado. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Identificador de plantilla
|
importTemplate.templateId | string |
Identificador de plantilla. |
|
Tipo de plantilla
|
importTemplate.templateType | string |
Tipo de plantilla. |
|
Importar origen
|
importSource | string |
Origen de importación. |
|
Nombre de importación
|
importName | string |
Nombre de importación. |
Obtención de objetivos
Recuperar una página de destinos de objetivo. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtención de tarifas
Recuperar una página de tarifas. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtención de un lote de destinos de objetivo por identificador
Recupere un lote de destinos de objetivo por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de elementos de línea por identificador
Recupere un lote de elementos de línea por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de objetos por identificador
Recupere un lote de objetos por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de ofertas por identificador
Recupere un lote de ofertas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de productos por identificador
Recupere un lote de productos por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de tarifas por identificador
Recupere un lote de tarifas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un lote de vales por identificador
Recupere un lote de vales por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtención de un objetivo por identificador
Recupere un objeto identificado por goalTargetidentifier. goalTargetId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de destino del objetivo
|
goalTargetId | True | string |
Identificador de destino objetivo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtención de un objeto por identificador
Recupere un objeto identificado por objectidentifier. objectId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
|
Id. de objeto
|
objectId | True | string |
Identificador de objeto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtención de un producto
Recupere un objeto identificado por productidentifier. productId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. del producto
|
productId | True | string |
Identificador del producto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtención de un propietario por identificador
Recupere un propietario mediante un identificador especificado o useridentifier.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
Id. del propietario
|
ownerId | True | string |
Identificador del propietario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Correo Electrónico
|
string |
Dirección de correo electrónico. |
|
|
Nombre
|
firstName | string |
Nombre. |
|
Apellido
|
lastName | string |
Apellidos. |
|
Id. de usuario
|
userId | string |
Identificador de usuario. |
|
Equipos
|
teams | array of object | |
|
identificación
|
teams.id | string |
Identificador. |
|
Nombre
|
teams.name | string |
Nombre. |
|
Primary
|
teams.primary | string |
Principal. |
Obtención de una cuota por identificador
Recupere un objeto identificado por feeidentifier. feeId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de cuota
|
feeId | True | string |
Identificador de la tarifa. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtención de una empresa por identificador
Recupere un objeto identificado por companyidentifier. companyId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de empresa
|
companyId | True | string |
Identificador de la empresa. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtención de una respuesta de detalles de tarjeta de ejemplo
Devuelve una respuesta de detalle de tarjeta de ejemplo. Esta es la carga con los detalles mostrados de una tarjeta que se mostrará a un usuario. Una aplicación debe enviar esto en respuesta a la solicitud de captura de datos.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Recuento total
|
totalCount | string |
Recuento total. |
|
Dirección URL de vínculo de todos los elementos
|
allItemsLinkUrl | string |
Dirección URL del vínculo todos los elementos. |
|
Etiqueta de tarjeta
|
cardLabel | string |
Etiqueta de tarjeta. |
|
Secondary
|
topLevelActions.secondary | array of object | |
|
Método HTTP
|
topLevelActions.secondary.httpMethod | string |
Método HTTP. |
|
Nombres de propiedad incluidos
|
topLevelActions.secondary.propertyNamesIncluded | array of string |
Nombres de propiedad incluidos. |
|
Tipo
|
topLevelActions.secondary.type | string |
Tipo. |
|
URL
|
topLevelActions.secondary.url | string |
Dirección URL. |
|
Cancelar etiqueta de botón
|
topLevelActions.secondary.confirmation.cancelButtonLabel | string |
Etiqueta del botón Cancelar. |
|
Confirmar etiqueta de botón
|
topLevelActions.secondary.confirmation.confirmButtonLabel | string |
Etiqueta del botón confirmar. |
|
Pronto
|
topLevelActions.secondary.confirmation.prompt | string |
Mensaje. |
|
Etiqueta
|
topLevelActions.secondary.label | string |
Etiqueta. |
|
Altura
|
topLevelActions.settings.height | string |
Alto. |
|
Nombres de propiedad incluidos
|
topLevelActions.settings.propertyNamesIncluded | array of string |
Nombres de propiedad incluidos. |
|
Tipo
|
topLevelActions.settings.type | string |
Tipo. |
|
URL
|
topLevelActions.settings.url | string |
Dirección URL. |
|
Ancho
|
topLevelActions.settings.width | string |
Ancho. |
|
Etiqueta
|
topLevelActions.settings.label | string |
Etiqueta. |
|
Método HTTP
|
topLevelActions.primary.httpMethod | string |
Método HTTP. |
|
Nombres de propiedad incluidos
|
topLevelActions.primary.propertyNamesIncluded | array of string |
Nombres de propiedad incluidos. |
|
Tipo
|
topLevelActions.primary.type | string |
Tipo. |
|
URL
|
topLevelActions.primary.url | string |
Dirección URL. |
|
Cancelar etiqueta de botón
|
topLevelActions.primary.confirmation.cancelButtonLabel | string |
Etiqueta del botón Cancelar. |
|
Confirmar etiqueta de botón
|
topLevelActions.primary.confirmation.confirmButtonLabel | string |
Etiqueta del botón confirmar. |
|
Pronto
|
topLevelActions.primary.confirmation.prompt | string |
Mensaje. |
|
Etiqueta
|
topLevelActions.primary.label | string |
Etiqueta. |
|
Secciones
|
sections | array of object | |
|
Acciones
|
sections.actions | array of object | |
|
Método HTTP
|
sections.actions.httpMethod | string |
Método HTTP. |
|
Nombres de propiedad incluidos
|
sections.actions.propertyNamesIncluded | array of string |
Nombres de propiedad incluidos. |
|
Tipo
|
sections.actions.type | string |
Tipo. |
|
URL
|
sections.actions.url | string |
Dirección URL. |
|
Cancelar etiqueta de botón
|
sections.actions.confirmation.cancelButtonLabel | string |
Etiqueta del botón Cancelar. |
|
Confirmar etiqueta de botón
|
sections.actions.confirmation.confirmButtonLabel | string |
Etiqueta del botón confirmar. |
|
Pronto
|
sections.actions.confirmation.prompt | string |
Mensaje. |
|
Etiqueta
|
sections.actions.label | string |
Etiqueta. |
|
identificación
|
sections.id | string |
Identificador. |
|
Title
|
sections.title | string |
Título. |
|
Tokens
|
sections.tokens | array of object | |
|
Importancia
|
sections.tokens.value | string |
Valor. |
|
Nombre
|
sections.tokens.name | string |
Nombre. |
|
Etiqueta
|
sections.tokens.label | string |
Etiqueta. |
|
Tipo de datos
|
sections.tokens.dataType | string |
Tipo de datos. |
|
Dirección URL del vínculo
|
sections.linkUrl | string |
Dirección URL del vínculo. |
|
Versión de respuesta
|
responseVersion | string |
La versión de respuesta. |
Obtención del estado del identificador de tarea
Recupere el estado de un identificador de tarea.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de la tarea
|
taskId | True | string |
Identificador de tarea. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Resultado
|
result | string |
Resultado. |
|
Errors
|
numErrors | string |
Número de errores. |
|
Errors
|
errors | array of object | |
|
Categoría
|
errors.category | string |
Categoría. |
|
Errors
|
errors.errors | array of object | |
|
Message
|
errors.errors.message | string |
Mensaje. |
|
In
|
errors.errors.in | string |
La parte de adentro. |
|
Código
|
errors.errors.code | string |
El código. |
|
Sub categoría
|
errors.errors.subCategory | string |
Sub categoría. |
|
Message
|
errors.message | string |
Mensaje. |
|
Estado
|
errors.status | string |
Estado. |
|
identificación
|
errors.id | string |
Identificador. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener contactos
Recuperar una página de contactos. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener elemento de línea
Recupere un objeto identificado por lineItemidentifier. lineItemId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de elemento de línea
|
lineItemId | True | string |
Identificador del elemento de línea. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener elementos de línea
Recuperar una página de elementos de línea. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener empresas
Recuperar una página de empresas. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener impuestos
Recuperar una página de impuestos. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener objetos
Recuperar una página de objetos. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
Tipo de objeto
|
objectType | True | string |
Tipo de objeto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener ofertas
Recuperar una página de ofertas. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener productos
Recuperar una página de productos. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener propietarios
Recuperar una lista de propietarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
|
|
Después
|
after | string |
Página posterior. |
|
|
Limit
|
limit | string |
El límite. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Correo Electrónico
|
results.email | string |
Dirección de correo electrónico. |
|
Nombre
|
results.firstName | string |
Nombre. |
|
Apellido
|
results.lastName | string |
Apellidos. |
|
Id. de usuario
|
results.userId | string |
Identificador de usuario. |
|
Equipos
|
results.teams | array of object | |
|
identificación
|
results.teams.id | string |
Identificador. |
|
Nombre
|
results.teams.name | string |
Nombre. |
|
Primary
|
results.teams.primary | string |
Principal. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Obtener todas las tarjetas
Devuelve una lista de tarjetas para una aplicación determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de aplicación
|
appId | True | string |
Identificador de la aplicación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Direcciones URL base
|
results.actions.baseUrls | array of string |
Direcciones URL base. |
|
Historial de auditoría
|
results.auditHistory | array of object | |
|
Tipo de acción
|
results.auditHistory.actionType | string |
Tipo de acción. |
|
Id. de solicitud
|
results.auditHistory.applicationId | string |
Identificador de la aplicación. |
|
Origen de autenticación
|
results.auditHistory.authSource | string |
Origen de autorización. |
|
Se ha cambiado en
|
results.auditHistory.changedAt | string |
Cuando se cambia. |
|
Inicio del identificador de usuario
|
results.auditHistory.initiatingUserId | string |
Identificador de usuario que inicia. |
|
Id. de tipo de objeto
|
results.auditHistory.objectTypeId | string |
Identificador de tipo de objeto. |
|
Propiedades
|
results.display.properties | array of object | |
|
Tipo de datos
|
results.display.properties.dataType | string |
Tipo de datos. |
|
Etiqueta
|
results.display.properties.label | string |
Etiqueta. |
|
Nombre
|
results.display.properties.name | string |
Nombre. |
|
Options
|
results.display.properties.options | array of object | |
|
Etiqueta
|
results.display.properties.options.label | string |
Etiqueta. |
|
Nombre
|
results.display.properties.options.name | string |
Nombre. |
|
Tipo
|
results.display.properties.options.type | string |
Tipo. |
|
Tipos de objeto
|
results.fetch.objectTypes | array of object | |
|
Nombre
|
results.fetch.objectTypes.name | string |
Nombre. |
|
Propiedades que se van a enviar
|
results.fetch.objectTypes.propertiesToSend | array of string |
Propiedades que se van a enviar. |
|
Dirección URL de destino
|
results.fetch.targetUrl | string |
Dirección URL de destino. |
|
identificación
|
results.id | string |
Identificador. |
|
Title
|
results.title | string |
Título. |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
Obtener un contacto por identificador
Recupere un objeto identificado por contactidentifier. contactId hace referencia al identificador de objeto interno. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID de contacto
|
contactId | True | string |
Identificador de contacto. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
|
Results
|
associations.etc.results | array of object | |
|
identificación
|
associations.etc.results.id | string |
Identificador. |
|
Tipo
|
associations.etc.results.type | string |
Tipo. |
|
Después
|
associations.etc.paging.next.after | string |
Página posterior. |
|
Link
|
associations.etc.paging.next.link | string |
Página del vínculo. |
|
Antes
|
associations.etc.paging.prev.before | string |
Página anterior. |
|
Link
|
associations.etc.paging.prev.link | string |
Página del vínculo. |
Obtener un descuento
Recupere un objeto identificado por discountidentifier. discountId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de descuento
|
discountId | True | string |
El identificador del descuento. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener un envío de comentarios
Recupere un objeto identificado por feedbackSubmissionidentifier. feedbackSubmissionId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de envío de comentarios
|
feedbackSubmissionId | True | string |
Identificador de envío de comentarios. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener un impuesto por identificador
Recupere un objeto identificado por taxidentifier. taxId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. fiscal
|
taxId | True | string |
Identificador fiscal. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener un lote de comillas por identificador
Recupere un lote de comillas por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener un lote de contactos por identificador
Recupere un lote de contactos por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener un lote de descuentos por identificador
Recupere un lote de descuentos por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener un lote de envíos de comentarios por identificador
Recupere un lote de envíos de comentarios por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener un lote de impuestos por identificador
Recupere un lote de impuestos por identificador interno o valores de propiedad únicos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
identificación
|
id | string |
Identificador. |
|
|
Propiedades
|
properties | array of string |
El objeto properties. |
|
|
Propiedades con historial
|
propertiesWithHistory | array of string |
Propiedades con el objeto history. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Completado en
|
completedAt | string |
Cuando se complete en. |
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Iniciado en
|
startedAt | string |
Cuando se inicia en. |
|
Estado
|
status | string |
Estado. |
|
Solicitado en
|
requestedAt | string |
Cuando se solicite en . |
Obtener un vale
Recupere un objeto identificado por ticketidentifier. ticketId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de vale
|
ticketId | True | string |
Identificador del vale. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener una oferta
Recupere un objeto identificado por dealidentifier. dealId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Identificador de la oferta
|
dealId | True | string |
Identificador de la oferta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener una oferta por identificador
Recupere un objeto identificado por quoteidentifier. quoteId hace referencia al identificador de objeto interno de forma predeterminada o, opcionalmente, a cualquier valor de propiedad único especificado por el parámetro de consulta idProperty. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
|
|
ID (propiedad)
|
idProperty | string |
Propiedad de identificador. |
|
|
Id. de cita
|
quoteId | True | string |
Identificador de comillas. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
identificación
|
id | string |
Identificador. |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
archived | boolean |
Si está archivado. |
|
Archivado en
|
archivedAt | string |
Cuando se archiva. |
Obtener una tarjeta
Devuelve la definición de una tarjeta con el identificador especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de aplicación
|
appId | True | string |
Identificador de la aplicación. |
|
Id. de tarjeta
|
cardId | True | string |
Identificador de tarjeta. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Direcciones URL base
|
actions.baseUrls | array of string |
Direcciones URL base. |
|
Historial de auditoría
|
auditHistory | array of object | |
|
Tipo de acción
|
auditHistory.actionType | string |
Tipo de acción. |
|
Id. de solicitud
|
auditHistory.applicationId | string |
Identificador de la aplicación. |
|
Origen de autorización
|
auditHistory.authSource | string |
Origen de autorización. |
|
Se ha cambiado en
|
auditHistory.changedAt | string |
Cuando se cambia. |
|
Inicio del identificador de usuario
|
auditHistory.initiatingUserId | string |
Identificador de usuario que inicia. |
|
Id. de tipo de objeto
|
auditHistory.objectTypeId | string |
Identificador de tipo de objeto. |
|
Propiedades
|
display.properties | array of object | |
|
Tipo de datos
|
display.properties.dataType | string |
Tipo de datos. |
|
Etiqueta
|
display.properties.label | string |
Etiqueta. |
|
Nombre
|
display.properties.name | string |
Nombre. |
|
Options
|
display.properties.options | array of object | |
|
Etiqueta
|
display.properties.options.label | string |
Etiqueta. |
|
Nombre
|
display.properties.options.name | string |
Nombre. |
|
Tipo
|
display.properties.options.type | string |
Tipo. |
|
Tipos de objeto
|
fetch.objectTypes | array of object | |
|
Nombre
|
fetch.objectTypes.name | string |
Nombre. |
|
Propiedades que se van a enviar
|
fetch.objectTypes.propertiesToSend | array of string |
Propiedades que se van a enviar. |
|
Dirección URL de destino
|
fetch.targetUrl | string |
Dirección URL de destino. |
|
identificación
|
id | string |
Identificador. |
|
Title
|
title | string |
Título. |
|
Creado en
|
createdAt | string |
Cuando se crea en . |
|
Actualizado en
|
updatedAt | string |
Cuando se actualiza en . |
Obtener vales
Recuperar una página de vales. Controle lo que se devuelve a través del parámetro de consulta properties.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | string |
El límite. |
|
|
Después
|
after | string |
El después. |
|
|
Propiedades
|
properties | string |
Propiedades. |
|
|
Propiedades con historial
|
propertiesWithHistory | string |
Propiedades con historial. |
|
|
Associations
|
associations | string |
Las asociaciones. |
|
|
Archivado
|
archived | boolean |
Si se devuelven solo los resultados que se han archivado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Creado en
|
results.createdAt | string |
Cuando se crea en . |
|
identificación
|
results.id | string |
Identificador. |
|
Actualizado en
|
results.updatedAt | string |
Cuando se actualiza en . |
|
Archivado
|
results.archived | boolean |
Si está archivado. |
|
Archivado en
|
results.archivedAt | string |
Cuando se archiva. |
|
Después
|
paging.next.after | string |
Página posterior. |
|
Link
|
paging.next.link | string |
Vínculo. |
Quitar registros de una lista
Quite los registros proporcionados de la lista. Los registros que no existen o que no son miembros de la lista se omiten. Este punto de conexión solo funciona para listas que tienen un processingType de MANUAL o SNAPSHOT.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
listId | True | string |
Identificador de lista. |
|
body
|
body | True | array of string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Faltan identificadores de registro
|
recordIdsMissing | array of string |
Faltan los identificadores de registro. |
|
Identificadores de registro quitados
|
recordIdsRemoved | array of string |
Se han quitado los identificadores de registro. |
|
Identificadores de registro agregados
|
recordsIdsAdded | array of string |
Identificadores de registro agregados. |
Definiciones
cuerda / cadena
Este es el tipo de datos básico "string".