Wenn ein Produkt einem Deal zugeordnet wird, wird es zu einem Artikel. Die Artikel-Endpunkte ermöglichen es Ihnen, diese Daten zu verwalten und zu synchronisieren.
crm.objects.line_items.read
: Ermöglicht Zugriff auf das Abrufen von Artikeldaten.crm.objects.line_items.write
: Ermöglicht Zugriff auf das Erstellen und Aktualisieren von Artikeln.tax_rates.read
: Ermöglicht Zugriff auf den Abruf von Steuersätzen, die Sie in Ihrem Account konfiguriert haben.POST
-Anfrage an /crm/v3/objects/line_items
vor. Geben Sie im Beitragstext die Details des Artikels an, z. B. Name, Menge und Preis. Sie können auch zusätzliche Daten in den Anforderungstext aufnehmen:
hs_product_id
in den Beitragstext ein.hs_tax_rate_group_id
im properties
-Feld des Anforderungstextes an.associations
-Array in den Beitragstext einfügen. Zum Beispiel würde der Beitragstext unten einen Artikel namens „New standalone line item“ (Neuer eigenständiger Artikel) erstellen, der einem Deal (ID: 12345
) zugeordnet ist.properties
-Feld angegebene price
darf nicht negativ sein.hs_recurring_billing_period
) akzeptiert die ISO-8601-Zeitraumformate PnYnMnD und PnW.GET
-Anfrage an /crm/v3/objects/line_items/{lineItemId}
durch, wobei lineItemId
die ID des Artikels ist.GET
-Anfrage an /crm/v3/objects/line_items
durch.Parameter | Beschreibung |
---|---|
properties | Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn eine der angegebenen Eigenschaften in dem/den angefragten Objekt(en) nicht vorhanden ist, wird sie ignoriert. |
propertiesWithHistory | Eine durch Kommas getrennte Liste der Eigenschaften, die zusammen mit ihrem Verlauf an vorherigen Werten zurückgegeben werden sollen. Wenn eine der angegebenen Eigenschaften in dem/den angefragten Objekt(en) nicht vorhanden ist, wird sie ignoriert. |
PATCH
-Anfrage an /crm/v3/objects/line_items/{lineItemId}
durch, wobei lineItemId
die ID des Artikels ist.
Schließen Sie im Text des Beitrags die Eigenschaftswerte ein, die Sie aktualisieren möchten. Sie können keine Zuordnungen über dieses Verfahren aktualisieren. Stattdessen müssen Sie die Zuordnungen-API verwenden.
Ihr Anforderungstext kann beispielsweise wie folgt aussehen:
DELETE
-Anfrage an /crm/v3/objects/line_items/{lineItemId}
durch, wobei lineItemId
die ID des Artikels ist.
GET
-Anfrage an /crm/v3/properties/line_item
durch. Hier erfahren Sie mehr über die Verwendung der Eigenschaften-API.
Eigenschaftsname | Label in UI | Beschreibung |
---|---|---|
name | Name | Der Name des Artikels |
description | Beschreibung | Ausführliche Beschreibung des Produkts |
hs_sku | Bestandseinheit | Eindeutige Produkt-ID |
hs_recurring_billing_start_date | Abrechnungsstartdatum | Startdatum bei wiederkehrender Abrechnung für einen Artikel |
hs_recurring_billing_end_date | Abrechnungsenddatum | Enddatum bei wiederkehrender Abrechnung für einen Artikel |
recurringbillingfrequency | Abrechnungsfrequenz | Wie oft ein Artikel mit wiederkehrender Abrechnung abgerechnet wird. Dies informiert über die Preiskalkulation für Deals und Angebote. Artikel mit einmaliger Abrechnung sind nicht enthalten. |
quantity | Menge | Wie viele Einheiten eines Produkts in diesem Artikel enthalten sind |
price | Einzelpreis | Die Kosten des Produkts |
amount | Nettopreis | Die Gesamtkosten des Artikels (d. h., die Menge multipliziert mit dem Einheitenpreis) |
hs_line_item_currency_code | Währung | Währungscode für den Artikel |
GET
-Anfrage an /tax-rates/v1/tax-rates
vornehmen, um alle Steuersätze abzurufen, oder an /tax-rates/v1/tax-rates/{taxRateId}
, um einen Steuersatz anhand seiner ID abzurufen. Ihre App muss den tax_rates.read
-Bereich autorisieren, um diese Anfrage vorzunehmen.
Die resultierende Antwort sieht etwa so aus:
Eigenschaftstyp | Beschreibung |
---|---|
name | Der interne Deskriptor für den Steuersatz |
percentageRate | Die Höhe des Steuersatzes in Prozent |
label | Der dem Käufer angezeigte Deskriptor des Steuersatzes, der in dem Angebot, der Rechnung oder anderen übergeordneten Objekten angezeigt wird |
active | Ein boolescher Wert, der angibt, ob der Steuersatz auf ein neues Angebot oder eine neue Rechnung angewendet werden kann. Sie könnten z. B. den Steuersatz eines früheren Jahres, der nicht mehr anwendbar ist, als false festlegen. |
id | Die ID des Steuersatzes |
createdAt | Ein ISO 8601-Zeitstempel, der angibt, wann der Steuersatz erstellt wurde |
updatedAt | Ein ISO 8601-Zeitstempel, der angibt, wann der Steuersatz zuletzt aktualisiert wurde |
id
für die hs_tax_rate_group_id
im properties
-Feld an, wenn Sie einen Artikel erstellen. Erfahren Sie im Abschnitt weiter oben mehr über das Erstellen von Artikeln.