No HubSpot, os itens de linha são instâncias individuais de produtos. Quando um produto é anexado a um negócio, ele se torna um item de linha. Você pode criar itens de linha exclusivos para um orçamento individual, mas eles não serão adicionados à biblioteca de produtos. Os pontos de extremidade dos itens de linha permitem gerenciar esses dados e sincronizá-los entre o HubSpot e outros sistemas.
Exemplo de caso de uso: ao criar um conjunto de orçamentos para os representantes de vendas enviarem aos compradores em potencial, você pode usar essa API para criar itens de linha independentes por orçamento, bem como itens de linha anexados a produtos existentes.
Para criar um item de linha, faça uma solicitação POST
para /crm/v3/objects/line_items
. No corpo do post, inclua os detalhes do item de linha, como nome, quantidade e preço.
Para criar um item de linha com base em um produto existente (criado por meio da API de produtos ou no HubSpot), inclua hs_product_id
no corpo do post.
Você também pode associar o item de linha a negócios, orçamentos, faturas, links de pagamento ou assinaturas, incluindo uma matriz de associations
no corpo da solicitação post. Por exemplo, o corpo do post abaixo criaria um item de linha chamado "Novo item de linha independente", associado a um negócio (ID: 12345
).
// 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
}
]
Observação:
- Os itens de linha pertencem a um único objeto principal. Ao associar objetos, os itens de linha devem ser individuais para cada objeto. Por exemplo, se estiver criando um negócio e um orçamento, você deverá criar um conjunto de itens de linha para o negócio e outro conjunto para o orçamento. Isso ajudará a otimizar os dados do CRM em todos os objetos e evitará a perda inesperada de dados se for necessário modificar os itens de linha (por exemplo, excluir um orçamento excluirá os itens de linha dele e, se esses itens de linha estiverem associados a um negócio, os itens de linha do negócio também serão excluídos).
- O
price
especificado no campoproperties
não pode ser negativo. - A propriedade Prazo dos itens de linha (
hs_recurring_billing_period
) aceita os formatos de período ISO-8601 de PnYnMnD e PnW.
Você pode recuperar itens de linha individualmente ou em massa.
- Para recuperar um item de linha específico, faça uma solicitação
GET
para/crm/v3/objects/line_items/{lineItemId}
, ondelineItemId
é o ID do item de linha. - Para recuperar todos os itens de linha, faça uma solicitação
GET
para/crm/v3/objects/line_items
.
No URL de solicitação, você pode incluir os seguintes parâmetros:
Descrição | Parâmetro |
---|---|
properties | Uma lista separada por vírgulas das propriedades a serem retornadas em resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada. |
propertiesWithHistory | Uma lista separada por vírgulas das propriedades a serem retornadas, junto com seu histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada. |
Para atualizar um item de linha, faça uma solicitação PATCH
para /crm/v3/objects/line_items/{lineItemId}
, onde lineItemId
é o ID do item de linha.
No corpo do post, inclua os valores de propriedade que você deseja atualizar. Você não pode atualizar associações com esse método. Em vez disso, você precisará usar a API de associações.
Por exemplo, o corpo da sua solicitação pode ser parecido com o seguinte:
xxxxxxxxxx
// PATCH request to https://api.hubapi.com/crm/v3/objects/line_item/{lineItemId}
{
"properties": {
"price": 25,
"quantity": 3,
"name": "Updated line item"
}
Para excluir um item de linha, faça uma solicitação DELETE
para /crm/v3/objects/line_items/{lineItemId}
, onde lineItemId
é o ID do item de linha.
Ao gerenciar os dados do item de linha, convém usar algumas das propriedades comuns da tabela abaixo. Para obter todas as propriedades de item de linha, faça uma solicitação GET
para /crm/v3/properties/line_item
. Saiba mais sobre como usar a API de propriedades.
Nome da propriedade | Rótulo na UI | Descrição |
---|---|---|
name | Nome | O nome do item de linha. |
description | Descrição | A descrição completa do produto |
hs_sku | SKU | Identificador exclusivo do produto |
hs_recurring_billing_start_date | Data de início da cobrança | Data de início de cobrança recorrente para um item de linha |
hs_recurring_billing_end_date | Data final de cobrança | Data final de cobrança recorrente para um item de linha |
recurringbillingfrequency | Frequência de cobrança | Com que frequência um item de linha com cobrança recorrente é cobrado. Informa o cálculo de preços para negócios e orçamentos. Itens de linha com cobrança única não estão incluídos. |
quantity | Quantidade | Quantas unidades de um produto estão incluídas nesse item de linha |
price | Preço unitário | O custo do produto |
amount | Preço líquido | O custo total do item de linha (ou seja, a quantidade vezes o preço unitário). |
currency | Moeda | Código da moeda do item de linha |