Menu
API - recupera tutti gli ordini
API - recupera tutti gli ordini
Questo endpoint permette di recuperare le informazioni di tutti i tuoi ordini.
Richiesta
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/orders
Produzione: https://api.soisy.it/api/shops/{shopId}/orders
Metodi accettati
GET
Headers
Accept: text/csv
Gli ordini sono mostrati solo in formato CSV.
Autenticazione
Questa API richiede l’autenticazione tramiteshopId e header X-Auth-Token.Parametri GET
È possibile utilizzare i seguenti parametri GET opzionali direttamente nell’URL.| Parametro | Obbligatorio | Tipo | Formato | Descrizione |
|---|---|---|---|---|
| fromCreatedAt | No | String | yyyy-mm-dd | Filtra i risultati dal giorno specificato di creazione dell’ordine in avanti |
| fromDisbursedAt | No | String | yyyy-mm-dd | Filtra i risultati dal giorno specificato di liquidazione dell’ordine in avanti. NOTA: Questo filtro ignora il valore del filtro status se presente. |
| status | No | String | Può essere uno fra i seguenti valori: quote, request_received, request_accepted,waiting_for_verification, waiting_for_disbursement, disbursed, cancelled. | Filtra i risultati per tipologia di stato di un ordine |
Risposta
L’API restituisce un oggetto in formato CSV con la seguente struttura:| Campo | Tipo | Descrizione |
|---|---|---|
| soisyOrderReference | Stringa | Token univoco di identificazione dell’ordine |
| orderReference | Stringa | Codice di riferimento dell’ordine o altro riferimento |
| firstName | Stringa | Nome del richiedente |
| lastName | Stringa | Cognome del richiedente |
| loanNetAmount | Float | Importo che vedrai accreditato sul tuo conto per questo ordine, in caso di pagamento andato a buon fine. In € |
| loanAmount | Float | Totale ordine, in € |
| zeroInterestRate | Booleano | Indica se è l’opzione tasso zero è attiva per questo ordine |
| feeForDisbursement | Float o null | Importo che indica la commissione sostenuta dal partner per il pagamento dell’ordine. Questo valore è popolato solo dopo l’addebito. |
| status | Stringa | Stato dell’ordine. |
| requestedAt | Stringa | Data di creazione dell’ordine |
| disbursedAt | Stringa | Data in cui l’ordine è stato finanziato e l’ordine è passato allo stato Finanziato |
| instalments | Intero | Numero di rate del pagamento rateale |
Codici HTTP di risposta
| Codice | Descrizione |
|---|---|
| 200 | Richiesta completata con successo |
| 400 | Invalid HTTP Accept header |
| 404 | Risorsa non trovata |
| 500 | Errore di sistema |
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": "No orders found"
}
Errore 500
Le risposte con questo codice HTTP indicano che si è verificato un errore di sistema.
{
"errors": {errorMessage}
}
