API für Direktversand durch den Anbieter v1: Leitfaden für Anwendungsfälle
So helfen Sie Anbietern im Direktversand-Programm dabei, die Versand-API zur Verwaltung ihrer Direktversandvorgänge zu verwenden.
API-Version: v1
Was ist die Versand-API für Direktversand?
Anbieter können die Versand-API für Direktversand verwenden, um Versanddokumente mit Amazon auszutauschen. Anbieter können Versandetiketten anfordern, Versandetiketten erhalten, Versandbestätigungen versenden, Packzettel erhalten und Kundenrechnungen abrufen.
Beachten Sie, dass Kundenrechnungen spezifisch für die Region Indien sind.
Die folgenden Vorgänge sind verfügbar:
Vorgang | HTTP-Methode | Path | Beschreibung |
---|---|---|---|
submitShippingLabelRequest
|
POST | /vendor/directFulfillment/shipping/v1/shippingLabels |
Reichen Sie einzelne oder mehrere Anfragen für Versandetiketten ein. |
getShippingLabels
|
GET | /vendor/directFulfillment/shipping/v1/shippingLabels |
Rufen Sie eine Liste von Versandetiketten auf der Grundlage des Filterkriteriums ab. Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getShippingLabel
|
GET |
|
Rufen Sie ein Versandetikett anhand der Bestellnummer ab. Hinweis: Versandetiketten laufen 90 Tage nach ihrer Erstellung durch eine Anfrage zum Senden von Versandetiketten ab. Versandetiketten, die älter als 90 Tage sind, sollten daher nicht angefordert werden. |
submitShipmentConfirmations
|
POST | /vendor/directFulfillment/shipping/v1/shipmentConfirmations |
Senden Sie eine oder mehrere Versandbestätigungen an Amazon. |
submitShipmentStatusUpdates
|
POST | /vendor/directFulfillment/shipping/v1/shipmentStatusUpdates |
Reichen Sie eine Aktualisierung des Versandstatus ein. Nur Anbieter mit eigenem Transportdienst. |
getPackingSlips
|
GET | /vendor/directFulfillment/shipping/v1/packingSlips |
Rufen Sie eine Liste der Packzettel basierend auf dem Erstellungsdatum ab. Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getPackingSlip
|
GET | /vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber} |
Rufen Sie den Packzettel für eine bestimmte Bestellung anhand der Bestellnummer ab. Hinweis: Der Datenabruf enthält maximal sechs Monate alte Daten, das heißt createdBefore darf nicht länger als sechs Monate in der Vergangenheit liegen. |
getCustomerInvoices
|
GET | /vendor/directFulfillment/shipping/v1/customerInvoices |
Rufen Sie eine Liste der Kundenrechnungen auf der Grundlage eines Filterkriteriums ab. Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getCustomerInvoice
|
GET | /vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber} |
Rufen Sie eine Kundenrechnung anhand der Bestellnummer ab. Hinweis: Der Datenabruf enthält maximal sechs Monate alte Daten, das heißt createdBefore darf nicht länger als sechs Monate in der Vergangenheit liegen. |
submitShippingLabelRequest
Der Vorgang submitShippingLabelRequest
ermöglicht Anbietern, für jede Bestellung Versandetiketteninformationen von Amazon anzufordern. Sie können mehrere Anfragen für Versandetiketten gleichzeitig in einem API-Aufruf senden, indem Sie das Schema einhalten. Wenn Versandetiketten von Amazon erstellt werden, können sie über den Vorgang getShippingLabel
heruntergeladen werden.
Überprüfung der erfolgreich eingereichten Versandetikettenanfragen
Vendors can verify the status of their shipping label requests using the Direct Fulfillment Transaction Status API. Allow the system up to 15 min to show the status after submission. If the transaction status is not updated after 30 minutes, open a Contact Us case in Vendor Central.
API-Integrations-Workflow für Versandetikettenanfrage
Das folgende Diagramm zeigt den Workflow für das Einreichen von Versandetikettenanfragen.
Geschäftsanforderungen
Amazon muss eine Anfrage für ein Versandetikett erhalten, nachdem bestätigt wurde, dass die Bestellung vom Anbieter mithilfe der Bestellbestätigungs-API akzeptiert wurde.
Wenn Sie Amazon-eigene Versandetiketten verwenden, ist das Senden von Artikelinformationen oder Paketinformationen in der Anfrage optional.
Länderspezifische Geschäftsanforderungen
Es gibt keine landesspezifischen Anforderungen.
submitShippingLabelRequest-Anfrage
Um Versandetiketten anzufordern, rufen Sie den Vorgang submitShippingLabelRequest
auf und übergeben Sie den folgenden Parameter:
Textparameter:
Name |
Beschreibung |
Erforderlich |
---|---|---|
shippingLabelRequests |
Fordern Sie ein oder mehrere Versandetiketten an. Typ: < |
Ja |
Beispiel für eine Anfrage:
POST "https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels"
{
"shippingLabelRequests": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "XXXX",
"dimensions": {
"length": "12",
"width": "12",
"height": "12",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "B07DFVDRAB",
"packedQuantity": {
"amount": 1,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
submitShippingLabelRequest-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name |
Beschreibung |
Erforderlich |
---|---|---|
transactionId
|
GUID zur Identifizierung dieser Transaktion. Dieser Wert kann in der Transaktionsstatus-API verwendet werden, um den Status dieser Transaktion zurückzugeben. Typ: Zeichenfolge |
Nein |
Beispiel für eine Antwort:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
getShippingLabels
The getShippingLabels
operation returns shipping labels for all orders which meet the filter criteria specified in the request. You must have already requested shipping labels using the submitShippingLabelRequest
operation before you use this API to get shipping labels available to you for fulfillment. Amazon recommends that vendors check for shipping labels at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 shipping labels in one API call. If there are more than 100 shipping labels you can use the nextToken value to get the next set of shipping labels.
Restricted Data Token für die Autorisierung
Dies ist ein eingeschränkter Vorgang und erfordert daher ein Restricted Data Token (RDT) für die Autorisierung. Weitere Informationen finden Sie im Leitfaden zu Token-API-Anwendungsfällen.
Das folgende Diagramm zeigt den Integrations-Workflow beim Abrufen von Versandetiketten:
getShippingLabels-Anfrage
Um eine Liste der Versandetiketten abzurufen, rufen Sie den Vorgang getShippingLabels
auf und übergeben Sie die folgenden Parameter:
Abfrageparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
shipFromPartyId |
Die Lagerhaus-ID des Lieferanten, von der aus die Bestellung versendet wird. Wenn nicht angegeben, enthält das Ergebnis Bestellungen für alle Lagerhäuser. Typ: Zeichenfolge |
Nein |
limit |
Das Limit für die Anzahl der zurückgegebenen Datensätze. Minimum: 1 Maximum: 100 Typ: Ganzzahl |
Nein |
createdAfter |
Versandetiketten, die nach diesem Datum und dieser Uhrzeit verfügbar wurden, werden in das Ergebnis aufgenommen. Muss im Datums-/Uhrzeitformat ISO-8601 vorliegen. Typ: Zeichenfolge (Datum-Uhrzeit) |
Ja |
createdBefore |
Versandetiketten, die vor diesem Datum und dieser Uhrzeit verfügbar waren, werden in das Ergebnis aufgenommen. Muss im Datums-/Uhrzeitformat ISO-8601 vorliegen. Typ: Zeichenfolge (Datum-Uhrzeit) |
Ja |
sortOrder |
Aufsteigend (ASC ) oder absteigend (DESC ) nach Datum der Bestellerstellung sortieren. Typ: Enumeration ( |
Nein |
nextToken |
Wird für die Paginierung verwendet, wenn mehr Versandetiketten als die angegebene Ergebnisgrößenbeschränkung vorliegen. Der Tokenwert wird im vorherigen API-Aufruf zurückgegeben. Typ: Zeichenfolge |
Nein |
Beispiel für eine Anfrage:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
getShippingLabels-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
pagination |
Wenn mehr als 100 Versandetiketten zurückgegeben werden, wird nextToken in der Antwort für die Paginierung zurückgegeben. Typ: Zeichenfolge |
Nein |
shippingLabels |
Liste der Versandetiketten. Typ: < |
Nein |
Beispiel für eine Antwort:
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"shippingLabels": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
},
{
"purchaseOrderNumber": "2JK3S9VD",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG002",
"trackingNumber": "1Z6A34Y60369738805",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
}
]
}
Versandetikett abrufen
Der Vorgang getShippingLabel
gibt Informationen über das Versandetikett zurück, das Sie mithilfe der Bestellnummer spezifizieren. Die Antwort enthält vollständige Versandetiketteninformationen für die Bestellung, einschließlich Etikettentyp, Bestelldetails und Versandmethode.
You can also use this API to get details for any shipping label (in the time range of seven days from a rolling window of the last six months, after the vendor went live on API).
Das folgende Diagramm zeigt den Integrations-Workflow zum Abrufen eines bestimmten Versandetiketts:
Bis wann soll das Versandetikett angefordert werden?
ZPL- und PNG-Etiketten sollten erst an dem Tag angefordert werden, an dem die Bestellungen für den Versand fällig sind.
Länderspezifische Geschäftsanforderungen
Es gibt keine landesspezifischen Anforderungen für Antworten über Versandetiketten.
getShippingLabel-Anfrage
Um ein Versandetikett anzufordern, rufen Sie den Vorgang getShippingLabel
auf und übergeben Sie den folgenden Parameter:
Pfadparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
purchaseOrderNumber
|
Die Bestellnummer, für die Sie das Versandetikett zurücksenden möchten. Es sollte die gleiche purchaseOrderNumber sein, wie die, die in der Bestellung angegeben ist. Typ: Zeichenfolge |
Ja |
Beispiel für eine Anfrage:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC
getShippingLabel-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
purchaseOrderNumber
|
Dieses Feld enthält die Bestellnummer für diese Bestellung. Typ: Zeichenfolge |
Ja |
sellingParty
|
ID des Verkäufers oder Anbieters. Typ: |
Ja |
shipFromParty
|
Lagercode des Anbieters. Typ: PartyIdentification |
Ja |
labelFormat
|
Format des Etiketts. Enumeration ( LabelFormat ) |
Ja |
labelData
|
Enthält die Details der Pakete in dieser Lieferung. Typ: < |
Ja |
Beispiel für eine Antwort:
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here"
}
]
}
submitShipmentConfirmations
Mit dem Vorgang submitShipmentConfirmations
können Anbieter Versandbestätigungen an Amazon senden. Ihre Versandbestätigung ermöglicht uns, Ihre Sendungen effizient zu verfolgen und unsere Kunden zu informieren. Sie enthält Informationen über die Artikel im Versand, einschließlich Bestellnummer, Versanddatum, voraussichtlichem Lieferdatum und Sendungsverfolgungsnummer.
Versandbestätigungen ermöglichen uns, effektiver mit Spediteuren zusammenzuarbeiten, um Ihre Sendungen zu verfolgen.
Das Fehlen gültiger Versandbestätigungen kann Folgendes verursachen:
-
Unzureichende Transparenz der Sendungen.
-
Fehler beim Abgleich der physischen Lieferungen mit Bestellungen.
-
Manuelle Follow-ups zur Behebung von Unstimmigkeiten.
Überprüfung erfolgreich eingereichter Versandbestätigungen
Vendors can verify the status of their shipment confirmations via Vendor Central > Orders > Direct Fulfillment Orders or using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.
Das folgende Diagramm zeigt den Integrations-Workflow für das Einreichen von Versandbestätigungen:
Geschäftsanforderungen
Sie sollten diese API verwenden, um den Versand einer Bestellung innerhalb von 4 Stunden nach Versand der Bestellung aus Ihrem Lager zu bestätigen.
Setzen Sie bei Sendungen mit "Floor Denial" den Feldwert shipmentStatus
auf FLOOR_DENIAL
.
Alle Einzelposten der Bestellung sollten in der Versandbestätigung enthalten sein. Eine teilweise Versandabwicklung ist nicht zulässig. Anbieter sollten die Bestellung als "Floor Denial" ablehnen, wenn einer der Einzelposten nicht zum Versand zur Verfügung steht.
Die itemSequenceNumber
für einen Artikel sollte die gleiche sein, die in der Bestellnachricht eingegangen ist.
In der Versandbestätigung muss entweder buyerProductIdentifier
oder vendorProductIdentifier
gesendet werden . Sie müssen den gleichen Wert senden, den Sie in der Bestellung erhalten haben.
Für anbietereigene Transportdienste ist das Senden von scacCode
obligatorisch.
Wenn das Versandetikett von Amazon bereitgestellt wird, ist der Containerbereich optional, da Amazon Zugriff auf die Paketinformationen hat. Der Abschnitt "Artikel" muss eingereicht werden.
Für den Container in einer Versandbestätigung muss eine shipMethod
angegeben sein.
Länderspezifische Geschäftsanforderungen
Keine
submitShipmentConfirmations-Anfrage
Um Versandbestätigungen einzureichen, rufen Sie den Vorgang submitShipmentConfirmations
auf und übergeben Sie den folgenden Parameter:
Textparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
shipmentConfirmations |
Liste der bestätigten Lieferungen Typ: < |
Ja |
Beispiel für eine Anfrage:
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentConfirmations
{
"shipmentConfirmations": [
{
"purchaseOrderNumber": "PO00050003",
"shipmentDetails": {
"shippedDate": "2019-08-07T19:56:45.632Z",
"shipmentStatus": "SHIPPED",
"isPriorityShipment": true,
"estimatedDeliveryDate": "2019-08-07T19:56:45.632Z"
},
"sellingParty": {
"partyId": "VENDORCODE"
},
"shipFromParty": {
"partyId": "VENDORWAREHOUSECODE"
},
"items": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
],
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "TRACK001",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "234",
"trackingNumber": "TRACK002",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "ABCD",
"trackingNumber": "TRACK003",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "id12",
"trackingNumber": "TRACK004",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
submitShipmentConfirmations-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
transactionId |
GUID zur Identifizierung dieser Transaktion. Dieser Wert kann in der Transaktionsstatus-API verwendet werden, um den Status dieser Transaktion zurückzugeben. Typ: Zeichenfolge |
Ja |
Beispiel für eine Antwort:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
submitShipmentStatusUpdates
Wichtig
Versandstatusaktualisierungen dürfen nur von VOC-Anbietern (Vendor Own Carrier) verwendet werden. Dies bezieht sich auf Anbieter, die ihre eigenen Transportdienste für die Zustellung der Sendung verwenden und keine Amazon-Spediteure für den Transport der Sendung zum Kunden einsetzen. Die Anbieter tragen letztendlich die Transportkosten und die Verantwortung für die Zustellung der Sendung an den Kunden.
Der Vorgang submitShipmentStatusUpdates
ermöglicht Anbietern, den Transportstatus für Sendungen zu aktualisieren, die sich auf dem Weg zum Endkunden befinden. VOC-Anbieter sind verpflichtet, den Versandstatus (allgemein bekannt als Scans) während der Transportphase zu aktualisieren.
Diese Informationen werden dann auf der Seite mit ihren Bestellungen an Amazon-Kunden weitergeleitet, wodurch die Transparenz des Bestellverfolgungs- und Lieferprozesses verbessert wird.
Wenn der Versandstatus nicht aktualisiert wird, kann dies zu schlechten operativen KPIs, wie z. B. einer niedrigen Scanrate, und schließlich zur Blockierung des Lagers führen.
Überprüfung der erfolgreich eingereichten Versandstatusaktualisierungen
Vendors can verify the status of their shipment status updates via Vendor Central > Orders > Direct Fulfillment Orders or by using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.
Das folgende Diagramm zeigt den Integrations-Workflow für das Einreichen von Versandstatusaktualisierungen:
Geschäftsanforderungen
Sie sollten diese API nur verwenden, wenn Sie ein VOC-Anbieter (Vendor Own Carrier) sind, was bedeutet, dass Sie Ihren eigenen Spediteur verwenden, um die Sendung zum Kunden zu transportieren.
Sie sollten diese API nur verwenden, um den Status einer Sendung zu aktualisieren, nachdem die Sendung über die Versandbestätigungs-API oder die Versandbestätigung von Vendor Central bestätigt wurde.
Die trackingNumber
in der Versandstatus-API sollte zu 100 % mit der in der Versandbestätigung angegebenen trackingNumber
übereinstimmen, andernfalls schlägt die Aktualisierung des Versandstatus fehl.
Ein API-Aufruf zur Aktualisierung des Versandstatus sollte einem physischen Paket entsprechen. Sie können den Versandstatus mehrerer Pakete in einem API-Aufruf aktualisieren, indem Sie sie zu einer Reihe von Versandstatusaktualisierungen zusammenfassen.
Eine Bestellung mit Direktversand kann dazu führen, dass mehrere physische Pakete an den Kunden geliefert werden. Daher sind mehrere Aktualisierungen des Versandstatus erforderlich, um den vollständigen Versandstatus der gesamten Bestellung wiederzugeben.
Anbieter sollten den Versandstatus nach Möglichkeit gemäß den Richtlinien für den Versandstatus von Amazon senden.
Für Bestellungen mit planmäßiger Lieferung sollten Anbieter das Array shipmentSchedule
senden, das die geschätzte Lieferzeit und das Lieferfenster angibt.
Länderspezifische Geschäftsanforderungen
Keine
Erläuterung zusätzlicher Felder
statusCode
and reasonCode
Bei diesen Feldern handelt es sich um Standardcodes, die in EDI-Standards (z. B. ISA X12 und EDIFACT) verwendet werden, um ein bestimmtes Statusereignis und den Grund für das Statusereignis anzugeben. Wir erwarten eine bestimmte Kombination von statusCode
und reasonCode
, die ein Ereignis innerhalb der Phase des Transports der Sendung zum Endkunden feststellt.
Dies sind die Status- und Ursachencodes, die wir unterstützen, und ihre Entsprechung zur aktuellen Version von Vendor Central:
EDIFACT-Statuscode | EDIFACT-Ursachencode | Operative Beschreibung | Äquivalenz der Benutzeroberfläche von Vendor Central |
---|---|---|---|
404 | 117 | Der Versand verzögert sich aufgrund eines großen Unfalls | DELAYED |
301 | 000 | Sendung an Kunden geliefert | DELIVERED |
101 | 000 | Die Sendung hat das Versandzentrum verlassen | DEPARTED\_FROM\_FC |
201 | 000 | Die Sendung kam bei einer Speditionseinrichtung an | IN\_TRANSIT |
409 | 000 | Der Spediteur hat die Sendung verloren | LOST |
302 | 000 | Die Sendung wird ausgeliefert | OUT\_FOR\_DELIVERY |
407 | 000 | Der Empfänger hat die Annahme der Sendung verweigert | REJECTED |
416 | 000 | Die Sendung ist nicht zustellbar und wird vernichtet | UNDELIVERABLE |
X12-Statuscode | X12-Ursachencode | Operative Beschreibung | Äquivalenz der Benutzeroberfläche von Vendor Central |
---|---|---|---|
DE | AF | Der Versand verzögert sich aufgrund eines großen Unfalls | DELAYED |
D1 | NS | Sendung an Kunden geliefert | DELIVERED |
XB | NS | Die Sendung hat das Versandzentrum verlassen | DEPARTED\_FROM\_FC |
O1 | NS | Die Sendung kam bei einer Speditionseinrichtung an | IN\_TRANSIT |
CA | PL | Der Spediteur hat die Sendung verloren | LOST |
OD | NS | Die Sendung wird ausgeliefert | OUT\_FOR\_DELIVERY |
A7 | AM | Der Empfänger hat die Annahme der Sendung verweigert | REJECTED |
AP | BG | Die Sendung ist nicht zustellbar und wird vernichtet | UNDELIVERABLE |
submitShipmentStatusUpdates-Anfrage
Um Aktualisierungen des Versandstatus einzureichen, rufen Sie den Vorgang submitShipmentStatusUpdates
auf und übergeben Sie den folgenden Parameter:
Textparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
shipmentStatusUpdates |
Liste der bestätigten Sendungen. Typ: < |
Ja |
Beispiel für eine Anfrage:
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates
{
"shipmentStatusUpdates": [
{
"purchaseOrderNumber": "DX00050015",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"statusUpdateDetails": {
"trackingNumber": "TRACK005",
"statusCode": "D1",
"reasonCode": "NS",
"statusDateTime": "2020-08-07T19:56:45Z",
"statusLocationAddress": {
"city": "Any Town",
"postalCode": "98101",
"stateOrRegion": "Washington",
"countryCode": "US"
}
}
}
]
}
submitShipmentStatusUpdates-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
transactionId |
GUID zur Identifizierung dieser Transaktion. Dieser Wert kann in der Transaktionsstatus-API verwendet werden, um den Status dieser Transaktion zurückzugeben. Typ: Zeichenfolge |
Ja |
Beispiel für eine Antwort:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
getPackingSlips
Der Vorgang getPackingSlips
gibt eine Liste der Packzettel für die Bestellungen zurück, die die angegebenen Kriterien erfüllen. Wenn Sie einen Packzettel für eine bestimmte Bestellung benötigen, verwenden Sie stattdessen den Vorgang getPackingSlip
.
Restricted Data Token für die Autorisierung
Dies ist ein eingeschränkter Vorgang und erfordert daher ein Restricted Data Token (RDT) für die Autorisierung. Weitere Informationen finden Sie im Leitfaden zu Token-API-Anwendungsfällen.
Sie sollten diese API verwenden, um Packzettel für die Bestellungen abzurufen, die zum Versand bereitstehen. Amazon empfiehlt Anbietern, während der Geschäftszeiten mindestens einmal pro Stunde auf Versandetiketten zu überprüfen. Abhängig von Ihrem Geschäftsvolumen können Sie sich dafür entscheiden, häufiger zu prüfen. Sie können bis zu 100 Packzettel in einem API-Aufruf abrufen. Wenn es mehr als 100 Packzettel gibt, können Sie den nextToken-Wert als Parameter in Ihrer nächsten Anfrage verwenden, um den nächsten Satz abzurufen.
Das folgende Diagramm zeigt den Integrations-Workflow beim Abrufen von Packzetteln:
getPackingSlips-Anfrage
Um Packzettel abzurufen, rufen Sie den Vorgang getPackingSlips
auf und übergeben Sie die folgenden Parameter:
Abfrageparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
shipFromPartyId |
Der Anbieter warehouseId für den Bestellversand. Wenn nicht angegeben, enthält das Ergebnis Bestellungen für alle Lagerhäuser. Typ: Zeichenfolge |
Nein |
limit |
Das Limit für die Anzahl der zurückgegebenen Datensätze. Minimum: 1 Maximum: 100 Typ: Ganzzahl |
Nein |
createdAfter |
Packzettel, die nach diesem Datum und dieser Uhrzeit verfügbar wurden, werden in das Ergebnis aufgenommen. Muss im Datums-/Uhrzeitformat ISO-8601 vorliegen. Typ: Zeichenfolge (Datum-Uhrzeit) |
Ja |
createdBefore |
Packzettel, die vor diesem Datum und dieser Uhrzeit verfügbar waren, werden in das Ergebnis aufgenommen. Muss im Datums-/Uhrzeitformat ISO-8601 vorliegen. Typ: Zeichenfolge (Datum-Uhrzeit) |
Ja |
sortOrder |
Sortieren Sie ASC oder DESC nach dem Datum der Erstellung des Packzettels. Typ: Enumeration ( |
Nein |
nextToken |
Wird für die Paginierung verwendet, wenn mehr Packzettel als die angegebene Ergebnisgrößenbeschränkung vorliegen. Der Tokenwert wird im vorherigen API-Aufruf zurückgegeben. Typ: Zeichenfolge |
Nein |
Beispiel für eine Anfrage:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/packingSlips?createdBefore=2020-06-12T12:00:00-08:00&createdAfter=2020-06-12T00:00:00-08:00&limit=2&sortOrder=DESC
getPackingSlips-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
pagination |
Wenn mehr als 100 Bestellungen zurückgegeben werden, wird nextToken in der Antwort für die Paginierung zurückgegeben. Typ: Zeichenfolge |
Nein |
packingSlips |
Enthält Details zu den Packzetteln. Typ: < |
Nein |
Beispiel für eine Antwort:
{
"payload": {
"pagination": {
"nextToken": "NEBxNEBxNEBxNR=="
},
"packingSlips": [
{
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}, {
"purchaseOrderNumber": "VvgCDdBjR",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
]
}
}
getPackingSlip
Der Vorgang getPackingSlip
gibt Informationen über den spezifischen Packzettel zurück, den Sie anhand der Bestellnummer angeben. Die Antwort enthält eine Base64-kodierte Zeichenfolge des Packzettels. Der Inhaltstyp wird immer "application/pdf" sein.
Das folgende Diagramm zeigt den Integrations-Workflow beim Abrufen eines Packzettels:
getPackingSlip-Anfrage
Um einen Packzettel zurückzugeben, rufen Sie den VorganggetPackingSlip
auf und übergeben Sie den folgenden Parameter:
Pfadparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
purchaseOrderNumber |
Die purchaseOrderNumber für den von Ihnen gewünschten Packzettel. Typ: Zeichenfolge |
Ja |
Beispiel für eine Anfrage:
GET https://sellingpartnerapi-na.amazon.com /vendor/directFulfillment/shipping/v1/packingSlips/UkP3YkKDr
getPackingSlip-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
purchaseOrderNumber |
Bestellnummer der Sendung, für die der Packzettel bestimmt ist. Typ: Zeichenfolge |
Nein |
packingSlip |
Informationen zum Packzettel. Typ: |
Nein |
Beispiel für eine Antwort:
{
"payload": {
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
}
Kundenrechnungen abrufen
The getCustomerInvoices
operation returns customer invoices for all purchase orders which meet the filter criteria you specify. The use of this API is mandatory only in the India region and not required in any other region. Amazon recommends that vendors check for customer invoices at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 customer invoices in one API call. If there are more than 100 customer invoices you can use the nextToken
value as a parameter in the next request to get the next set of customer invoices.
Restricted Data Token für die Autorisierung
Dies ist ein eingeschränkter Vorgang und erfordert daher ein Restricted Data Token (RDT) für die Autorisierung. Weitere Informationen finden Sie im Leitfaden zu Token-API-Anwendungsfällen.
Das folgende Diagramm zeigt den Integrations-Workflow beim Abrufen von Kundenrechnungen:
getCustomerInvoices-Anfrage
Um Kundenrechnungen zurückzugeben, rufen Sie den Vorgang getCustomerInvoices
auf und übergeben Sie die folgenden Parameter:
Abfrageparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
shipFromPartyId |
Das warehouseId des Anbieters für den Bestellversand. Wenn nicht angegeben, enthält das Ergebnis Bestellungen für alle Lagerhäuser. Typ: Zeichenfolge |
Nein |
limit |
Das Limit für die Anzahl der zurückgegebenen Datensätze. Minimum: 1 Maximum: 10 Typ: Ganzzahl |
Nein |
createdAfter |
Bestellungen, die nach diesem Datum und dieser Uhrzeit verfügbar wurden, werden in das Ergebnis aufgenommen. Muss im Datums-/Uhrzeitformat ISO-8601 vorliegen. Typ: Zeichenfolge (Datum-Uhrzeit) |
Ja |
createdBefore |
Bestellungen, die vor diesem Datum und dieser Uhrzeit verfügbar waren, werden in das Ergebnis aufgenommen. Muss im Datums-/Uhrzeitformat ISO-8601 vorliegen. Typ: Zeichenfolge (Datum-Uhrzeit) |
Ja |
sortOrder |
Sortieren Sie aufsteigend oder absteigend nach dem Erstellungsdatum der Bestellung. Typ: Enumeration ( |
Nein |
nextToken |
Wird für die Paginierung verwendet, wenn mehr Bestellungen als die angegebene Ergebnisgrößenbeschränkung vorliegen. Der Tokenwert wird im vorherigen API-Aufruf zurückgegeben. Typ: Zeichenfolge |
Nein |
Beispiel für eine Anfrage:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/customerInvoices?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
getCustomerInvoices-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
pagination |
Wenn mehr als 100 Kundenrechnungen zurückgegeben werden, wird nextToken in der Antwort für die Paginierung zurückgegeben. Typ: Zeichenfolge |
Nein |
customerInvoices |
Liste der Kundenrechnungen. Typ: < |
Nein |
Beispiel für eine Antwort:
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"customerInvoices": [
{
"purchaseOrderNumber": "PO98676856",
"content": "base 64 content goes here"
}
]
}
Kundenrechnung abrufen
Der Vorgang getCustomerInvoice
gibt Informationen über die Kundenrechnung zurück, die Sie anhand der Bestellnummer angeben. Die Antwort enthält vollständige Kundenrechnungsinformationen für diese Bestellung.
Sie können diese API auch verwenden, um Details für jede Kundenrechnung abzurufen (im Zeitraum von 7 Tagen ab einem fortlaufenden Zeitfenster der letzten 6 Monate, nachdem der Anbieter in der API aktiviert wurde).
Das folgende Diagramm zeigt den Integrations-Workflow für das Abrufen einer Kundenrechnung:
Länderspezifische Geschäftsanforderungen
Nur die Region Indien muss die Kundenrechnungs-API verwenden.
getCustomerInvoice-Anfrage
Um eine Kundenrechnung zurückzugeben, rufen Sie den Vorgang getCustomerInvoice
auf und übergeben Sie den folgenden Parameter:
Pfadparameter:
Name | Beschreibung | Erforderlich |
---|---|---|
purchaseOrderNumber |
Bestellnummer der Sendung, für die die Rechnung zurückgesendet werden soll. Typ: Zeichenfolge |
Ja |
Beispiel für eine Anfrage:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC
getCustomerInvoice-Antwort
Eine erfolgreiche Antwort umfasst Folgendes:
Name | Beschreibung | Erforderlich |
---|---|---|
purchaseOrderNumber |
Die Bestellnummer für diese Bestellung. Typ: Zeichenfolge |
Ja |
content |
Die Base64-kodierte Kundenrechnung. Typ: Zeichenfolge |
Ja |
Beispiel für eine Antwort:
{
"payload": {
"purchaseOrderNumber": "PO98676856",
"content": "base 64 encoded string"
}
}
Updated 23 days ago