1. Orders
ScuolaSemplice Web API
  • v2
    • Payments
      • registerInstallmentPayment
    • Orders
      • fetchUserOrders
    • Aggregator
      • Update timetable
      • Booking lesson
      • Cancel booking
      • Set attendances
    • Custom fields
      • Read all custom fields
      • Fetch ustom field
    • Workflows
      • Returns list of all workflows
      • Start a new workflow instance
    • StudyPlans
      • Returns list of all study plans
    • Subscriptions
      • fetchSubscriptions
      • Subscribe a student to a class
      • Alter subscriprion of a student to a class
    • Classes
      • Retuns list of class models
      • Creates a class model / catalogue
      • Updates a class model / catalogue
      • Creates a class from a model
      • Reads all list of classes from archive
      • Reads all classes added or updated after timestamp
    • Students
      • Reads paginated list of students
      • Fetch student
      • Creates new student and return the id
      • Updates an existing student and return the id
      • Reads all list of students from archive
      • Reads all students added or updated after timestamp
    • Catalogues
      • Returns list of system branches
      • Returns list of classes custom fields
      • Returns list of all locations
  • v3
    • Classes
      • classes
      • classes/{id}
    • Exams
      • exams
      • exams/{id}
    • Lessons
      • lessons
      • lessons/{id}
    • Orders
      • orders
        GET
      • orders/{id}
        GET
      • Order creation
        POST
    • PackageOffers
      • packageoffers
      • packageoffers/{id}
    • ProfileCustomSelectValues
      • profilecustomselectvalues
    • Payments
      • payments
      • payments/{id}
    • QrReadings
      • qrreadings
      • qrreadings/{id}
      • qrreadings
    • Students
      • students
      • students/{id}
      • create
      • update
      • update by externid
      • create student comment
    • Teachers
      • teachers/{id}
      • teachers
      • create
      • update
      • update by externid
    • CustomerCompanies
      • customercompanies
      • customercompanies/{id}
    • Subscriptions
      • classes
        • subscriptions/classes
        • subscriptions/classes/{id}
        • create subscription class
      • exams
        • subscriptions/exams
        • subscriptions/exams/{id}
        • create subscription exam
      • studyplans
        • subscriptions/studyplans
        • subscriptions/studyplans/{id}
    • Tutors
      • tutors
      • tutors/{id}
    • Transactions
      • Create
      • Delete
    • TeacherPayments
      • List teacher payments
      • Get a teacher payment by id
    • subscriptions
      GET
  • Schemas
    • Schemas
      • Generic key value parameters
      • Generic parameters array
      • CustomFieldValue
      • user
      • inline_response_200
      • parameters_1
      • parameters_2
      • parameters_3
      • inline_response_200_1
      • parameters_4
      • parameters_5
      • parameters_6
    • Aggregator
      • Lesson
      • Course timetable
      • Attendance
    • ErrorBadRequest
    • StudyPlan
    • TeacherPaymentLine
    • TeacherPayment
    • PaginationLinks
    • PaginationMeta
    • TeacherPaymentCollection
  1. Orders

orders/{id}

GET
/api/v3/orders/{id}
Last modified:2026-09-03 08:34:15

Request

Authorization
Basic Auth
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://prod.your-api-server.com/api/v3/orders/13600?include=payment.paymentDetails.item%2Cpayment.paymentDetails.course%2Cpayment.paymentDetails.user' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200
application/json
Bodyapplication/json

Example
{
    "data": {
        "id": 41803,
        "ordercode": "1786",
        "type": 0,
        "deleted": 0,
        "responsible": 81188,
        "companyid": 15,
        "customercompanyid": null,
        "supplierid": null,
        "resellerid": null,
        "branchid": null,
        "teachingyearid": null,
        "modelid": null,
        "installmentplanid": null,
        "contractattachmentsid": null,
        "containsdigitalsign": null,
        "nexiautopay": 0,
        "nexitoken": null,
        "orderdate": "2019-11-18",
        "createdat": null,
        "updatedat": "2021-11-02T17:19:01.000000Z",
        "payment": {
            "id": 82382,
            "orderid": 41803,
            "paymenttitle": "Ordine n.1111",
            "description": "",
            "paymentemission": "2019-11-18",
            "userid": 81188,
            "paymentcompany": null,
            "originalprice": 120,
            "applieddiscount": 0,
            "netamount": 120,
            "vat": 0,
            "amount": 120,
            "paymentadvance": null,
            "paymentdeposit": null,
            "paymentstatus": 0,
            "paymentdate": null,
            "missingamount": 120,
            "branchid": null,
            "invoiceid": null,
            "invoicenumber": null,
            "invoicedate": null,
            "createdat": null,
            "updatedat": null,
            "paymentdetails": [
                {
                    "id": 19121,
                    "paymentid": 82382,
                    "paymenttypeid": 16,
                    "classid": 1,
                    "itemid": 2,
                    "itemcode": null,
                    "hours": 0,
                    "originalprice": 120,
                    "netamount": 120,
                    "amount": 120,
                    "applieddiscount": null,
                    "discounttype": null,
                    "discountid": null,
                    "description": "Ordine di test",
                    "notes": null,
                    "lessonsperiod": null,
                    "examid": null,
                    "userid": 81188,
                    "immediatepay": 0,
                    "separatepayment": 0,
                    "singlerate": null,
                    "periods": null,
                    "invoicedperiods": null,
                    "singleprice": null,
                    "hasstorage": 0,
                    "vatrate": null,
                    "vat": null,
                    "vatrateid": null,
                    "packageitemid": null,
                    "ispackageoffer": 0,
                    "carnetid": null,
                    "classofferid": null,
                    "costcatalogueid": null,
                    "invoicerowid": null,
                    "invid": null,
                    "subscriptionstart": null,
                    "subscriptionend": null,
                    "lessonid": null,
                    "lessonspacketid": 0,
                    "bundleid": null,
                    "refusereasoncode": null,
                    "istransfer": null,
                    "createdat": null,
                    "updatedat": null,
                    "splitid": null,
                    "resellerpaid": null,
                    "customcommissions": 0,
                    "perccommissions": null,
                    "commissions": null,
                    "usermembershipid": null,
                    "classmodel": null,
                    "subjectTitle": "",
                    "teacher": "Docenti multipli",
                    "studyplanname": null,
                    "studyplansubjects": null,
                    "year": null,
                    "user": {
                        "id": 81188,
                        "username": null,
                        "email": "devs@blucloud.com",
                        "adminemail": null,
                        "ssoemail": null,
                        "name": "Devs",
                        "surname": "Blucloud",
                        "alias": null,
                        "fullName": "Blucloud Devs",
                        "taxcode": "BLUCLD79L28F924U",
                        "taxcodevalid": 0,
                        "vatnumber": "",
                        "vatcodevalid": 0,
                        "passport": null,
                        "role": "student",
                        "studentRollId": null,
                        "birthday": 0,
                        "gender": "male",
                        "address": "Via roma n. 12",
                        "cap": "00100",
                        "city": "Nola",
                        "province": "RM",
                        "mobileNo": "",
                        "phoneNo": "",
                        "isLeaderBoard": null,
                        "defLang": 0,
                        "appinvite": null,
                        "appconnected": 0,
                        "billingmethod": "none",
                        "adminteacher": null,
                        "admintype": 0,
                        "subscriptionyear": null,
                        "subscription": null,
                        "shownclassrooms": null,
                        "privacyok": null,
                        "CV": null,
                        "teacheronline": 1,
                        "datebirth": "1979-07-28",
                        "age": 47,
                        "pec": null,
                        "profession": null,
                        "maritalstatus": null,
                        "qualification": null,
                        "notes": null,
                        "webregistration": 0,
                        "pensioner": 0,
                        "netaccessid": null,
                        "tokenaccessid": null,
                        "roleid": 0,
                        "birthplace": "Roma",
                        "birthprovince": "RM",
                        "supportchat": 0,
                        "rate": null,
                        "classrate": null,
                        "lastversion": null,
                        "gcal": 0,
                        "lastnotify": null,
                        "disableupdate": 0,
                        "companyid": null,
                        "externid": 1143,
                        "haslocations": null,
                        "studlocation": -1,
                        "disabled": 0,
                        "country": "IT",
                        "invoicedataid": null,
                        "passportinvoice": 0,
                        "differentinvoicedata": null,
                        "color": null,
                        "hideincalendar": 0,
                        "locksession": null,
                        "teacherlessons": 0,
                        "customercompanyid": null,
                        "enableweb": 0,
                        "disablelogin": 0,
                        "lastwebaccess": null,
                        "leadstatus": null,
                        "assignedto": null,
                        "updatedat": "2026-08-06T15:25:41.000000Z",
                        "createdat": "2021-10-30T11:00:21.000000Z",
                        "iban": null,
                        "bic": null,
                        "codicedestinatario": null,
                        "branchid": null,
                        "branchadmin": 0,
                        "hasiol": 0,
                        "hasmoodle": null,
                        "sharecontacts": 0,
                        "priorityclass": null,
                        "systemnewsletter": null,
                        "limiteddidactic": 0,
                        "hidestudentpay": 0,
                        "nopersonalcalendar": 0,
                        "expectedvalue": null,
                        "expectedclose": null,
                        "citizenship": null,
                        "externuuid": null,
                        "virtualibanid": null,
                        "acquisition": null,
                        "birthcountry": null,
                        "gasecret": null,
                        "isexamstaff": 0,
                        "campdirector": 0
                    },
                    "course": {
                        "id": 1,
                        "classname": "Ordine di test",
                        "code": "1",
                        "classmodelid": null,
                        "subjectid": 0,
                        "classteacher": null,
                        "startdate": "2019-09-17",
                        "enddate": "2019-09-17",
                        "lastlesson": null,
                        "duration": 60,
                        "minstudents": 1,
                        "maxstudents": 10,
                        "weeklessons": null,
                        "weekfrequency": 1,
                        "closed": true,
                        "archived": false,
                        "canceled": true,
                        "suspended": false,
                        "allowsubscription": false,
                        "opensubscription": false,
                        "closedsubscription": false,
                        "selfbooking": false,
                        "exclusive": false,
                        "isonline": false,
                        "isvirtual": false,
                        "ishybrid": false,
                        "locationid": 377,
                        "tagid": 6,
                        "customercompanyid": null,
                        "classduration": 0,
                        "lessons": null,
                        "hours": null,
                        "allocated": null,
                        "location": {
                            "id": 377,
                            "location": "Via roma n. 12",
                            "address": "Via roma n. 12",
                            "locality": null,
                            "city": "Roma",
                            "province": "RM",
                            "region": null,
                            "state": null,
                            "isstorage": 0,
                            "description": null,
                            "contacts": "devs@blucloud.com",
                            "zoneid": null,
                            "cap": "00100",
                            "latitude": 41.902782,
                            "longitude": 12.496366,
                            "archived": 0,
                            "showorder": 1,
                            "default": 0,
                            "order": null,
                            "locationzonecode": "01",
                            "fiscalcompanyid": null,
                            "forstudyplans": 0,
                            "classeslocationid": null,
                            "external": 0,
                            "customercompanyid": null,
                            "proximitylevel": null,
                            "travelcostclassid": null,
                            "userid": null,
                            "branchid": null,
                            "headquarter": null,
                            "additionaladdress": null,
                            "typecode": null,
                            "overnightcost": null,
                            "color": null,
                            "updated_at": "2021-10-29 18:34:42",
                            "created_at": "2021-08-02 18:59:54",
                            "externalid": null
                        },
                        "subject": null
                    },
                    "item": {
                        "id": 2,
                        "name": "Ordine di test",
                        "code": null,
                        "description": "Ordine di test",
                        "price": 120,
                        "notinsell": 1,
                        "vatrateid": null,
                        "branchid": null,
                        "hasresellerprices": 1,
                        "categoryid": 1,
                        "subcategoryid": 1,
                        "enableshop": 0,
                        "cambridgeexampriceid": null,
                        "prepcenterenabled": 0,
                        "externalid": null,
                        "isstorage": 0,
                        "isdigital": null,
                        "productid": null,
                        "budgetitemid": null
                    }
                }
            ],
            "paymentinstallments": [
                {
                    "id": 8397,
                    "paymentid": 82382,
                    "seq": 1,
                    "paymentdetailid": null,
                    "detailseq": null,
                    "downpayment": 0,
                    "descriptionperiod": null,
                    "amount": 120,
                    "tobedefined": 0,
                    "expiry": "2019-11-18",
                    "remaining": null,
                    "paid": 0,
                    "autocharge": 0,
                    "nexierror": 0,
                    "canceled": 0,
                    "abandoned": 0,
                    "expaymethodid": null,
                    "paymentmethod": null,
                    "paymentdate": null,
                    "immediatepay": 0,
                    "invoiceTotal": null,
                    "invoiceid": null,
                    "invoiceinstallmentid": null,
                    "orderdownpayment": 0,
                    "accountid": null,
                    "sddexportid": null,
                    "hasteacherinvoicefile": null,
                    "hasconfirmationfile": null,
                    "cgnmovementid": null,
                    "resellerorderid": null
                }
            ]
        }
    }
}
Modified at 2026-09-03 08:34:15
Previous
orders
Next
Order creation
Built with