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. Orders
  • Default module
    • Get started
    • Pagination and Offset
    • Company
      • Get company information
      • Delete company webhook
      • Get company package
      • Send a merge request to another company
    • Office
      • List all offices
      • Add new office
    • Users
      • List all users
      • Add new user
      • Get user by email
      • Update user details
      • Change user password
      • Send password reset link
      • Delete user
    • Orders
      • List orders
        GET
      • Upgrade order
        POST
      • Re-deliver order with styling options
        POST
      • Get order by ID
        GET
      • Get combined PDF document
        GET
      • Create a redraw order
        POST
    • Change Request
      • Add new change request for an order
      • List all change requests of order
      • Get change request by ID
    • Draft Orders
      • Create a draft order
      • Update a draft order
      • Delete a draft order
    • GoToScan Orders
      • Create a GoToScan order
    • Webhooks
      • About webhooks
      • Update company webhooks
      • /Order status
  • Webhooks calls
    • /Order status
  1. Orders

Get order by ID

Prod Env
https://app.cubi.casa/api/integrate/v3
Prod Env
https://app.cubi.casa/api/integrate/v3
GET
/orders/{id}
Get order details with order ID
Check delivery_assets to get download link for floorplan assets
Order productObject field nameFile type
2D Floorplanlisting_floorplanspng, jpg, svg, pdf
GLA (Add On)gla_packagepdf, json
Home Report (Available from PLUS)homereportpdf
Snapshot Report (Available from PLUS)snapshotpdf
3D Floorplan (Available from PLUS 3D )floorplans_3djpg
3D Video (Add On)video_3dmp4
CAD File (Add On)cad_fileszip
Property Data (Available for specific accounts)property_datajson
Cubicasa Tourtourweb link
For purchasable options of Post-purchase order check values of: info.product.purchasable_add_ons and info.product.purchasable_package_types

Request

Authorization
or
API Key
Add parameter in header
api-key
Example:
api-key: ********************
or
Path Params

Responses

🟢200OK
application/json
Successful response
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://app.cubi.casa/api/integrate/v3/orders/'
Response Response Example
{
    "id": "312babc6-e742-4d54-ac49-e0f7b16ec15a",
    "info": {
        "status": "Ready",
        "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": "1487d389-f3f9-44f3-9a36-a0c581df0c06",
        "product": {
            "add_ons": [
                "gla"
            ],
            "over_limits": [],
            "package_type": "plus",
            "purchasable_add_ons": [
                "3d_cad_files"
            ],
            "purchasable_package_types": [
                "plus_3d",
                "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": {
        "listing_floorplans": {
            "jpg_urls": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/83351e8e5a3310d49bdc1d0f3f80ab8a/0_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.jpg"
            ],
            "png_urls": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/83351e8e5a3310d49bdc1d0f3f80ab8a/4_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.png"
            ],
            "svg_urls": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/83351e8e5a3310d49bdc1d0f3f80ab8a/2_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.svg"
            ],
            "jpg_urls_dim": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/7e84d189a12b0c5159d976ed6f85cdfe/0_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.jpg"
            ],
            "png_urls_dim": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/7e84d189a12b0c5159d976ed6f85cdfe/4_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.png"
            ],
            "svg_urls_dim": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/7e84d189a12b0c5159d976ed6f85cdfe/2_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.svg"
            ],
            "zip_urls": [],
            "zip_urls_dim": [],
            "pdf_urls": [],
            "pdf_urls_dim": []
        },
        "floorplans_3d": {
            "jpg_urls": [
                "https://download.cubi.casa/sample_bundle/floorplan.jpg"
            ]
        },
        "video_3d": {
            "video_urls": [
                "https://download.cubi.casa/sample_bundle/video.mp4"
            ]
        },
        "cad_files": {
            "zip_urls": [
                "https://download.cubi.casa/sample_bundle/cad_files.zip"
            ]
        },
        "gla_package": {
            "image_urls": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/11c914bd5b7c4c61851f5181d86c8978/0_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08_0.png"
            ],
            "report_urls": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/11c914bd5b7c4c61851f5181d86c8978/0_4-not-free-aurinkotuulenkatu-cctest-plus_3d---2024-05-08-helsinki-uusimaa-finland-cctest-plus_3d---2024-05-08.pdf"
            ],
            "gla_formula_text": "GLA total: 10 m², excluded areas: 0 m²\n\nFLOOR 1: 10 m²\n-((728.5 + 728.5) * (380.4 - 623.3) + (728.5 + 300) * (623.3 - 623.3) + (300 + 300) * (623.3 - 380.4) + (300 + 728.5) * (380.4 - 380.4)) * 0.5 * 0.0001\n"
        },
        "home_report": {
            "pdf_urls": [
                "https://download.cubi.casa/assets/4f3730de-c412-4ab3-b555-a4a71e497e6f/home_report/HomeReport-1716241586.pdf"
            ]
        },
        "snapshot": {
            "pdf_urls": [
                "https://s3-us-west-2.amazonaws.com/cubi.casa.exporter.output/d7662413fee709e540dc6902eaa2aa5c/0_10-savikkakuja-vantaa-uusimaa-finland-01300_snapshot_report.pdf"
            ],
            "image_urls": []
        },
        "property_data": {
            "json_urls": []
        },
        "tour": {
            "link": "https://visithome.ai/example-tour",
            "mls_compliance_link": "https://unbranded.visithome.ai/example-tour"
        }
    }
}
Modified at 2025-08-11 11:34:35
Previous
Re-deliver order with styling options
Next
Get combined PDF document
Built with