Anbieter und Artikel aktualisieren

Marketplace APIs are limited access

Unsere Pipeline für Marktplatz-Integration ist derzeit ausgelastet. Wir nehmen im Moment keine neuen Partner an, sind aber dabei, Self-Service-Tools für das Onboarding von Anbietern zu entwickeln. Bitte fülle das Formular für Interessenten der Marktplatz-Integration aus, um mit DoorDash in Kontakt zu treten, bevor du deine Integration erstellst.

DoorDash verfügt über eine Reihe an APIs, mit denen Aktionen auf Anbieterebene umgesetzt werden können. Dazu gehören das Deaktivieren eines Anbieters, das Deaktivieren von Artikeln und Artikeloptionen, das Abrufen von Anbieterinformationen und das Abrufen von Informationen zur Speisekarte des Anbieters.

Änderung des Anbieter-Aktivierungsstatus

PUT /api/v1/stores/{merchant_supplied_id}/activation-status

DoorDash verfügt über einen Webhook, mit dem du einen Anbieter deaktivieren kannst. Wenn Umstände vorliegen, in denen ein Anbieter deaktiviert werden muss, musst du ihn sofort deaktivieren. Füge die merchant_supplied_id des Anbieters in die URL-Parameter ein. Die Payloads sollten das folgende Format haben und werden auch im StoreActivationStatus-Modell beschrieben:

{
  "is_active": false,
  "reason": string from list of accepted reasons for deactivation,
  "notes": string detailing reason for deactivation
}

Es gibt einen erforderlichen Parameter für den Grund, der in der Payload übergeben werden muss. Dieser Grund ist für unsere internen Aufzeichnungen bestimmt und hier wird die Umsetzung des „Best-Fit“ für die Anbieterdeaktivierung angefordert. Bitte stelle sicher, dass dieser Parameter mit einem der folgenden Gründe verknüpft ist:

• out_of_business
• delete_store
• payment_issue
• operational_issues
• store_self_disabled_in_their_POS_portal
• store_pos_connectivity_issues

Nach dem Absenden der Anfrage erhältst du einen Antwortcode 200, um zu bestätigen, dass der Anbieter erfolgreich deaktiviert wurde.

Um den Anbieter zu reaktivieren, sende eine zusätzliche PUT-Anfrage an den Endpunkt. Bei der Reaktivierung eines Anbieters ist der einzige erforderliche Parameter in der Payload "is_active": true.

Du erhältst einen Antwortcode von 200, um zu bestätigen, dass der Anbieter erfolgreich reaktiviert wurde. Es gibt einige Validierungen auf DoorDash-Seite, die vor der Aktivierung eines Anbieters überprüft werden. In diesem Fall erhältst du eine Antwort von 400. Bitte unternehme bei einer Antwort von 400 keine weiteren Versuche, da diese bis zur manuellen Behebung des Problems fehlschlagen werden. Wegen diesen Prüfungen kann der Aktivierungs-Webhook aus folgenden Gründen fehlschlagen:

• Bankdaten des Anbieters sind nicht vorhanden
• Bankdaten des Anbieters sind ungültig
• Für den Anbieter liegen keine aktiven POS-Speisekarten vor

Änderung des Aktivierungsstatus des Batch-Artikels

PUT /api/v1/stores/{merchant_supplied_id}/item/activation-status

DoorDash verfügt über einen Webhook, mit dem du Artikel für einen bestimmten Anbieter auf Lager oder aus dem Lager nehmen kannst. Wird ein Artikel aus dem Lager genommen, wird er von DoorDash-Website gelöscht, bis er wieder auf Lager genommen wird. Anstatt Aktualisierungen der Speisekarte zur Deaktivierung von Artikeln zu verwenden (was kostspielig ist), wird empfohlen, die folgenden Aufrufe zu verwenden. Um dies zu tun, fahre bitte durch Einfügen der merchant_supplied_id des Anbieters in die URL-Parameter fort. Dies erfolgt zusätzlich zur Aufnahme der merchant_supplied_id des Artikels, der in der Anfrage-Payload deaktiviert wird. Mit „false“ kannst du einen Artikel deaktivieren, während du ihn mit „true“ aktivierst. Die Payload sollte das folgende Format haben und wird auch im ItemActivation-Modell beschrieben:

{
    "merchant_supplied_id": “string”,
    "is_active" : false
}

Änderung des Aktivierungsstatus der Batch-Artikeloption

PUT /api/v1/stores/{merchant_supplied_id}/item_option/activation-status

DoorDash verfügt über einen Webhook, mit dem du ein item_option aus dem Lager nehmen kannst. Um dies zu tun, fahre bitte durch Einfügen der merchant_supplied_id des Anbieters in die URL-Parameter fort. Dies erfolgt zusätzlich zur Aufnahme der merchant_supplied_id der Artikeloption, die in der Anfrage-Payload deaktiviert wird. Die Payload sollte das folgende Format haben und wird auch im ItemOptionActivation-Modell beschrieben:

{
    "merchant_supplied_id": “string”,
    "is_active" : false
}

Bitte beachte, dass du über die Endpunkte ein „item“ oder eine „itemOption“ reaktivieren musst. Bei einer Aktualisierung der Speisekarte wird der Artikel nicht automatisch wieder ins Lager genommen. Sowohl der Speisekartenstatus des Artikels als auch der Status des Artikel-Webhooks müssen auf „true“ gesetzt sein, damit ein Artikel in der Speisekarte angezeigt wird. Wenn entweder der Speisekartenstatus des Artikels oder der Status des Artikel-Webhooks falsch ist, wird der Artikel nicht auf der Speisekarte angezeigt. Beispielanfragen und -antworten finden sich in der Referenz.

Wichtige Felder

• is_suspended: Mit „false“ kannst du einen Artikel deaktivieren, während du ihn mit „true“ aktivierst.
• price: Ganzzahliger Wert. Wenn du den Wert auf 5,00 USD festlegen möchtest, musst du 500 senden.

Antwortstatuscodes für „item“ und „item_option“:

Statuscode	Details
200	Erfolgreich abgeschlossen
400	Ungültige Anfrage (wenn einer der Artikel nicht aktualisiert werden kann, sollten 400 zurückgegeben werden)
401	Authentifizierungsfehler
403	Modifizierung dieses Anbieters nicht erlaubt
404	Anbieter nicht gefunden
429	Ratenbegrenzung überschritten
500	Interner Serverfehler

Antwortdetails für jedes Unternehmen

Antwort	Details
Erfolgreich abgeschlossen
Nicht gefunden	Artikel nicht gefunden
Serverfehler	Interner Serverfehler

Bitte nur erneut versuchen, wenn du eine Antwort mit dem Code 500 erhalten hast. Wir empfehlen dir, es dreimal mit exponentiellen Backoffs von 0,5 Sekunden erneut zu versuchen.

Anbieterinformationen abrufen (GET)

GET api/v1/stores/{merchant_supplied_id}

Partner können diesen Endpunkt verwenden, um Live-Informationen auf Anbieterebene für die Standorte abzurufen, die für die Integration eingerichtet sind. Dieser Endpunkt kann bei der Validierung der folgenden Informationen hilfreich sein:

Welches Bestellprotokoll (Tablet, POS usw.) verwendet dieser Anbieter derzeit? Was ist die maximale Länge für besondere Anweisungen für diesen Anbieter? Ist mein Anbieter vorübergehend/dauerhaft deaktiviert? Warum? Ist die automatische Bestellfreigabe (AOR) bei diesem Anbieter aktiviert?

Das Antwortobjekt ist in unserer Swagger-Dokumentation ausführlich beschrieben. Wir haben auch eine Beispielinstanz in den Abschnitt „Referenz“ dieses Dokuments aufgenommen.

Details zur Speisekarte des Anbieters abrufen (GET)

GET api/v1/stores/{merchant_supplied_id}/menu_details

Partner können diesen Endpunkt verwenden, um Live-Informationen auf Speisekartenebene für die Standorte abzurufen, die für die Integration eingerichtet sind. Dieser Endpunkt kann bei der Validierung der folgenden Informationen in Bezug auf aktive Speisekarten der Anbieter hilfreich sein:

• Welche Speisekarten-ID(s) ist/sind mit diesem Standort verknüpft?
• Ist diese Speisekarte derzeit aktiv?
• Wann wurde diese Speisekarte zuletzt erfolgreich aktualisiert?
• Welche besonderen/regulären Öffnungszeiten gelten für diese Speisekarte?
• Wurde diese Speisekarte über POS oder eine andere Methode erstellt?
• Wie lautet die URL der Speisekartenvorschau?

Das Antwortobjekt ist in unserer Swagger-Dokumentation ausführlich beschrieben. Wir haben auch eine Beispielinstanz in den Abschnitt „Referenz“ dieses Dokuments aufgenommen.