Dokumentation
Entwickler-HubAPI-StatusUnterstützung

Vertriebs-API v1: Leitfaden für Anwendungsfälle

Anwendungsfälle für die Vertriebs-API.

API-Version: v1

Was ist die Verkaufs-API?

Die Verkaufspartner-API für den Vertrieb (Verkaufs-API) bietet Verkäufern Informationen zur Verkaufsleistung. Dies wird erreicht, indem aggregierte Bestellkennzahlen für einen bestimmten Zeitraum zurückgegeben werden, aufgeschlüsselt nach Granularität und Käufertyp. Siehe Hinweis zur Vertriebs-API für Details zu den Vorgängen der Vertriebs-API und den zugehörigen Datentypen und Schemas.

Voraussetzungen

Um dieses Tutorial erfolgreich abzuschließen, benötigen Sie Folgendes:

  1. Autorisierung durch den Verkaufspartner, für den Sie Aufrufe durchführen. Siehe Autorisierung von API-Apps für Verkaufspartner für weitere Informationen.
  2. Die Ihrem Entwicklerprofil zugewiesene Rolle Preisgestaltung.
  3. Die Rolle Preisgestaltung, die auf der App-Registrierungsseite für Ihre App ausgewählt wurde.

Tutorial: Informationen zur Verkaufsleistung erhalten

In diesem Abschnitt erfahren Sie, wie Sie mithilfe der Verkaufs-API Informationen zur Verkaufsleistung erhalten.

Rufen Sie die Informationen zur Verkaufsleistung ab

Rufen Sie den Vorgang getOrderMetrics mit den folgenden Parametern auf, um aggregierte Bestellkennzahlen für ein bestimmtes Intervall zu erhalten:

Abfrageparameter:

Parameter Beschreibung Erforderlich
marketplaceIds

Eine Marktplatz-ID. Diese gibt den Online-Marktplatz an, bei dem die Bestellung aufgegeben wurde. Es kann nur ein Online-Marktplatz angegeben werden.

Zum Beispiel gibt ATVPDKIKX0DER den USA-Markt an.

Typ: < Zeichenfolge > Array

Ja
interval

A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO 8601 format and must represent absolute time (either Z notation or offset notation).

Beispiel: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 fordert Bestellkennzahlen für den 1., 2. und 3. September in der Zone - 07:00 Uhr an.

Typ: Zeichenfolge

Ja
granularityTimeZone

Eine IANA-kompatible Zeitzone zur Bestimmung der Tagesgrenze. Erforderlich, wenn ein Granularitätswert größer als Stunde angegeben wird. Der granularityTimeZone-Wert muss mit dem Offset des angegebenen Intervallwerts übereinstimmen. Wenn der Intervallwert beispielsweise die Z-Notation verwendet, dann muss granularityTimeZone UTC sein. Wenn der Intervallwert einen Offset verwendet, dann muss granularityTimeZone eine IANA-kompatible Zeitzone sein, die dem Offset entspricht.

Beispiel: USA/Pazifik zur Berechnung der Tagesgrenzen unter Berücksichtigung der Sommerzeit für die Zone USA/Pazifik.

Typ: Zeichenfolge

Nein
granularity

Das granularity der Gruppierung von Bestellkennzahlen, basierend auf einer Zeiteinheit. Spezifizieren von granularity=Hour-Ergebnissen nur in einer erfolgreichen Anfrage, wenn das angegebene Intervall weniger als oder gleich 30 Tagen von jetzt an ist. Für alle anderen Granularitäten muss das angegebene Intervall kleiner oder gleich 2 Jahre sein. Spezifizieren von granularity=Total-Ergebnissen in Bestellungsmetriken, die über das gesamte von Ihnen angegebene Intervall aggregiert werden. Wenn das Start- und Enddatum des Intervalls nicht mit dem angegebenen granularity übereinstimmt , werden das obere und das untere Ende des Antwortintervalls Teildaten enthalten.

Beispiel: Tag, um eine tägliche Aufschlüsselung des Anforderungsintervalls zu erhalten, wobei die Tagesgrenze definiert ist durch granularityTimeZone.

Type: enum (Granularity)

Ja
buyerType

Filtert die Ergebnisse nach dem von Ihnen angegebenen Käufertyp, B2B (Unternehmen zu Unternehmen) oder B2C (Unternehmen zu Kunde).

Beispiel: B2B, wenn Sie möchten, dass die Antwort nur Bestellkennzahlen für B2B-Käufer enthält.

Type: enum (BuyerType)

Nein
fulfillmentNetwork

Filtert die Ergebnisse nach dem von Ihnen angegebenen Versandnetzwerk, MFN (Versand durch Händler-Netzwerk) oder AFN (Versand durch Amazon-Netzwerk). Verwenden Sie diesen Filter nicht, wenn Sie möchten, dass die Antwort Bestellkennzahlen für alle Versandnetzwerke enthält.

Beispiel: AFN, wenn Sie möchten, dass die Antwort nur Bestellkennzahlen für das Amazon-Versandnetzwerk enthält.

Typ: Zeichenfolge

Nein
firstDayOfWeek

Gibt den Tag an, an dem die Woche beginnt granularity=Week, entweder Monday oder Sunday. Standard: Monday.

Beispiel: Sunday, wenn Sie möchten, dass die Woche an einem Sonntag beginnt.

Type: enum (FirstDayOfWeek)

Nein
asin

Filtert die Ergebnisse nach der von Ihnen angegebenen ASIN. Beides angeben, asin und sku, gibt einen Fehler zurück. Verwenden Sie diesen Filter nicht, wenn die Antwort Bestellkennzahlen für alle ASINs enthalten soll.

Beispiel: B0792R1RSN, wenn Sie möchten, dass die Antwort nur Bestellkennzahlen für asin B0792R1RSN enthält.

Typ: Zeichenfolge

Nein
sku

Filtert die Ergebnisse nach der von Ihnen angegebenen SKU. Beides angeben, asin und sku, gibt einen Fehler zurück. Verwenden Sie diesen Filter nicht, wenn die Antwort Bestellkennzahlen für alle SKUs enthalten soll.

Beispiel: TestSKU, wenn Sie möchten, dass die Antwort nur Bestellkennzahlen für die SKU TestSKU enthält.

Typ: Zeichenfolge

Nein

Beispiel anfordern

GET https://sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics?marketplaceIds=&interval=&granularityTimeZone=&granularity=&buyerType=&fulfillmentNetwork=&firstDayOfWeek=&asin=&sku="

Antwort

Parameter Beschreibung Erforderlich
interval

Das Zeitintervall, das auf der angeforderten Granularität basiert (z. B. Stunde, Tag usw.) Wenn dies das erste oder das letzte Intervall aus der Liste ist, enthält es möglicherweise unvollständige Daten, wenn das angeforderte Intervall nicht der angeforderten Granularität entspricht

(z. B. Anforderungsintervall) 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z und Granularität Tag ergeben den 1. September als UTC-Tag und den 4. September als UTC-Tag mit unvollständigen Daten).

Typ: Zeichenfolge

Ja
unitCount

Die Anzahl der Einheiten in Bestellungen, die auf den angegebenen Filtern basieren.

Typ: Ganzzahl

Ja
orderItemCount

Die Anzahl der Bestellartikel, die auf den angegebenen Filtern basieren.

Typ: Ganzzahl

Ja
orderCount Die Anzahl der Bestellungen, die auf den angegebenen Filtern basieren.

Typ: Ganzzahl

Ja
averageUnitPrice Der Durchschnittspreis für einen Artikel, basierend auf den angegebenen Filtern. Die Formel lautet TotalSales/UnitCount.

Type: Money

Ja
totalSales Die Gesamtzahl der bestellten Produktverkäufe für alle Bestellungen, basierend auf den angegebenen Filtern.

Type: Money

Ja

Beispiel für eine Antwort

{ "request": { "parameters": { "granularity": { "value": "Day" } } }, "response": { "payload": [ { "interval": "2019-08-01T00:00-07:00--2018-08-02T00:00-07:00", "unitCount": 1, "orderItemCount": 1, "orderCount": 1, "averageUnitPrice": { "amount": "22.95", "currencyCode": "USD" }, "totalSales": { "amount": "22.95", "currencyCode": "USD" } }, { "interval": "2019-08-02T00:00-07:00--2018-08-03T00:00-07:00", "unitCount": 1, "orderItemCount": 1, "orderCount": 1, "averageUnitPrice": { "amount": "2.05", "currencyCode": "USD" }, "totalSales": { "amount": "2.05", "currencyCode": "USD" } } ] } }

Hat Ihnen diese Seite weitergeholfen?