Get all orders

This endpoint allows you to retrieve all the orders of one of your sales channels

Request

Endpoint

Sandbox: http://api.sandbox.soisy.it/api/shops/{shopId}/orders
Production: 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 authorization with shopId and X-Auth-Token header .

Response

This API returns a CSV with the following structure:

Field Type Description
soisyOrderReference String Unique order token
orderReference String Ecommerce internal order code or other reference
firstName String
lastName String
loanNetAmount Float
loanAmount Float
zeroInterestRate Boolean
feeForDisbursement Float or null Partner's commission, set after the loan disbursement
status String Order status, can be either quote, request_received, request_approved, waiting_for_signature, waiting_for_disbursement, cancelled or disbursed.
requestedAt String Loan request datetime
disbursedAt String Loan disbursement datetime

HTTP Response codes

Codice Descrizione
200 Returned when successful
403 Invalid HTTP Accept header
403 Forbidden
404 The resource has not been found
500 System error

Error 403

 {
     "errors": "Authentication Failed"
 }

Error 404

 {
     "errors": "No orders found"
 }

Error 500

 {
     "errors": {errorMessage}
 }