Antwort-Format
Wie SP-API Antwort-Header und Nachrichten zurückgibt.
Als Antwort auf eine HTTP-Anfrage gibt die Verkaufspartner-API Antwort-Header und eine JSON-Antwortnachricht zurück.
In der folgenden Tabelle sind die Antwort-Header aufgeführt, die Sie möglicherweise erhalten. Die tatsächlichen Header, die Sie erhalten, hängen vom jeweiligen API-Abschnitt und der jeweiligen API-Operation ab.
Antwort-Header
Name | Beschreibung | Beispiel |
---|---|---|
Verbindung | Standardwert keep-alive für eine dauerhafte Verbindung mit dem Client. | Connection: keep-alive |
Inhalt-Länge | Standard-HTTP-Antwort-Header. | Content-Length: 624 |
Inhaltstyp | Standard-HTTP-Antwort-Header. | Content-Type: application/json |
Datum | Standard-HTTP-Antwort-Header. | Date: Fri, 17 Feb 2023 20:13:55 GMT |
x-amz-apigw-id | Erweiterte Anforderungs-ID, die von APIGateway erstellt wurde. Dieser Header ist optional und kann nicht zurückgegeben werden. | x-amz-apigw-id: Ac1E1EycvHcFyNw= |
x-amzn-ErrorType | APIGateway füllt diesen Fehler mit dem ErrorType auf, wenn der Antwortstatuscode 4xx oder 5xx lautet. Dieser Header ist optional und kann nicht zurückgegeben werden. | x-amzn-ErrorType: AccessDeniedException |
x-amzn-RateLimit-Limit | Returns the rate limit applied to the request. This header is returned on a best-effort basis and only for specific HTTP responses. Refer to Usage Plans and Rate Limits in the SP-API for more information. | x-amzn-RateLimit-Limit: 2.0 |
x-amzn-RequestId | Bezeichnung anfordern. Geben Sie diese an, wenn Sie sich an den Support wenden. | x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9bExample |
X-Amzn-Trace-Id | Eine von APIGateway generierte Trace-Bezeichnung. Dieser Header ist optional und darf nicht zurückgegeben werden. | X-Amzn-Trace-Id: Root=1-63ee9bb8-52ea8e6d108209842abc2a4d |
Erfolgreiche Antwort
Wenn Ihre Anfrage erfolgreich ist, gibt die Verkaufspartner-API die angeforderten Daten zurück. Hier ist ein Beispiel für eine erfolgreiche Antwort:
HTTP/1.1 200 OK
Content-Length: 368
Content-Type: application/json
Date: Thu, 01 Jun 2020 22:23:31 GMT
x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9bExample
{
"payload": {
"ConfirmedNeedByDate": "2020-04-23",
"ConfirmedFulfillableDate": "2020-04-23"
}
}
Fehlermeldung
Wenn Ihre Anfrage nicht erfolgreich ist, gibt die Verkaufspartner-API eine Fehlermeldung zurück. Hier sind die Elemente der Antwortnachricht in einer Fehlermeldung:
Antwortnachricht
Element | Beschreibung | Erforderlich |
---|---|---|
code | HTTP-Statuscode. | Ja |
message | Erklärung des Fehlerzustands. | Ja |
details | Link zu zusätzlichen Informationen. | Nein |
Hier ist ein Beispiel für eine Fehlermeldung:
HTTP/1.1 400 Bad Request
Content-Length: 117
Content-Type: application/json
Date: Fri, 01 Jun 2020 21:48:02 GMT
x-amzn-ErrorType: ValidationException
x-amzn-RequestId: a8c8d99a-6ab5-11e8-b0f8-19363980175b
{
"errors": [
{
"message": "Access to requested resource is denied.",
"code": "Unauthorized",
"details": "Access token is missing in the request header."
}
]
}
Updated 23 days ago