Get an order

This endpoint allows you to retrieve the information of a previously created order.

Request

Endpoint

Sandbox: https://api.sandbox.soisy.it/api/shops/{shopId}/orders/{token}
Production: https://api.soisy.it/api/shops/{shopId}/orders/{token}

Accepted methods

GET

Authentication

This API requires authentication via shopId and headerX-Auth-Token.

Prerequisites

To access this endpoint you must have successfully completed creating an order.

Response

The API returns a JSON object.

HTTP Error codes

Code Description
200 Request completed successfully
404 Resource not found
500 System error

Valid response

{
     "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>,
     "callbackUrl": <stringa>,
     "orderReference": <stringa>,

     "createdAt": <stringa>,
     "updatedAt": <stringa>,
     "loanDisbursedAt": <stringa>,
     "loanVerifiedAt": <stringa>,
     "loanSignedAt": <stringa>
}

Where:

Parameter Type Description
shopOrderId String Resource ID in the Soisy platform
token String Single-item order identification token
shopId String Id of the sales channel from which the order arrived
loanFinality String Purpose of payment
instalmentsNumber Total Number of installments
loanAmount Total Order total, in € cents
loanNetAmount Total Amount that you will see credited to your account for this order, in case of successful payment. In € cents
status String Order status. See the complete list of statuses.
zeroInterestRate Boolean Indicates if it is 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 user abandonment
callbackUrl String URL of your server for automated callback calls. See later on this page
orderReference String Order reference code or other reference
createdAt String Order creation date
updatedAt String Date of last modification of the order
loanDisbursedAt String Date on which the order was financed and the order went to the Financed state
loanVerifiedAt String Date on which the documents were accepted and the order passed to the Request approved status
loanSignedAt String Date on which the user signed the contract and the order was transferred to the Waiting for signature status

Error response

The JSON object returned in the event of an error varies depending on the HTTP response code.

Error 403

The request sent contains invalid credentials. Check the shopId and the X-Auth-Token header. Find more info on credentials in the paragraph about authentication.

 {
     "errors": "Authentication Failed"
 }

404 Error

Replies with this HTTP code indicate that the resource was not found.

 {
     "errors": "Order not found"
 }

Error 500

Replies with this HTTP code indicate that a system error has occurred.

 {
     "errors": {errorMessage}
 }