Integrate API
Home
Company
Company
  • Company
  • Users
  • Office
Orders
Orders
  • Orders
  • Change Request
  • Drafts
  • GoToScan
Webhooks
Home
Company
Company
  • Company
  • Users
  • Office
Orders
Orders
  • Orders
  • Change Request
  • Drafts
  • GoToScan
Webhooks
  1. Drafts
  • Create a draft order
    POST
  • Update a draft order
    PATCH
  • Delete a draft order
    DELETE
  1. Drafts

Create a draft order

Prod Env
https://app.cubi.casa/api/integrate/v3
Prod Env
https://app.cubi.casa/api/integrate/v3
POST
/orders/draft
Add a draft order for a user. The latitude and longitude (floats) will be used for fetching the nearest orders in the mobile app.
Required parameters: street, city,country,owner_email
Parameter package_type
One of possible values ["base", "plus", "plus_3d"]
If this field is omitted, order will follow the default setup on company order page
Package TypeExplanation
baseLITE or STANDARD order package depend on your account conditions.
plusPLUS order package with fixed furniture floorplan.
plus_3dPLUS 3D order package with 3D floorplan.
Parameter add_ons
The list of values ["gla", "express_sla", "3d_video", "3d_cad_files"]
leave it empty list [] if you don't want to add any add_ons.
If this field is omitted, order will follow the default setup on company order page
Add OnsExplanation
glaSet turnaround 6h to the floorplan delivery.
express_slaPLUS order package with fixed furniture floorplan.
3d_videoAdd 3D walkthrough video showcasing for floorplan. plus_3d package required
3d_cad_filesAdd CAD package included both 2D and 3D files. plus package required

Request

Authorization
Add parameter in header
api-key
Example:
api-key: ********************
Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Successful response
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.cubi.casa/api/integrate/v3/orders/draft' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "street": "615 Bourbon St",
    "suite": "A1",
    "city": "New Orleans",
    "state": "Louisiana",
    "country": "United States",
    "postalCode": "70130",
    "info": "Extra info",
    "latitude": 29.958365,
    "longitude": -90.066198,
    "external_id": "R4ER93",
    "owner_email": "henrique+apitest@cubicasa.com",
    "package_type": "plus",
    "add_ons": [
        "gla"
    ]
}'
Response Response Example
{
    "id": "312babc6-e742-4d54-ac49-e0f7b16ec15a",
    "info": {
        "status": "Draft",
        "created_by": "manager@cubicasa.com",
        "location": "121 North Washington Avenue Cubi suite Minneapolis",
        "order_type": "vbim",
        "first_delivered_at": null,
        "created_at": 1716238626.904049,
        "is_scan_order": true,
        "total_scanned_area": 0,
        "go2scan": null,
        "external_id": "EXT10005",
        "add_info": "",
        "style_template": null,
        "model_id": null,
        "product": {
            "add_ons": [
                "gla"
            ],
            "over_limits": [],
            "package_type": "base",
            "purchasable_add_ons": [
                "express_sla"
            ],
            "purchasable_package_types": [
                "plus"
            ]
        }
    },
    "address": {
        "city": "Minneapolis",
        "country": "United States",
        "full_address": "121 North Washington Avenue, Minneapolis, Minnesota 55411, United States",
        "latitude": 44.986947,
        "longitude": -93.275918,
        "number": "",
        "postalCode": "55411",
        "state": "Minnesota",
        "street": "121 North Washington Avenue",
        "suite": "Cubi suite"
    },
    "delivery_assets": {
        "gla_package": null,
        "listing_floorplans": {
            "jpg_urls": [],
            "png_urls": [],
            "svg_urls": [],
            "jpg_urls_dim": [],
            "png_urls_dim": [],
            "svg_urls_dim": [],
            "zip_urls": [],
            "zip_urls_dim": [],
            "pdf_urls": [],
            "pdf_urls_dim": []
        },
        "home_report": {
            "pdf_urls": null
        },
        "floorplans_3d": null,
        "video_3d": null,
        "cad_files": null,
        "property_data": {
            "json_urls": null
        },
        "snapshot": {
            "image_urls": null,
            "pdf_urls": null
        },
        "tour": null
    }
}
Modified at 2025-09-11 21:35:54
Next
Update a draft order
Built with