Commerce

Get Orders

GET /dashboard/orders

Query Parameters

Name	Type	Description
include	String	options: shippings, items can be both
q	String	Search
start_date	Date	Format (YYYY-MM-DD)
end_date	Date	Format (YYYY-MM-DD)
per_page	Integer	Show limit per page
page	Integer	Change Page
status	String	Options: pending, paid, completed, expired

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": [
        {
            "id": "2f596686-270d-4cd4-8fd4-e048e9736b7d",
            "name": "Khalid",
            "email": "[email protected]",
            "phone": "6281944835558",
            "address": "Khayangan Residence F1-28",
            "country": "ID",
            "state": "Jawa Timur",
            "district": "Bangkalan",
            "subdistrict": "Burneh",
            "postcode": "69118",
            "shipping_courier": "jne:OKE",
            "subtotal": "100000.00",
            "discount": "0.00",
            "shipping_cost": "11000.00",
            "tax": "0.00",
            "transaction_fee": "7500.00",
            "is_transaction_fee_covered": 0,
            "total": "118500.00",
            "status": "expired",
            "link_payment": "https://checkout-staging.xendit.co/v2/656e818e00467dfd8a88431c",
            "expired_at": "2023-12-05 08:51:03",
            "created_at": "2023-12-05T01:48:58.000000Z",
            "updated_at": "2023-12-05T09:44:20.000000Z"
        },
        {
            "id": "1dd9ac4a-27a2-4ea4-81e4-15f6f822ff46",
            "name": "Andy Eka Saputra",
            "email": "[email protected]",
            "phone": "6281944835558",
            "address": "Khayangan Residence F1-28",
            "country": "ID",
            "state": "Jawa Timur",
            "district": "Bangkalan",
            "subdistrict": "Burneh",
            "postcode": "69118",
            "shipping_courier": "jne:OKE",
            "subtotal": "100000.00",
            "discount": "0.00",
            "shipping_cost": "11000.00",
            "tax": "0.00",
            "transaction_fee": "7500.00",
            "is_transaction_fee_covered": 0,
            "total": "118500.00",
            "status": "paid",
            "link_payment": "https://checkout-staging.xendit.co/v2/656e8d083051603772bf3ccc",
            "expired_at": "2023-12-05 09:40:01",
            "created_at": "2023-12-05T02:37:54.000000Z",
            "updated_at": "2023-12-05T02:54:52.000000Z"
        },
        {
            "id": "c1dc61ac-2a72-4455-bbdf-7df93c197021",
            "name": "Andy Eka Saputra",
            "email": "[email protected]",
            "phone": "6281944835558",
            "address": "Khayangan Residence F1-28",
            "country": "ID",
            "state": "Jawa Timur",
            "district": "Bangkalan",
            "subdistrict": "Burneh",
            "postcode": "69118",
            "shipping_courier": "jne:OKE",
            "subtotal": "100000.00",
            "discount": "0.00",
            "shipping_cost": "11000.00",
            "tax": "0.00",
            "transaction_fee": "7500.00",
            "is_transaction_fee_covered": 0,
            "total": "118500.00",
            "status": "expired",
            "link_payment": "https://checkout-staging.xendit.co/v2/656e8f71305160025abf3ffd",
            "expired_at": "2023-12-05 09:50:18",
            "created_at": "2023-12-05T02:48:11.000000Z",
            "updated_at": "2023-12-05T02:51:03.000000Z"
        },
        {
            "id": "823c4f5d-9014-4e6f-a401-7a53675d4e14",
            "name": "Andy Eka Saputra",
            "email": "[email protected]",
            "phone": "6281944835558",
            "address": "Khayangan Residence F1-28",
            "country": "ID",
            "state": "Jawa Timur",
            "district": "Bangkalan",
            "subdistrict": "Burneh",
            "postcode": "69118",
            "shipping_courier": "jne:OKE",
            "subtotal": "100000.00",
            "discount": "0.00",
            "shipping_cost": "11000.00",
            "tax": "0.00",
            "transaction_fee": "7500.00",
            "is_transaction_fee_covered": 0,
            "total": "118500.00",
            "status": "expired",
            "link_payment": "https://checkout-staging.xendit.co/v2/656e8fe229854dc24ec4a43b",
            "expired_at": "2023-12-05 09:52:10",
            "created_at": "2023-12-05T02:50:07.000000Z",
            "updated_at": "2023-12-05T02:53:03.000000Z"
        },
        {
            "id": "658488cd-3105-4754-983d-be3d2c4e0357",
            "name": "Khalid",
            "email": "[email protected]",
            "phone": "6281944835558",
            "address": "Khayangan Residence F1-28",
            "country": "ID",
            "state": "Jawa Timur",
            "district": "Bangkalan",
            "subdistrict": "Burneh",
            "postcode": "69118",
            "shipping_courier": "jne:OKE",
            "subtotal": "100000.00",
            "discount": "0.00",
            "shipping_cost": "11000.00",
            "tax": "0.00",
            "transaction_fee": "7500.00",
            "is_transaction_fee_covered": 0,
            "total": "118500.00",
            "status": "completed",
            "link_payment": "https://checkout-staging.xendit.co/v2/656e91e9771fa528f1e2b9c3",
            "expired_at": "2023-12-05 10:00:50",
            "created_at": "2023-12-05T02:58:44.000000Z",
            "updated_at": "2023-12-05T16:25:43.000000Z"
        }
    ],
    "meta": {
        "pagination": {
            "total": 5,
            "count": 5,
            "per_page": 12,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Get Order Detail

GET /dashboard/orders/{uuid}

Path Parameters

Name	Type	Description
uuid*	Integer	id of the order

Query Parameters

Name	Type	Description
include	String	options: shippings, items can be both

Headers

Name	Type	Description
Client-Key*	String	Your client key

200: OK

{
    "data": {
        "id": "2f596686-270d-4cd4-8fd4-e048e9736b7d",
        "name": "Andy Eka Saputra",
        "email": "[email protected]",
        "phone": "6281944835558",
        "address": "Khayangan Residence F1-28",
        "country": "ID",
        "state": "Jawa Timur",
        "district": "Bangkalan",
        "subdistrict": "Burneh",
        "postcode": "69118",
        "shipping_courier": "jne:OKE",
        "subtotal": "100000.00",
        "discount": "0.00",
        "shipping_cost": "11000.00",
        "tax": "0.00",
        "transaction_fee": "7500.00",
        "is_transaction_fee_covered": 0,
        "total": "118500.00",
        "status": "pending",
        "link_payment": "https://checkout-staging.xendit.co/v2/656e818e00467dfd8a88431c",
        "expired_at": "2023-12-05 08:51:03",
        "created_at": "2023-12-05T01:48:58.000000Z",
        "updated_at": "2023-12-05T01:49:03.000000Z",
        "shippings": {
            "data": [
                {
                    "id": "b6e135f5-f9b4-474b-86b2-b583933a0bad",
                    "origin": "Mulyorejo, Surabaya, Jawa Timur",
                    "destination": "Burneh, Bangkalan, Jawa Timur",
                    "weight": 1000,
                    "length": 0,
                    "width": 0,
                    "height": 0,
                    "price": "11000.00",
                    "discount": "0.00",
                    "total": "11000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:59.000000Z"
                }
            ]
        },
        "items": {
            "data": [
                {
                    "id": "378e32dc-ab42-4352-9949-0432151c2801",
                    "product_name": "baju suci",
                    "weight": "500.00",
                    "length": "0.00",
                    "width": "0.00",
                    "height": "0.00",
                    "price": "10000.00",
                    "discount": "0.00",
                    "quantity": 1,
                    "total": "10000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:58.000000Z"
                },
                {
                    "id": "5c0867b6-1e43-4e78-9e93-777eff69d05e",
                    "product_name": "baju hitam sangar",
                    "weight": "500.00",
                    "length": "0.00",
                    "width": "0.00",
                    "height": "0.00",
                    "price": "90000.00",
                    "discount": "0.00",
                    "quantity": 1,
                    "total": "90000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:58.000000Z"
                }
            ]
        }
    }
}

Update Order Status

PUT /dashboard/orders/status/{uuid}

Path Parameters

Name	Type	Description
uuid*	Integer	id of the order

Headers

Name	Type	Description
Client-Key*	String	Your client key

Request Body

Name	Type	Description
status	String	Options: pending, expired, paid, completed

200: OK

{
    "data": {
        "id": "2f596686-270d-4cd4-8fd4-e048e9736b7d",
        "name": "Andy Eka Saputra",
        "email": "[email protected]",
        "phone": "6281944835558",
        "address": "Khayangan Residence F1-28",
        "country": "ID",
        "state": "Jawa Timur",
        "district": "Bangkalan",
        "subdistrict": "Burneh",
        "postcode": "69118",
        "shipping_courier": "jne:OKE",
        "subtotal": "100000.00",
        "discount": "0.00",
        "shipping_cost": "11000.00",
        "tax": "0.00",
        "transaction_fee": "7500.00",
        "is_transaction_fee_covered": 0,
        "total": "118500.00",
        "status": "pending",
        "link_payment": "https://checkout-staging.xendit.co/v2/656e818e00467dfd8a88431c",
        "expired_at": "2023-12-05 08:51:03",
        "created_at": "2023-12-05T01:48:58.000000Z",
        "updated_at": "2023-12-05T01:49:03.000000Z",
        "shippings": {
            "data": [
                {
                    "id": "b6e135f5-f9b4-474b-86b2-b583933a0bad",
                    "origin": "Mulyorejo, Surabaya, Jawa Timur",
                    "destination": "Burneh, Bangkalan, Jawa Timur",
                    "weight": 1000,
                    "length": 0,
                    "width": 0,
                    "height": 0,
                    "price": "11000.00",
                    "discount": "0.00",
                    "total": "11000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:59.000000Z"
                }
            ]
        },
        "items": {
            "data": [
                {
                    "id": "378e32dc-ab42-4352-9949-0432151c2801",
                    "product_name": "baju suci",
                    "weight": "500.00",
                    "length": "0.00",
                    "width": "0.00",
                    "height": "0.00",
                    "price": "10000.00",
                    "discount": "0.00",
                    "quantity": 1,
                    "total": "10000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:58.000000Z"
                },
                {
                    "id": "5c0867b6-1e43-4e78-9e93-777eff69d05e",
                    "product_name": "baju hitam sangar",
                    "weight": "500.00",
                    "length": "0.00",
                    "width": "0.00",
                    "height": "0.00",
                    "price": "90000.00",
                    "discount": "0.00",
                    "quantity": 1,
                    "total": "90000.00",
                    "created_at": "2023-12-05T01:48:58.000000Z",
                    "updated_at": "2023-12-05T01:48:58.000000Z"
                }
            ]
        }
    }
}