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

Order creation

Developing
POST
/api/v3/orders
Last modified:2026-09-16 10:29:59
Order and subscriptions creation

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
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 --globoff --request POST 'https://prod.your-api-server.com/api/v3/orders?campo=default&responsible=&date=&branchid=&assigntobranch=false&company=&contractmodelid=&details=&details[].type=&details[].id=&details[].pricing=&details[].student=&details[].subscription=&details[].pricing.amount=&details[].pricing.discount=0&details[].pricing.vat_rate=&details[].teaching_year_id=&details[].subscription_day=&details[].subscription_year=&details[].items=&details[].items[].id=&details[].items[].choosedsubject=&details[].items[].choosedclassid=&details[].items[].choosedpackid=&details[].items[].choosedteacherid=&details[].items[].choosedlocationid=&details[].items[].lesson=&details[].items[].subscription=&details[].items[].packetteacher_selection_id=&details[].items[].lesson.subject_id=&details[].items[].lesson.teacher_id=&details[].items[].lesson.location_id=&details[].items[].do_not_subscribe=&details[].items[].do_not_subscribe_reason=&details[].items[].enterdate=&details[].items[].leavedate=&installments=&installments[].seq=&installments[].amount=&installments[].expiry=&summary=&installments[].description=&installments[].detail_index=&summary.total_before_discount=&summary.discount=0&summary.total=&custom_fields=&custom_fields[].id=&custom_fields[].value=&custom_fields[].valueid=' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
    "data": {
        "id": 15478,
        "type": 0,
        "responsible": 17978,
        "companyid": 15,
        "customercompanyid": null,
        "supplierid": null,
        "resellerid": null,
        "branchid": null,
        "teachingyearid": 14,
        "modelid": null,
        "installmentplanid": null,
        "contractattachmentsid": null,
        "containsdigitalsign": null,
        "nexiautopay": 0,
        "nexitoken": null,
        "orderdate": "2026-02-06",
        "createdat": "2026-02-12T11:06:24.000000Z",
        "updatedat": "2026-02-12T11:06:25.000000Z",
        "payment": {
            "id": 17272,
            "paymentid": null,
            "paymenttypeid": null,
            "classid": null,
            "itemid": null,
            "itemcode": null,
            "hours": null,
            "originalprice": null,
            "netamount": null,
            "amount": null,
            "applieddiscount": null,
            "discounttype": null,
            "discountid": null,
            "description": null,
            "notes": null,
            "lessonsperiod": null,
            "examid": null,
            "userid": null,
            "immediatepay": null,
            "separatepayment": null,
            "singlerate": null,
            "periods": null,
            "invoicedperiods": null,
            "singleprice": null,
            "hasstorage": null,
            "vatrate": null,
            "vat": null,
            "vatrateid": null,
            "packageitemid": null,
            "ispackageoffer": null,
            "carnetid": null,
            "classofferid": null,
            "costcatalogueid": null,
            "invoicerowid": null,
            "invid": null,
            "subscriptionstart": null,
            "subscriptionend": null,
            "lessonid": null,
            "lessonspacketid": null,
            "bundleid": null,
            "refusereasoncode": null,
            "istransfer": null,
            "createdat": "2026-02-12T11:06:25.000000Z",
            "updatedat": "2026-02-12T11:06:25.000000Z",
            "splitid": null,
            "resellerpaid": null,
            "customcommissions": null,
            "perccommissions": null,
            "commissions": null,
            "paymentdetails": [
                {
                    "id": 22923,
                    "paymentid": 17272,
                    "paymenttypeid": 16,
                    "classid": 66065,
                    "itemid": null,
                    "itemcode": null,
                    "hours": 0,
                    "originalprice": 20,
                    "netamount": 16.39,
                    "amount": 20,
                    "applieddiscount": null,
                    "discounttype": null,
                    "discountid": null,
                    "description": "corso API",
                    "notes": null,
                    "lessonsperiod": null,
                    "examid": null,
                    "userid": 17979,
                    "immediatepay": 0,
                    "separatepayment": 0,
                    "singlerate": null,
                    "periods": null,
                    "invoicedperiods": null,
                    "singleprice": null,
                    "hasstorage": 0,
                    "vatrate": 22,
                    "vat": 3.61,
                    "vatrateid": 11,
                    "packageitemid": null,
                    "ispackageoffer": null,
                    "carnetid": null,
                    "classofferid": null,
                    "costcatalogueid": null,
                    "invoicerowid": null,
                    "invid": null,
                    "subscriptionstart": null,
                    "subscriptionend": null,
                    "lessonid": null,
                    "lessonspacketid": null,
                    "bundleid": null,
                    "refusereasoncode": null,
                    "istransfer": null,
                    "createdat": "2026-02-12T11:06:25.000000Z",
                    "updatedat": "2026-02-12T11:06:25.000000Z",
                    "splitid": null,
                    "resellerpaid": null,
                    "customcommissions": 0,
                    "perccommissions": null,
                    "commissions": null
                }
            ],
            "paymentinstallments": [
                {
                    "id": 32785,
                    "paymentid": 17272,
                    "seq": 1,
                    "paymentdetailid": null,
                    "detailseq": null,
                    "downpayment": 0,
                    "descriptionperiod": "Ciao",
                    "amount": 10,
                    "tobedefined": 0,
                    "expiry": "2026-02-20",
                    "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
                },
                {
                    "id": 32786,
                    "paymentid": 17272,
                    "seq": 2,
                    "paymentdetailid": null,
                    "detailseq": null,
                    "downpayment": 0,
                    "descriptionperiod": "Ci1efedsvfsao",
                    "amount": 10,
                    "tobedefined": 0,
                    "expiry": "2026-03-10",
                    "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
                }
            ]
        }
    },
    "success": true
}
Modified at 2026-09-16 10:29:59
Previous
orders/{id}
Next
packageoffers
Built with