Orderla.my API

This is the documentation to update your order via API.

The credential can be optained at https://orderla.my/admin/manage-api. (Require PRO plan)

Get Order Info:

// Some code
HEADERS: {
    X-User-Email: '',
    X-User-Token: ''
}

GET: https://orderla.my/api/app/user/order/<order_code_id>

Update Order Status:

POST:

HEADERS: {
    X-User-Email: '',
    X-User-Token: ''
}

POST: https://orderla.my/api/app/user/order/<order_code_id>/updateOrderStatus

PARAMS: new_order_status: 

Can only use: < new, pending, confirmed, ongoing, dispatched, completed, cancelled >

Update Order Fulfillment Status:

HEADERS: {
    X-User-Email: '',
    X-User-Token: ''
}

POST: https://orderla.my/api/app/user/order/<order_code_id>/updatePaymentStatus

PARAMS: { newPaymentStatus: 'paid', 'not_paid' };

Can only use: < not_paid, paid >

Update Order Delivery Message:

HEADERS: {
    X-User-Email: '',
    X-User-Token: ''
}

POST: https://orderla.my/api/app/user/order/<order_code_id>/updateDeliveryMessage

PARAMS: { delivery_update_msg: 'abc' };

Get Orders

Request:

HEADERS: {
    X-User-Email: '',
    X-User-Token: ''
}

GET: https://orderla.my/api/app/user/orders

* Alternatively can use with URL params like:
- form_id
- start_date (YYYY-MM-DD)
- end_date (YYYY-MM-DD)

Example : 
GET: https://orderla.my/api/app/user/orders?form_id=4141&start_date=2020-01-01&end_date=2021-11-01

Response:

{
    "form_id": "4141",
    "count": 1,
    "msg": "orders",
    "orders": [
        {
            "form_id": 4141,
            "subtotal": 0,
            "delivery_fee": 8.1,
            "tax_percent": null,
            "tax": null,
            "rounding_adjustment": null,
            "discount": null,
            "total": 8.1,
            "code_id": "5fb29498e3c61",
            "paid_with": null,
            "payment_status": "paid",
            "status": "completed",
            "name": "Am",
            "email": "[email protected]",
            "phone_no": "0123123",
            "unit_no": "No 111",
            "address": "Jalan ABC",
            "postcode": "55000",
            "notes": null,
            "user_id": 10,
            "to_user_sale_person_id": null,
            "has_deducted_inventory": null,
            "weight": 1,
            "updated_at": "2020-11-20T22:42:34.000000Z",
            "created_at": "2020-11-16T23:02:48.000000Z",       
            "invoice_no": null,
            "seller_notes": null,
            "country_code": "6",
            "by_merchant_id": null,
            "payment_method": null,
            "form_title": "Orderla (Direct Payment)",
            "order_list": [
                {
                    "id": "3a8e8a09-24ba-4cd1-9458-95a3aeb74f3b",
                    "sku": "",
                    "name": "aaa",
                    "image": {},
                    "price": 0,
                    "stock": 8,
                    "weight": "1",
                    "quantity": 1,
                    "variants": [],
                    "is_hidden": false,
                    "product_id": "3a8e8a09-24ba-4cd1-9458-95a3aeb74f3b",
                    "description": "",
                    "has_variant": false,
                    "max_quantity": 1,
                    "variant_options": [],
                    "is_manage_inventory": false
                }
            ],
            "additional_charges": {
                "delivery_type": {
                    "name": "SendParcel",
                    "type": "dynamic",
                    "price": 8.1
                }
            }
        }
    ]
}

Last updated

Was this helpful?