Menu
API - retrieve a single order
API - retrieve a single order
This endpoint allows you to retrieve the information of a previously created order.
Request
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/orders/{token}
Produzione: https://api.soisy.it/api/shops/{shopId}/orders/{token}
Accepted methods
GET
Authentication
This API requires authentication viashopId and headerX-Auth-Token .
Prerequisites
To access this endpoint, you must have successfully completed creating an order.
Answer
The API returns a JSON object.
HTTP response codes
| Code | Description |
|---|---|
| 200 | Request completed successfully |
| 404 | Resource not found |
| 500 | System error |
Valid answer
{
"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>
}
Where :
| Parameter | Type | Description |
|---|---|---|
| shopOrderId | String | Asset ID in the Soisy platform |
| token | String | Unique token to identify the order |
| shopId | String | Id of the sales channel from which the order came |
| loanFinality | String | Purpose of the payment |
| instalmentsNumber | Entire | Number of installments |
| loanAmount | Entire | Total order, in € cents |
| loanNetAmount | Entire | Amount that you will see credited to your account for this order, in case of successful payment. In € cents |
| status | String | Order status. |
| zeroInterestRate | Boolean | Indicates whether the zero rate option is active for this order |
| successUrl | String | URL on your site, to which to redirect the user in case of success |
| errorUrl | String | URL on your site, to which to redirect the user in case of error or abandonment of the user |
| callbackUrl | String | URL of your server for automated callback calls. See further on this page |
| orderReference | String | Order reference code or other reference |
| createdAt | String | Order creation date |
| updatedAt | String | Date of the last modification of the order |
| loanDisbursedAt | String | Date the order was funded and the order passed to the state Finanziato |
| loanVerifiedAt | String | Date the documents were accepted and the order passed to the state Richiesta approvata |
| loan Yes gnedAt | String | Date the user signed the contract and the order went into status In attesa di firma |
Error response
The JSON object returned in the event of an error varies depending on the HTTP response code.Error 403
The sent request contains invalid credentials. Check the shopId and headerX-Auth-Token. Find more info on credentials in the authentication paragraph.
{
"errors": "Authentication Failed"
}
Error 404
Responses with this HTTP code indicate that the resource was not found.
{
"errors": "Order not found"
}
Error 500
Responses with this HTTP code indicate that a system error has occurred.
{
"errors": {errorMessage}
}
