Formato di risposta
In che modo SP-API restituisce le intestazioni e i messaggi di risposta.
In risposta a una richiesta HTTP, l'API per i partner di vendita restituisce le intestazioni di risposta e un messaggio di risposta JSON.
La tabella seguente elenca le intestazioni di risposta che potresti ricevere. Le intestazioni effettive che riceverai dipenderanno dalla sezione e dal funzionamento specifici dell'API.
Intestazioni di risposta
Nome | Descrizione | Esempio |
---|---|---|
Connessione | Valore predefinito keep-alive per una connessione persistente con il client. | Connection: keep-alive |
Lunghezza del contenuto | Intestazione di risposta HTTP standard. | Content-Length: 624 |
Tipo di contenuto | Intestazione di risposta HTTP standard. | Content-Type: application/json |
Data | Intestazione di risposta HTTP standard. | Date: Fri, 17 Feb 2023 20:13:55 GMT |
x-amz-apigw-id | ID di richiesta esteso creato da APIGateway. Questa intestazione è facoltativa e non può essere restituita. | x-amz-apigw-id: Ac1E1EycvHcFyNw= |
x-amzn-ErrorType | APIGateway compila questo errore con ErrorType se il codice di stato della risposta è 4xx o 5xx. Questa intestazione è facoltativa e potrebbe non essere restituita. | x-amzn-ErrorType: AccessDeniedException |
x-amzn-RateLimit-Limit | Restituisce il limite di velocità applicato alla richiesta. Questa intestazione viene restituita nel migliore dei modi e solo per risposte HTTP specifiche. Fare riferimento a Piani di utilizzo e limiti di tariffa nell'SP-API per ulteriori informazioni. | x-amzn-RateLimit-Limit: 2.0 |
x-amzn-RequestId | Identificativo della richiesta. Forniscilo se ci contatti per ricevere assistenza. | x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9bExample |
X-Amzn-Trace-Id | Un identificatore di traccia generato da ApiGateway. Questa intestazione è facoltativa e potrebbe non essere restituita. | X-Amzn-Trace-Id: Root=1-63ee9bb8-52ea8e6d108209842abc2a4d |
Risposta di successo
Se la tua richiesta è andata a buon fine, l'API per i partner di vendita restituisce i dati richiesti. Ecco un esempio di risposta riuscita:
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"
}
}
Risposta all'errore
Se la tua richiesta non va a buon fine, l'API per i partner di vendita restituisce una risposta di errore. Ecco gli elementi del messaggio di risposta in una risposta di errore:
Messaggio di risposta
Elemento | Descrizione | Obbligatorio |
---|---|---|
code | Codice di stato HTTP. | Sì |
message | Spiegazione della condizione di errore. | Sì |
details | Link a informazioni aggiuntive. | No |
Ecco un esempio di risposta di errore:
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