Elementos de línea

ResumenPuntos de terminación

En HubSpot, los elementos de línea son instancias individuales de los productos. Cuando un producto está adjunto a un negocio, se convierte en elemento de línea. Puedes crear elementos de línea únicos para una cotización individual, pero no se agregarán a tu biblioteca de productos. Los puntos de terminación de elementos de línea permiten administrar estos datos y sincronizarlos entre HubSpot y otros sistemas.

Ejemplo de uso: al crear un conjunto de cotizaciones para que los representantes de ventas las envíen a compradores potenciales, puedes usar esta API para crear elementos de línea independientes por cotización, así como elementos de línea que se adjuntan a productos existentes.

Crear un elemento de línea

Para crear un elemento de línea, haz una solicitud POST en /crm/v3/objects/line_items. En el cuerpo de la publicación, incluye los detalles del elemento de línea, como el nombre, la cantidad y el precio. Para crear un elemento de línea basado en un producto existente (creado a través de la API de productos o en HubSpot), incluye hs_product_id en el cuerpo de la publicación. 

También puedes asociar el elemento de línea con negocios y cotizaciones al incluir una matriz de asociaciones en el cuerpo de la publicación. Por ejemplo, el siguiente cuerpo de publicación crearía un elemento de línea llamado "Nuevo elemento de línea independiente" que está asociado con un negocio (ID: 12345) y una cotización (ID: 67890).

// POST request to https://api.hubapi.com/crm/v3/objects/line_item { "properties": { "price": 10, "quantity": 1, "name": "New standalone line item" }, "associations": [ { "to": { "id": 12345 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 20 } ] }, { "to": { "id": 67890 }, "types": [ { "associationCategory": "HUBSPOT_DEFINED", "associationTypeId": 68 } ] } ] }

Please note: the line items Term property (hs_recurring_billing_period) accepts ISO-8601 period formats of PnYnMnD and PnW.

Recuperar un elemento de línea

Puedes recuperar elementos de línea individualmente o en masa.

  • Para recuperar un elemento de línea específico, realiza una solicitud GET en /crm/v3/objects/line_items/{lineItemId}, donde lineItemId es el ID del elemento de línea.
  • Para recuperar todos los elementos de línea, haz una solicitud GET en /crm/v3/objects/line_items. 
En la URL de la solicitud, puedes incluir los siguientes parámetros:
Use this table to describe parameters / fields
ParameterDescription
propiedades

Una lista separada por comas de las propiedades que se devolverán en la respuesta. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.

propertiesWithHistory

Una lista separada por comas de las propiedades que se devolverán junto con su historial de valores anteriores. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.

Actualizar un elemento de línea

Para actualizar un elemento de línea, realiza una solicitud PATCH en /crm/v3/objects/line_items/{lineItemId}, donde lineItemId es el ID del elemento de línea.

En el cuerpo de la publicación, incluye los valores de propiedad que deseas actualizar. No puedes actualizar asociaciones a través de este método. En su lugar, deberás usar la API de asociaciones.

Por ejemplo, el cuerpo de tu solicitud puede tener un aspecto similar al siguiente:

// PATCH request to https://api.hubapi.com/crm/v3/objects/line_item/{lineItemId} { "properties": { "price": 25, "quantity": 3, "name": "Updated line item" }

Eliminar un elemento de línea

Para eliminar un elemento de línea, realiza una solicitud DELETE en /crm/v3/objects/line_items/{lineItemId}, donde lineItemId es el ID del elemento de línea.

¿Te resultó útil este artículo?
Con este formulario puedes enviar tu opinión sobre nuestros documentos para desarrolladores. Si tienes comentarios sobre el producto de HubSpot, puedes enviarlos al Foro de ideas.