Última modificación: 2 de diciembre de 2025
Run in Postman
Requisitos de ámbito
Requisitos de ámbito
Permisos necesarios
Dependiendo de los endpoints que pienses utilizar, tendrás que autorizar los siguientes permisos:crm.objects.line_items.read: proporciona acceso para recuperar datos de elementos de pedido.crm.objects.line_items.write: proporciona acceso para crear y actualizar elementos de pedido.tax_rates.read: proporciona acceso para recuperar los datos de las tasas de impuestos que hayas configurado en tu cuenta.
Crear un elemento de pedido
Para crear un elemento de pedido, haz una solicitudPOST a /crm/v3/objects/line_items. En el cuerpo de la solicitud, incluye los detalles del elemento de pedido, como su nombre, la cantidad y el precio. También puedes incluir datos adicionales en el cuerpo de la solicitud:
- Para crear un elemento de pedido basado en un producto existente (creado a través de la API de productos o n HubSpot), incluye
hs_product_iden el cuerpo de la solicitud. - Para incluir la tasa de impuestos de tu elemento de pedido, incluye su ID como
hs_tax_rate_group_iden el campopropertiesdel cuerpo de la solicitud. - También puedes asociar el elemento de pedido con negocios, cotizaciones, facturas, enlaces de pago o suscripciones, incluyendo una matriz de
associationsen el cuerpo de la solicitud. Por ejemplo, el cuerpo de la siguiente solicitud crearía un elemento de pedido llamado “New standalone line item” (Nuevo elemento de pedido independiente) que está asociado con un negocio (ID:12345).
Obtener un elemento de pedido
Puedes obtener elementos de pedido de forma individual o en bloque.- Para obtener un elemento de pedido específico, haz una solicitud
GETa/crm/v3/objects/line_items/{lineItemId}, dondelineItemIdes el ID del elemento de pedido. - Para obtener todos los elementos de pedido, haz una solicitud
GETa/crm/v3/objects/line_items.
| Parámetro | Descripción |
|---|---|
properties | Una lista separada con 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 pedido
Para actualizar un elemento de pedido, haz una solicitudPATCH a /crm/v3/objects/line_items/{lineItemId}, donde lineItemId es el ID del elemento de pedido.
En el cuerpo de la solicitud, incluye los valores de propiedad que quieres actualizar. No puedes actualizar asociaciones con este método. En su lugar, deberás usar la API de asociaciones.
Por ejemplo, el cuerpo de la solicitud puede tener un aspecto similar al siguiente:
Eliminar un elemento de pedido
Para eliminar un elemento de pedido, haz una solicitudDELETE a /crm/v3/objects/line_items/{lineItemId}, donde lineItemId es el ID del elemento de pedido.
Propiedades de los elementos de pedido
Al gestionar los datos de los elementos de pedido, puede que quieras usar algunas de las propiedades comunes de esta tabla. Para obtener todas las propiedades de los elementos de pedido, haz una solicitudGET a /crm/v3/properties/line_item. Consulta más información sobre el uso de la API de propiedades.
| Nombre de la propiedad | Etiqueta en la interfaz de usuario | Descripción |
|---|---|---|
name | Nombre | El nombre del elemento de pedido. |
description | Descripción | Descripción completa del producto |
hs_sku | SKU | Identificador único del producto |
hs_recurring_billing_start_date | Fecha de inicio de la facturación | Facturación recurrente de un elemento de pedido |
hs_recurring_billing_end_date | Fecha de finalización de la facturación | Facturación recurrente de un elemento de pedido |
recurringbillingfrequency | Frecuencia de facturación | Con qué frecuencia se factura un elemento de pedido con facturación periódica. Indica el cálculo de precios para negocios y cotizaciones. Los elementos de pedido con facturación única no están incluidos. |
quantity | Cantidad | Cuántas unidades de un producto hay en este elemento de pedido |
price | Precio unitario | El coste del producto |
amount | Precio neto | El coste total del elemento de pedido (es decir, la cantidad multiplicada por el precio unitario). |
hs_line_item_currency_code | Divisa | Código de la divisa del elemento de pedido |
Recuperar tasas de impuestos
Puedes aplicar una tasa de impuestos a elementos de pedido individuales (por ejemplo, un impuesto sobre las ventas de MA del 6,26%). Una vez que hayas configurado tu biblioteca de tasas de impuestos en tu cuenta de HubSpot, puedes hacer una solicitudGET a /tax-rates/v1/tax-rates para obtener todos las tasas de impuestos, o a /tax-rates/v1/tax-rates/{taxRateId} para obtener una tasa de impuestos por su ID. Tu aplicación tendrá que autorizar el permiso tax_rates.read para realizar esta solicitud.
La respuesta tendrá el siguiente formato:
| Tipo de propiedad | Descripción |
|---|---|
name | El descriptor interno de la tasa de impuestos. |
percentageRate | El valor de la tasa de impuestos, expresado en porcentaje. |
label | El descriptor de la tasa de impuestos orientado al comprador, que se muestra en la cotización, factura u otros objetos padre. |
active | Un booleano que indica si la tasa de impuestos puede aplicarse a una nueva cotización o factura. Puedes ajustarlo a false para una tasa de impuestos de un año anterior que ya no es aplicable. |
id | El ID de la tasa de impuestos. |
createdAt | Una marca de tiempo ISO 8601 que indica cuándo se creó la tasa de impuestos. |
updatedAt | Una marca de tiempo ISO 8601 que indica cuándo se actualizó por última vez la tasa de impuestos. |
id para el hs_tax_rate_group_id dentro del campo properties al crear un elemento de pedido. Más información sobre la creación de elementos de pedido en la sección anterior.