レスポンス形式
SP-APIがレスポンスヘッダーとメッセージを返す方法。
HTTPリクエストへのレスポンスとして、Selling Partner APIはレスポンスヘッダーとJSONレスポンスメッセージを返します。
次の表は、受け取る可能性のあるレスポンスヘッダーの一覧です。実際に受け取るヘッダーは、特定のAPIセクションとオペレーションによって異なります。
レスポンスヘッダー
名前 | 説明 | 例 |
---|---|---|
接続 | クライアントとの持続的接続のためのデフォルト値keep-alive。 | Connection: keep-alive |
Content-Length | 標準HTTPレスポンスヘッダー。 | Content-Length: 624 |
Content-Type | 標準HTTPレスポンスヘッダー。 | Content-Type: application/json |
日付 | 標準HTTPレスポンスヘッダー。 | Date: Fri, 17 Feb 2023 20:13:55 GMT |
x-amz-apigw-id | APIゲートウェイによって作成された拡張リクエストID。このヘッダーはオプションで、返されない場合があります。 | x-amz-apigw-id: Ac1E1EycvHcFyNw= |
x-amzn-ErrorType | APIGatewayは、応答ステータスコードが4xxまたは5xxの場合、このエラーにerrorTypeを設定します。このヘッダーはオプションで、返されない場合があります。 | 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 | リクエスト識別子。サポートに問い合わせる場合、これをお伝えください。 | x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9bExample |
X-Amzn-Trace-Id | APIGatewayによって生成されたトレース識別子。このヘッダーはオプションで、返されない場合があります。 | X-Amzn-Trace-Id: Root=1-63ee9bb8-52ea8e6d108209842abc2a4d |
成功レスポンス
リクエストが成功すると、Selling Partner APIはリクエストされたデータを返します。成功レスポンスの例を以下に示します。
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"
}
}
エラーレスポンス
リクエストが成功しなかった場合は、Selling Partner APIはエラーレスポンスを返します。エラーレスポンスに含まれるレスポンスメッセージの要素は次のとおりです。
レスポンスメッセージ
要素 | 説明 | 必須 |
---|---|---|
code | HTTPステータスコード。 | はい |
message | エラー状態の説明。 | はい |
details | 追加情報へのリンク。 | いいえ |
エラーレスポンスの例を次に示します。
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
このページは役に立ちましたか?