Order Details

View detailed information for an order

HTTP Request

Get information by order code
GET /api/v3/orders/ORDER_CODE
Where ORDER_CODE is the order code on the Getfly system (order_code)

Get information by order ID
GET /api/v3/orders/detail?order_id=ID
Where ID is the order ID on the Getfly system (order_id)

Query Parameters

Parameter	Default	Description
custom_field_list	null	The custom field definitions to retrieve

The custom_field_list condition will pass the codes of the custom fields, separated by commas.

Example: custom_field_list = "numeric_input,transporter"

Response

The returned data includes:

• order_info: contains detailed information about the order
• products: an array containing product information
• payments: contains payment information
• terms: an array of order terms

{
    "order_info": {
        "order_id": 18293,
        "order_code": "DH18293",
        "order_date": "03/01/2024",
        "order_type": 2,
        "order_status": 1,
        "amount": 900000,
        "discount": 0,
        "discount_amount": 0,
        "created_at": "03/01/2024",
        "installation": 0,
        "installation_amount": 0,
        "transport": 0,
        "transport_amount": 0,
        "lading_status": "ASSIGNING",
        "store_id": 0,
        "account_id": 25,
        "account_name": "Nguyen Thi Thanh Thuy",
        "account_code": "KH1905",
        "account_phone": "0984161616",
        "account_email": null,
        "assigned_name": "Nguyen Trung Hieu",
        "assigned_user_email": "[email protected]",
        "is_repay": "0",
        "account_created_at": "2019-08-09 18:08:09",
        "account_address": "Delivery address",
        "payment_status": "unpaid",
        "lading_code": "24DWX2OF",
        "lading_info": {
            "status": {
                "code": "ASSIGNING",
                "name": "Finding a supplier"
            },
            "tracking_url": "http://app.ahamove.com/record/24DWX2OF"
        },
        "numeric_input": ""
    },
    "products": [
        {
            "product_id": 555,
            "product_code": "FV-27CH9",
            "product_name": " Panasonic ceiling mounted exhaust fan FV-27CH9",
            "quantity": 1,
            "price": 500000,
            "discount_amount": 50000,
            "discount": 10,
            "vat": 0,
            "vat_amount": 0,
            "amount": 450000,
            "description": "",
            "unit_name": "Piece"
        },
        {
            "product_id": 555,
            "product_code": "FV-27CH9",
            "product_name": " Panasonic ceiling mounted exhaust fan FV-27CH9",
            "quantity": 1,
            "price": 500000,
            "discount_amount": 50000,
            "discount": 10,
            "vat": 0,
            "vat_amount": 0,
            "amount": 450000,
            "description": "",
            "unit_name": "Piece"
        }
    ],
    "payments": [],
    "terms": [
        "Delivery time:",
        "Delivery address:"
    ]
}