Menu
API - recover all orders
API - recover all orders
This endpoint allows you to retrieve the information of all your orders.
Request
Endpoint
Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/orders
Produzione: https://api.soisy.it/api/shops/{shopId}/orders
Accepted methods
GET
Headers
Accept: text/csv
Orders are shown in CSV format only.
Authentication
This API requires authentication viashopId and header X-Auth-Token.GET parameters
You can use the following optional GET parameters directly in the URL.| Parameter | Obligatory | Type | Format | Description |
|---|---|---|---|---|
| fromCreatedAt | No | String | yyyy-mm-dd | Filters the results from the specified day of order creation onwards |
| fromDisbursedAt | No | String | yyyy-mm-dd | Filters the results from the specified order settlement day onwards. NOTE: This filter ignores the filter valuestatus if present. |
| status | No | String | It can be one of the following values: quote, request_received, request_accepted,waiting_for_verification, waiting_for_disbursement, disbursed, cancelled. | Filter the results by type of order status |
Answer
The API returns an object in CSV format with the following structure:| Field | Type | Description |
|---|---|---|
| soisyOrderReference | String | Unique token to identify the order |
| orderReference | String | Order reference code or other reference |
| firstName | String | Name of the applicant |
| lastName | String | Surname of the applicant |
| loanNetAmount | Float | Amount that you will see credited to your account for this order, in case of successful payment. In € |
| loanAmount | Float | Total order, in € |
| zeroInterestRate | Boolean | Indicates whether the zero rate option is active for this order |
| feeForDisbursement | Float or null | Amount indicating the commission incurred by the partner for the payment of the order. This value is populated only after being charged. |
| status | String | Order status. |
| requestedAt | String | Order creation date |
| disbursedAt | String | Date the order was funded and the order passed to the state Finanziato |
| instalments | Entire | Number of installments of the installment payment |
HTTP response codes
| Code | Description |
|---|---|
| 200 | Request completed successfully |
| 400 | Invalid HTTP Accept header |
| 404 | Resource not found |
| 500 | System error |
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": "No orders found"
}
Error 500
Responses with this HTTP code indicate that a system error has occurred.
{
"errors": {errorMessage}
}
