Menu
API - recupera un ordine singolo
API - recupera un ordine singolo
Questo endpoint permette di recuperare le informazioni di un ordine creato in precedenza.
Richiesta
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/orders/{token}
Produzione: https://api.soisy.it/api/shops/{shopId}/orders/{token}
Metodi accettati
GET
Autenticazione
Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.
Prerequisiti
Per accedere a questo endpoint è necessario aver completato con successo la creazione di un ordine.
Risposta
L’API restituisce un oggetto JSON.
Codici HTTP di risposta
| Codice | Descrizione |
|---|---|
| 200 | Richiesta completata con successo |
| 404 | Risorsa non trovata |
| 500 | Errore di sistema |
Risposta valida
{
"shopOrderId": <stringa>,
"token": <stringa>,
"shopId": <stringa>,
"firstname": <stringa>,
"lastname": <stringa>,
"fiscalCode": <stringa>,
"vatId": <stringa>,
"vatCountry": <stringa>,
"email": <stringa>,
"mobilePhone": <stringa>,
"address": [
"city": <stringa>,
"province": <stringa>,
"address": <stringa>,
"civicNumber": <stringa>,
"postalCode": <stringa>
],
"loanFinality": <stringa>,
"instalmentsNumber": <intero>,
"loanAmount": <intero>,
"loanNetAmount": <intero>,
"status": <stringa>,
"zeroInterestRate": <stringa>,
"errorUrl": <stringa>,
"successUrl": <stringa>,
"orderReference": <stringa>,
"createdAt": <stringa>,
"updatedAt": <stringa>,
"loanDisbursedAt": <stringa>,
"loanVerifiedAt": <stringa>,
"loanSignedAt": <stringa>
}
Dove:
| Parametro | Tipo | Descrizione |
|---|---|---|
| shopOrderId | Stringa | ID della risorsa nella piattaforma Soisy |
| token | Stringa | Token univoco di identificazione dell’ordine |
| shopId | Stringa | Id del canale di vendita dal quale è arrivato l’ordine |
| loanFinality | Stringa | Finalità del pagamento |
| instalmentsNumber | Intero | Numero di rate |
| loanAmount | Intero | Totale ordine, in centesimi di € |
| loanNetAmount | Intero | Importo che vedrai accreditato sul tuo conto per questo ordine, in caso di pagamento andato a buon fine. In centesimi di € |
| status | Stringa | Stato dell’ordine. |
| zeroInterestRate | Booleano | Indica se è l’opzione tasso zero è attiva per questo ordine |
| successUrl | Stringa | URL sul tuo sito, verso il quale reindirizzare l’utente in caso di successo |
| errorUrl | Stringa | URL sul tuo sito, verso il quale reindirizzare l’utente in caso di errore o abbandono dell’utente |
| callbackUrl | Stringa | URL di un tuo server per le chiamate di callback automatizzate. Vedi più avanti in questa pagina |
| orderReference | Stringa | Codice di riferimento dell’ordine o altro riferimento |
| createdAt | Stringa | Data di creazione dell’ordine |
| updatedAt | Stringa | Data di ultima modifica dell’ordine |
| loanDisbursedAt | Stringa | Data in cui l’ordine è stato finanziato e l’ordine è passato allo stato Finanziato |
| loanVerifiedAt | Stringa | Data in cui i documenti sono stati accettati e l’ordine è passato allo stato Richiesta approvata |
| loanSignedAt | Stringa | Data in cui l’utente ha firmato il contratto e l’ordine è passato allo stato In attesa di firma |
Risposta di errore
L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta.Errore 403
La richiesta inviata contiene delle credenziali non valide. Controlla lo shopId e l’headerX-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell’autenticazione.
{
"errors": "Authentication Failed"
}
Errore 404
Le risposte con questo codice HTTP indicano che la risorsa non è stata trovata.
{
"errors": "Order not found"
}
Errore 500
Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.
{
"errors": {errorMessage}
}
