Retrieve Order

Learn how to retrieve a single order by making an API request with the order ID included in the URL. With proper access permissions, you'll receive a successful response containing essential order information, including ID, customer details, order items.

Method: GET URL: /api/v1/orders/{id}/

Example responses

200 — Successful response
{
    "id": 1593781720493279,
    "order_items": [
        {
            "id": 1593781720493299,
            "product_id": 1584723961091234,
            "licenses": [
                {
                    "id": 1593781720493289,
                    "customer": {
                        "id": 620,
                        "total_orders": 14,
                        "total_licenses": 45,
                        "labels": [
                            {
                                "id": 3,
                                "label_id": 8,
                                "label": "Customer",
                                "color": "#ff9f43"
                            },
                            {
                                "id": 53,
                                "label_id": 34,
                                "label": "Loyal",
                                "color": "#3a0cd4"
                            }
                        ],
                        "email": "[email protected]",
                        "first_name": "",
                        "last_name": "",
                        "company_name": "",
                        "phone": "",
                        "reference": "",
                        "address": "",
                        "postcode": "",
                        "city": "",
                        "country": "",
                        "state": "",
                        "clabels_all": "customerloyal",
                        "cognito_user_pool_id": "",
                        "metadata": {},
                        "company": 277,
                        "license_user": null,
                        "clabels": [
                            8,
                            34
                        ]
                    },
                    "product_features": [
                        {
                            "id": 1605023917125630,
                            "product_feature": {
                                "id": 189,
                                "created_at": "2020-11-13T07:40:53Z",
                                "updated_at": "2020-11-13T07:40:53Z",
                                "name": "Feature 5",
                                "code": "f5",
                                "is_deleted": false,
                                "feature_type": "activation",
                                "max_consumption": 0,
                                "allow_overages": false,
                                "max_overages": 0,
                                "reset_consumption": false,
                                "consumption_period": null,
                                "metadata": {}
                            },
                            "max_consumption": 0,
                            "total_consumptions": 0,
                            "expiry_date": null,
                            "allow_overages": false,
                            "max_overages": 99,
                            "reset_consumption": false,
                            "consumption_period": null,
                            "metadata": {}
                        },
                        {
                            "id": 1605023917125631,
                            "product_feature": {
                                "id": 172,
                                "created_at": "2020-08-26T05:37:14Z",
                                "updated_at": "2020-08-26T05:37:14Z",
                                "name": "Feature 2",
                                "code": "f2",
                                "is_deleted": false,
                                "feature_type": "consumption",
                                "max_consumption": 20,
                                "allow_overages": false,
                                "max_overages": 0,
                                "reset_consumption": false,
                                "consumption_period": null,
                                "metadata": {}
                            },
                            "max_consumption": 5,
                            "total_consumptions": 0,
                            "expiry_date": null,
                            "allow_overages": false,
                            "max_overages": 99,
                            "reset_consumption": false,
                            "consumption_period": null,
                            "metadata": {}
                        }
                    ],
                    "product_custom_fields": [],
                    "license_user": {
                        "id": 1240,
                        "last_login": null,
                        "email": "[email protected]|uss1",
                        "true_email": "[email protected]",
                        "created_at": "2020-08-12T08:52:32Z",
                        "updated_at": "2020-08-12T09:01:24Z",
                        "is_admin": {},
                        "is_active": true,
                        "is_staff": false,
                        "first_name": "John",
                        "last_name": "Doe",
                        "phone_number": "00385913109161",
                        "subscribed_to_email": false,
                        "acquired_consent": null,
                        "is_manager": false,
                        "initial_password": "4q3dg7!_",
                        "is_initial_password": true
                    },
                    "license_users": [
                        {
                            "id": 1240,
                            "last_login": null,
                            "email": "[email protected]|uss1",
                            "true_email": "[email protected]",
                            "created_at": "2020-08-12T08:52:32Z",
                            "updated_at": "2020-08-12T09:01:24Z",
                            "is_admin": {},
                            "is_active": true,
                            "is_staff": false,
                            "first_name": "John",
                            "last_name": "Doe",
                            "phone_number": "00385913109161",
                            "subscribed_to_email": false,
                            "acquired_consent": null,
                            "is_manager": false,
                            "initial_password": "4q3dg7!_",
                            "is_initial_password": true
                        }
                    ],
                    "order_store_id": "d2d2dce02c844d4492c9d48758aa143a",
                    "active_up_to_date_devices": 0,
                    "product": {
                        "id": 1584723961091234,
                        "short_code": "code1",
                        "product_name": "mch"
                    },
                    "created_at": "2020-07-03T13:08:40Z",
                    "updated_at": "2020-11-13T07:42:58Z",
                    "license_key": null,
                    "active": false,
                    "enabled": true,
                    "time_activated": "2020-10-10T14:42:16Z",
                    "time_disabled": "2020-08-14T07:26:27Z",
                    "max_activations": 5,
                    "times_activated": 0,
                    "valid_duration": null,
                    "validity_period": "2020-09-30",
                    "license_type": "perpetual",
                    "enable_maintenance_period": true,
                    "maintenance_duration": "3m",
                    "maintenance_period": "2021-01-10",
                    "is_trial": true,
                    "max_consumptions": 0,
                    "total_consumptions": 0,
                    "subscription_id": null,
                    "last_check": null,
                    "prevent_vm": true,
                    "allow_overages": false,
                    "max_overages": 0,
                    "reset_consumption": false,
                    "consumption_period": null,
                    "trial_days": 0,
                    "is_floating": false,
                    "is_floating_cloud": true,
                    "floating_users": 1,
                    "note": null,
                    "max_license_users": 0,
                    "transfer_count": 0,
                    "floating_timeout": null,
                    "max_transfers": 0,
                    "is_air_gapped": false,
                    "can_borrow": false,
                    "max_borrow_time": 0,
                    "is_bundle": false,
                    "metadata": {},
                    "order": 1593781720493279,
                    "order_item": 1593781720493299,
                    "disabled_user": null,
                    "last_activation_device": null,
                    "status": "Inactive"
                }
            ],
            "created_at": null,
            "updated_at": null,
            "order": 1593781720493279,
            "product": 1584723961091234
        }
    ],
    "customer": {
        "id": 620,
        "total_orders": 14,
        "total_licenses": 45,
        "labels": [
            {
                "id": 3,
                "label_id": 8,
                "label": "Customer",
                "color": "#ff9f43"
            },
            {
                "id": 53,
                "label_id": 34,
                "label": "Loyal",
                "color": "#3a0cd4"
            }
        ],
        "customer_account": null,
        "email": "[email protected]",
        "first_name": "",
        "last_name": "",
        "company_name": "",
        "phone": "",
        "reference": "",
        "address": "",
        "postcode": "",
        "city": "",
        "country": "",
        "state": "",
        "clabels_all": "customerloyal",
        "cognito_user_pool_id": "",
        "metadata": {},
        "company": 277,
        "license_user": null,
        "clabels": [
            8,
            34
        ]
    },
    "has_active_licenses": false,
    "created_at": "2020-07-03T13:08:40Z",
    "updated_at": "2020-07-03T13:08:40Z",
    "store_id": "d2d2dce02c844d4492c9d48758aa143a",
    "type": "normal",
    "customer_email": null,
    "is_test": false,
    "customer_reference": null,
    "is_trial": false,
    "download_id": null,
    "language": null,
    "campaign_params": null,
    "customer_first_name": null,
    "customer_last_name": null,
    "customer_company": null,
    "customer_phone": null,
    "metadata": {},
    "company": 277
}

Last updated

Was this helpful?