Get Order Details - citiesocial/citiesocial-api-doc GitHub Wiki

Get Order Details

  • URL

    /orders/{{ order-id }}/

  • Method:

    GET

  • URL Params

    None

  • Data Params

    None

  • Success Response:

    • Code: 200 OK
      Content: As sample success response below.
  • Error Response:

    • Code: 404 NOT FOUND
      Content: None

    • Code: 401 UNAUTHORIZED
      Content: {"message": "Unauthorized access"}

  • Sample Successful Response:

{
    "order": {
        "total_price": 12345,
        "name": "#123456",
        "items": [
            {
                "shipment": {
                    "carrier_name": "宅配通",
                    "carrier_tracking_id": "777004914000",
                    "shipped_at": "2017-08-25T00:00:00"
                },
                "estimated_shipping_date": "2017-08-28",
                "name": "Tube |北歐工業齒輪設計真皮腕錶 (42mm,黃銅、黑皮帶)",
                "is_refunded": true,
                "variant_id": 37989322130
            },
            {
                "shipment": {
                    "carrier_name": "宅配通",
                    "carrier_tracking_id": "777004914000",
                    "shipped_at": "2017-08-25T00:00:00"
                },
                "estimated_shipping_date": "2017-08-28",
                "name": "Tube |北歐工業齒輪設計真皮腕錶 (42mm,黃銅、黑皮帶)",
                "is_refunded": false,
                "variant_id": 37989322130
            },
            {
                "shipment": {
                    "carrier_name": "宅配通",
                    "carrier_tracking_id": "790013362003",
                    "shipped_at": "2017-08-25T15:57:49"
                },
                "estimated_shipping_date": "2017-08-28",
                "name": "氣墊抗壓專利坐墊組",
                "is_refunded": false,
                "variant_id": 40975783762
            }
        ],
        "financial_status": "partially_refunded",
        "id": "1234567890",
        "shipping_address": {
            "city": "台北市",
            "first_name": "小明",
            "last_name": "王",
            "zip": "100",
            "title": "先生",
            "address1": "中正區",
            "address2": "八德路一段23號15樓",
            "phone": "0912345678"
        },
        "is_cancelled": false,
        "email": "[email protected]"
    }
}