Angebote werden verwendet, um Preisinformationen mit potenziellen Kunden zu teilen. Die Angebote-Endpunkte ermöglichen es Ihnen, diese Daten abzurufen und zwischen HubSpot und anderen Systemen zu synchronisieren.
POST
-Anfrage an/crm/v3/objects/quotes
durchführen. Später führen Sie einen separaten Aufruf durch, um das Angebot anderen Objekten zuzuordnen, z. B. der Angebotsvorlage, Artikeln oder einem Deal.
Parameter | Typ | Beschreibung |
---|---|---|
hs_title | Zeichenfolge | Der Name des Angebots. |
hs_expiration_date | Zeichenfolge | Das Datum, an dem das Angebot abläuft. |
GET
-Anfrage an crm/v3/properties/quotes
durch. Erfahren Sie mehr über die Eigenschaften-API.
Die Antwort enthält eine id
, mit der Sie das Angebot weiter konfigurieren können. Sie können Angebotseigenschaften jederzeit aktualisieren, indem Sie eine PATCH
-Anfrage an /crm/v3/objects/quotes/{quoteId}
durchführen.
hubspot_owner_id
-Eigenschaft ist nicht möglich, da es sich um eine berechnete Eigenschaft handelt; alle Werte werden überschrieben. Bei der Verwendung von Angeboten funktioniert die Eigenschaft wie folgt:
hubspot_owner_id
-Eigenschaft die hs_associated_deal_owner_id
-Eigenschaft wider (hs_associated_deal_owner_id
ist eine berechnete Eigenschaft).hubspot_owner_id
-Eigenschaft die hs_quote_owner_id
-Eigenschaft wider.hs_esign_enabled
in Ihren Anforderungstext mit dem Wert true
ein. Beachten Sie, dass Sie keine Gegenzeichner über die API hinzufügen können. Daher müssen diese vor der Veröffentlichung des Angebots in HubSpot hinzugefügt werden. Sie können auch kein Angebot mit aktivierter eSignature veröffentlichen, wenn Sie Ihr monatliches eSignature-Limit überschritten haben.
hs_payment_enabled
mit dem Wert true
in Ihren Anforderungstext ein. Abhängig von Ihrem Zahlungsabwickler und den akzeptierten Zahlungsmethoden müssen Sie außerdem auch hs_payment_type
und hs_allowed_payment_methods
festlegen.
Parameter | Typ | Beschreibung |
---|---|---|
hs_payment_enabled | Boolesch | Wenn diese Einstellung auf true gesetzt ist, kann das Angebot Zahlungen entweder über das Payments-Tool von HubSpot oder die Stripe-Zahlungsabwicklung einziehen. Die Standardeinstellung ist false . |
hs_payment_type | Aufzählung | Legt fest, welcher Zahlungsabwickler verwendet werden soll. Wert kann entweder HUBSPOT oder BYO_STRIPE sein. |
hs_allowed_payment_methods | Aufzählung | Die zu verwendenden Zahlungsmethoden (z. B. Kreditkarte). |
hs_collect_billing_address | Boolesch | Wenn diese Option auf true festgelegt ist, kann der Käufer seine Rechnungsadresse während des Checkouts eingeben. |
hs_collect_shipping_address | Boolesch | Wenn diese Option auf true gesetzt ist, kann der Käufer seine Versandadresse während des Checkouts eingeben. |
hs_payment_status
und hs_payment_date
:
hs_payment_status
automatisch auf PENDING
.hs_payment_status
auf PROCESSING
fest.hs_payment_status
automatisch auf PAID
fest.hs_payment_date
automatisch auf den Zeitpunkt ( Datum und Uhrzeit) fest, zu dem die Zahlung bestätigt wurde.Objekttyp | Erforderlich | Beschreibung |
---|---|---|
Artikel | Ja | Die Waren und/oder Dienstleistungen, die über das Angebot verkauft werden. Sie können Artikel über Produkte in Ihrer Produktbibliothek erstellen oder benutzerdefinierte eigenständige Artikel erstellen. |
Angebotsvorlage | Ja | Die Vorlage, die das Angebot rendert, sowie einige Standardkonfigurationseinstellungen für das Angebot, z. B. die Sprache. Jedes Angebot kann einer Vorlage zugeordnet werden. |
Deal | Ja | Der Deal-Datensatz zur Nachverfolgung von Umsatz und Vertriebs-Lifecycle. Ein Angebot übernimmt Werte vom zugeordneten Deal, einschließlich des zuständigen Mitarbeiters und der Währung. Jedes Angebot kann einem Deal zugeordnet werden. |
Kontakt | Nein | Bestimmte Käufer, die Sie im Angebot ansprechen. |
Unternehmen | Nein | Ein bestimmtes Unternehmen, das Sie im Angebot ansprechen. Jedes Angebot kann einem Unternehmen zugeordnet werden. |
Rabatte, Gebühren und Steuern | Nein | Alle Rabatte, Gebühren und Steuern, die beim Checkout anfallen. Bei der Ermittlung des Gesamtangebotsbetrags wendet HubSpot zunächst Rabatte, dann Gebühren und dann Steuern an. Mithilfe des hs_sort_order -Felds können Sie Objekte des gleichen Typs neu anordnen. Kann auf feste Werte oder Prozentsätze gesetzt werden, indem hs_type entweder auf FIXED oder PERCENT festgelegt wird. |
GET
-Anfrage an den entsprechenden Objekt-Endpunkt, die dem gleichen Muster für die einzelnen CRM-Objekte folgt. Bei jeder Anfrage können Sie auch einen properties
-Abfrageparameter hinzufügen, um bei Bedarf bestimmte Eigenschaften zurückzugeben. Nachfolgend finden Sie Beispiel-GET
-Anfragen für die einzelnen Objekttypen.
200
-Antwort mit Details für jeden abgerufenen Objekttyp zurück. Sie verwenden den Wert im id
-Feld, um im nächsten Schritt Zuordnungen festzulegen.
PUT
-Anfrage mithilfe der folgende URL-Struktur durchführen:
/crm/v4/objects/quotes/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}
Parameter | Beschreibung |
---|---|
fromObjectId | Die ID des Angebots. |
toObjectType | Der Typ des Objekts, zu dem Sie eine Zuordnung erstellen. Zum Beispiel line_items , deals und quote_template . |
toObjectId | Die ID des Objekts, dem Sie das Angebot zuordnen. |
PUT
-Anfragen für die einzelnen Objekttypen.
123456
hat, können die Anfragen zum Zuordnen des Angebots Folgendes umfassen:
55555
, 66666
):
/crm/v4/objects/quotes/123456/associations/default/line_items/55555
/crm/v4/objects/quotes/123456/associations/default/line_items/66666
987654
): /crm/v4/objects/quotes/123456/associations/default/quote_template/987654
345345
): /crm/v4/objects/quotes/123456/associations/default/deals/345345
200
-Antwort mit Details über die Zuordnung zurück. Die obigen Aufrufe ordnen die Objekte in beide Richtungen zu, wobei jede Richtung ihre eigene ID hat. Wenn Sie beispielsweise das Angebot einer Angebotsvorlage zuordnen, beschreibt die Antwort die Zuordnung von beiden Enden. In der nachstehenden Beispielantwort ist 286
die ID des Zuordnungstyps Angebot-zu-Angebotsvorlage und 285
die ID des Zuordnungstyps Angebotsvorlage-zu-Angebot.
CUSTOMIZABLE_QUOTE_TEMPLATE
verwendet werden.PUT
-Anfrage an die folgende URL senden:
/crm/v4/objects/quote/{quoteId}/associations/contact/{contactId}
Im Anforderungstext müssen Sie die associationCategory
und associationTypeId
angeben, wie unten gezeigt:
associations
-Feld aktualisieren, damit sie mit den vorhandenen Daten in Ihrem CRM-System übereinstimmen. Weitere Anleitungen finden Sie im Abschnitt Abrufen von IDs für Zuordnungen.POST
/crm/v3/objects/quote
Parameter | Typ | Beschreibung |
---|---|---|
properties | Objekt | Eigenschaftswerte zur Definition der Details des Angebots. Erforderliche Eigenschaften sind hs_title und hs_expiration_date :
|
associations | Array | Die anderen CRM-Datensätze und -Objekte, die dem Angebot zugeordnet sind. Damit ein Angebot veröffentlicht werden kann, muss es über einen zugeordneten Deal und eine Angebotsvorlage verfügen. Artikel, die einem Angebot zugeordnet sind, sollten sich von den Artikeln unterscheiden, die dem Deal des Angebots zugeordnet sind (d. h., Sie sollten Kopien der Artikel erstellen). Um jede Zuordnung festzulegen, fügen Sie ein separates Objekt mit den folgenden Feldern in dieses Array ein:
|
PATCH
-Anfrage an /crm/v3/objects/quote/{quoteId}
durchführen.
Der Status eines Angebots basiert auf dem hs_status
-Feld. Bestimmte Angebotsstatus ermöglichen es Benutzern, das Angebot in Angebotsgenehmigungsworkflows zu bearbeiten, zu veröffentlichen und zu verwenden. Nachfolgend finden Sie die verfügbaren Angebotsstatus.
hs_status
-Feld kein Wert angegeben wird, hat das Angebot den Status Minimal. Das Angebot wird auf der Indexseite des Angebote-Tools angezeigt, kann aber nicht direkt bearbeitet werden. Angebote mit diesem Status können weiterhin in der Automatisierung verwendet werden, z. B. im Sequenzen-Tool, und können auch im Reporting-Tool analysiert werden.DRAFT
: ermöglicht die Bearbeitung des Angebots in HubSpot. Dieser Status kann nützlich sein, wenn das Angebot nicht vollständig konfiguriert ist oder wenn Sie es den Vertriebsmitarbeitern lieber ermöglichen möchten, den Angebotskonfigurationsprozess in HubSpot abzuschließen.APPROVAL_NOT_NEEDED
: veröffentlicht das Angebot unter einer öffentlich zugänglichen URL (hs_quote_link
), ohne dass es genehmigt werden muss.PENDING_APPROVAL
: gibt an, dass das Angebot auf die Genehmigung wartet, bevor es veröffentlicht werden kann.APPROVED
: Das Angebot wurde genehmigt und wird nun unter einer öffentlich zugänglichen URL (hs_quote_link
) veröffentlicht.REJECTED
: gibt an, dass das Angebot eingerichtet, aber nicht für die Veröffentlichung genehmigt wurde und bearbeitet werden muss, bevor es erneut zur Genehmigung eingereicht werden kann.hs_template_type
-Eigenschaft des Angebots auf CUSTOMIZABLE_QUOTE_TEMPLATE
, nachdem Sie den Status des Angebots aktualisiert haben. Dieser Vorlagentyp wird von der v3-API unterstützt, während die folgenden Vorlagentypen alte Vorlagen sind, die nicht mehr unterstützt werden:QUOTE
PROPOSAL
hs_quote_amount
: wird auf der Grundlage aller zugeordneten Artikel, Steuern, Rabatte und Gebühren berechnet.hs_domain
: wird von der zugeordneten Angebotsvorlage festgelegt.hs_slug
: wird zufällig generiert, wenn keiner explizit angegeben wird.hs_quote_total_preference
: wird basierend auf Ihren Account-Einstellungen festgelegt. Wenn Sie diese Einstellung nicht konfiguriert haben, wird sie standardmäßig auf den Wert des total_first_payment-Felds festgelegt.hs_timezone
: wird standardmäßig auf die Zeitzone Ihres HubSpot-Accounts festgelegt.hs_locale
: wird von der zugeordneten Angebotsvorlage festgelegt.hs_quote_number
: wird basierend auf dem aktuellen Datum und der aktuellen Uhrzeit festgelegt, es sei denn, es wird eine angegeben.hs_language
: wird von der zugeordneten Angebotsvorlage festgelegt.hs_currency
: wird basierend auf dem zugeordneten Deal festgelegt. Wenn Sie dem Angebot keinen Deal zugeordnet haben, wird die Standardwährung Ihres HubSpot-Accounts verwendet.hs_pdf_download_link
: wird mit einer URL von einer PDF-Datei für das Angebot ausgefüllt.hs_locked
: festgelegt auf true
. Zum Ändern von Eigenschaften, nachdem Sie ein Angebot veröffentlicht haben, müssen Sie zunächst den hs_status
des Angebots zurück auf DRAFT
, PENDING_APPROVAL
oder REJECTED
aktualisieren.hs_quote_link
: die öffentlich zugängliche URL des Angebots. Dies ist eine schreibgeschützte Eigenschaft und kann nach der Veröffentlichung nicht über die API festgelegt werden.hs_esign_num_signers_required
: Wenn Sie eSignatures aktiviert haben, wird die Anzahl der erforderlichen Unterschriften angezeigt.hs_payment_status
: der Status des Zahlungseinzugs, wenn Sie Zahlungen aktiviert haben. Nach der Veröffentlichung mit aktivierten Zahlungen wird diese Eigenschaft auf PENDING festgelegt. Sobald der Käufer die Zahlung über das Angebot übermittelt, wird der Status automatisch entsprechend aktualisiert. Erfahren Sie mehr über das Aktivieren von Zahlungen.GET
-Anfrage an /crm/v3/objects/quotes/{quoteID}
durch.GET
-Anfrage an /crm/v3/objects/quotes
durch.properties
| Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn das angefragte Angebot keinen Wert für eine Eigenschaft hat, wird es nicht in der Antwort angezeigt. |
| propertiesWithHistory
| Eine durch Kommas getrennte Liste der aktuellen und historischen Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn das angefragte Angebot keinen Wert für eine Eigenschaft hat, wird es nicht in der Antwort angezeigt. |
| associations
| Eine durch Kommas getrennte Liste von Objekten, für die zugehörige IDs abgerufen werden sollen. Alle angegebenen Zuordnungen, die nicht vorhanden sind, werden nicht in der Antwort zurückgegeben. Erfahren Sie mehr über die Zuordnungen-API | . |
Um einen Batch bestimmter Angebote anhand ihrer IDs abzurufen, führen Sie eine POST
-Anfrage an crm/v3/objects/quotes/batch/read
durch und fügen Sie die IDs in den Anforderungstext ein. Sie können auch ein properties
-Array einfügen, um anzugeben, welche Eigenschaften zurückgegeben werden sollen. Der Batch-Endpunkt kann Zuordnungen nicht abrufen. Erfahren Sie, wie Sie Zuordnungen mit der Zuordnungen-API batchweise lesen.
crm.objects.quotes.write
, crm.objects.quotes.read
, crm.objects.line_items.write
, crm.objects.line_items.read
, crm.objects.owners.read
, crm.objects.contacts.write
, crm.objects.contacts.read
, crm.objects.deals.write
, crm.objects.deals.read
, crm.objects.companies.write
, crm.objects.companies.read
crm.schemas.quote.read
, crm.schemas.line_items.read
, crm.schemas.contacts.read
, crm.schemas.deals.read
, crm.schemas.companies.read