Orders Details - Salla Merchant API

This endpoint allows you to return the details for a specific order by passing the order_id as a path parameter.

Note

• You can able to send the reference_id as a query parameter to get order details. Check the List Orders Endpoint for more.
• If you send the query parameter format and set it equal to light, you will receive the order details without Shipments, Items, Pickup Branch, and Customer Groups objects.
• For old apps (expanded query parameter), the shipping_details_id inside the shipping object response matches the id returned by the shipping estimated rate endpoint.

Scopes

orders.read - Orders Read Only

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Default Response

application/json

Body

Examples

SuccessExample | Full Details - DeprecatedExample

{
    "status": 200,
    "success": true,
    "data": {
        "id": 418149270,
        "checkout_id": 1464750392,
        "reference_id": 3879219,
        "features": {
            "shippable": true,
            "digitalable": false,
            "multiple_shipments_supported": false,
            "order_type_price_quote": false,
            "has_suspicious_alert": false
        },
        "actions": {
            "cancellable": false,
            "reorderable": true,
            "payable": true
        },
        "urls": {
            "customer": "http://store.test/ar/hemo.store/order/wRK4mBzAZN081YbbX3dal23kYrbxqP7j",
            "admin": "/orders/order/wRK4mBzAZN081YbbX3dal23kYrbxqP7j",
            "digital_content": "https://salla.sa/dev-k9dn7fok0vih4p70/orders/digital/lm6bowYMnmA9eyWdLkJza153vyZnMb85QO0GZ7NxDlVKXB4grqR82jEN",
            "rating": "https://store-test.com/rating-link",
            "checkout": "https://store-test.com/checkout-link"
        },
        "date": {
            "date": "2024-02-15 08:23:05.000000",
            "timezone_type": 3,
            "timezone": "Asia/Riyadh"
        },
        "updated_at": {
            "date": "2024-02-15 11:23:05.000000",
            "timezone_type": 3,
            "timezone": "Asia/Riyadh"
        },
        "source": "store",
        "source_details": {
            "type": "direct",
            "value": null,
            "device": "desktop",
            "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.0.0 Safari/537.36",
            "ip": "127.0.0.1"
        },
        "status": {
            "id": 1298199463,
            "name": "تم التنفيذ",
            "slug": "completed",
            "customized": {
                "id": 1633436842,
                "name": "طلبك بيوصلك قريب"
            }
        },
        "is_price_quote": false,
        "payment_method": "mada",
        "currency": "SAR",
        "amounts": {
            "sub_total": {
                "amount": 250,
                "currency": "SAR"
            },
            "shipping_cost": {
                "amount": 13.04,
                "currency": "SAR"
            },
            "cash_on_delivery": {
                "amount": 0,
                "currency": "SAR"
            },
            "tax": {
                "percent": "15.00",
                "amount": {
                    "amount": 39.46,
                    "currency": "SAR"
                }
            },
            "discounts": [
                {
                    "title": "New Coupon",
                    "type": "normal",
                    "code": "kb123",
                    "discount": "15.00",
                    "currency": "SAR",
                    "discounted_shipping": "0.00",
                    "hasMarketing": false
                }
            ],
            "total": {
                "amount": 302.5,
                "currency": "SAR"
            }
        },
        "can_cancel": false,
        "show_weight": true,
        "can_reorder": true,
        "is_pending_payment": false,
        "pending_payment_ends_at": 0,
        "total_weight": "٠٫٥١ كجم",
        "receiver": {
            "name": "أحمد Conn",
            "email": "demo@demo.com",
            "phone": "966501724227"
        },
        "customer": {
            "id": 1473353380,
            "first_name": "أحمد",
            "last_name": "Conn",
            "mobile": 501724227,
            "mobile_code": "+966",
            "email": "demo@demo.com",
            "urls": {
                "customer": "http://store.test/ar/hemo.store/profile",
                "admin": "/customers/x9oKNEzBmR3JlkMRYW6ZYd2q0QpPXy4n",
                "digital_content": "https://salla.sa/dev-k9dn7fok0vih4p70/orders/digital/lm6bowYMnmA9eyWdLkJza153vyZnMb85QO0GZ7NxDlVKXB4grqR82jEN"
            },
            "avatar": "https://cdn.assets.salla.network/prod/admin/cp/assets/images/avatar_male.png",
            "gender": "male",
            "birthday": {
                "date": "1970-01-01 00:00:00.000000",
                "timezone_type": 3,
                "timezone": "Asia/Riyadh"
            },
            "city": "الرياض",
            "country": "السعودية",
            "country_code": "SA",
            "currency": "SAR",
            "location": "ابيض طويل",
            "updated_at": {
                "date": "2024-02-15 11:18:00.000000",
                "timezone_type": 3,
                "timezone": "Asia/Riyadh"
            }
        },
        "bank": null,
        "tags": []
    }
}

🟢200Deprecated Response

🟠404Object Not Found

Order Details

Request

Request Code Samples

Responses