Itens de linha

Visão geralEndpoints

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

Criar um item de linha

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 e orçamentos, incluindo uma matriz de associations no corpo do 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) e a um orçamento (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 } ] } ] }

Observação:

  • O price especificado no campo properties não pode ser negativo.
  • A propriedade Termo dos itens de linha (hs_recurring_billing_period) aceita os formatos de período ISO-8601 de PnYnMnD e PnW.

Recuperar um item de linha

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:
Use this table to describe parameters / fields
ParameterDescription
propriedades

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.

Criar um item de linha

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:

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

Excluir um item de linha

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.

Este artigo foi útil?
Este formulário deve ser usado apenas para fazer comentários sobre esses artigos. Saiba como obter ajuda para usar a HubSpot..