Ignorar e ir ao conteúdo principal

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).

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}, onde lineItemId é 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çãoParâmetro
propertiesUma 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.
propertiesWithHistoryUma 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:

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 propriedadeRótulo na UIDescrição
nameNomeO nome do item de linha.
descriptionDescriçãoA descrição completa do produto
hs_skuSKUIdentificador exclusivo do produto
hs_recurring_billing_start_dateData de início da cobrançaData de início de cobrança recorrente para um item de linha
hs_recurring_billing_end_dateData final de cobrançaData final de cobrança recorrente para um item de linha
recurringbillingfrequencyFrequência de cobrançaCom 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.
quantityQuantidadeQuantas unidades de um produto estão incluídas nesse item de linha
pricePreço unitárioO custo do produto
amountPreço líquidoO custo total do item de linha (ou seja, a quantidade vezes o preço unitário).
currencyMoedaCódigo da moeda do item de linha