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

				
			

Questa API richiede l’autenticazione tramite shopId e header X-Auth-Token.

Per accedere a questo endpoint è necessario aver completato con successo la creazione di un ordine.

L’API restituisce un oggetto JSON.

Codice Descrizione
200Richiesta completata con successo
404Risorsa non trovata
500Errore di sistema
				
					{
     "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:
ParametroTipoDescrizione
shopOrderIdStringaID della risorsa nella piattaforma Soisy
tokenStringaToken univoco di identificazione dell’ordine
shopIdStringaId del canale di vendita dal quale è arrivato l’ordine
loanFinalityStringaFinalità del pagamento
instalmentsNumberInteroNumero di rate
loanAmountInteroTotale ordine, in centesimi di €
loanNetAmountInteroImporto che vedrai accreditato sul tuo conto per questo ordine, in caso di pagamento andato a buon fine. In centesimi di €
statusStringaStato dell’ordine.
zeroInterestRateBooleanoIndica se è l’opzione tasso zero è attiva per questo ordine
successUrlStringaURL sul tuo sito, verso il quale reindirizzare l’utente in caso di successo
errorUrlStringaURL sul tuo sito, verso il quale reindirizzare l’utente in caso di errore o abbandono dell’utente
callbackUrlStringaURL di un tuo server per le chiamate di callback automatizzate. Vedi più avanti in questa pagina
orderReferenceStringaCodice di riferimento dell’ordine o altro riferimento
createdAtStringaData di creazione dell’ordine
updatedAtStringaData di ultima modifica dell’ordine
loanDisbursedAtStringaData in cui l’ordine è stato finanziato e l’ordine è passato allo stato Finanziato
loanVerifiedAtStringaData in cui i documenti sono stati accettati e l’ordine è passato allo stato Richiesta approvata
loanSignedAtStringaData in cui l’utente ha firmato il contratto e l’ordine è passato allo stato In attesa di firma
L’oggetto JSON restituito in caso di errore varia a seconda del codice HTTP di risposta. La richiesta inviata contiene delle credenziali non valide. Controlla lo shopId e l’header X-Auth-Token. Trovi maggiori info sulle credenziali nel paragrafo dell’autenticazione.
				
					 {
     "errors": "Authentication Failed"
 }
				
			

Le risposte con questo codice HTTP indicano che la risorsa non è stata trovata.

				
					 {
     "errors": "Order not found"
 }
				
			

Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.

				
					 {
     "errors": {errorMessage}
 }
				
			

Ciao!

Siamo on line dal lunedì al venerdì dalle 9.30 alle 12.30 e dalle 14.30 alle 17.30

Scrivici in questi orari, grazie!