Skip to content

Orders API Get Single Order

Diogo Gomes edited this page Jun 28, 2021 · 3 revisions

GET /v1/orders/{order_id}

Retrieves a specific order

Examples:

  1. Get a valid order
  2. Get a non-existing order

Example 1 - Get a valid order

GET /v1/orders/20018

Response:

{
    "order": {
         "id": 20018,
         "status": "cancelled",
         "on_hold_reason": null,
         "store_customer_id": null,
         "store_order_id": "test_1548171614",
         "source_id": "test_1548171614",
         "source_url": null,
         "source_name": null,
         "source_po_number": null,
         "packing_slip_url": null,
         "shipment_notification_url": null,
         "email": "test@shineon.com",
         "note": null,
         "test": true,
         "subtotal_price": 14.97,
         "total_shipping": 10.5,
         "total_price": 25.47,
         "currency": "USD",
         "total_weight": 28,
         "total_tax": "0.00",
         "name": "SHINE-30018",
         "phone": null,
         "created_at": "2019-01-22T15:40:14+00:00",
         "updated_at": "2019-01-31T16:07:42+00:00",
         "cancelled_at": "2019-01-31T16:07:42+00:00",
         "cancel_reason": "canceled_by_seller",
         "line_items": [
             {
                "id": 20017,
                "store_line_item_id": "000021548171614",
                "sku": "SO-20021",
                "title": "Military Chain (Silver) / Yes",
                "quantity": 1,
                "price": 9.97,
                "grams": 28,
                "properties": {
                    "Engraving Line 1": "Line 1",
                    "Engraving Line 2": "Line 2"
                }
            },
            {
                "id": 20018,
                "title": "Engraving",
                "quantity": 1,
                "price": 5
            }
         ],
         "billing_address": {
             "first_name": "John",
             "address1": "John Doe",
             "phone": null,
             "city": "Louisville",
             "zip": "40202",
             "province": null,
             "country": null,
             "last_name": "Doe",
             "address2": null,
             "company": null,
             "name": "John Doe",
             "country_code": null,
             "province_code": null
         },
         "shipping_address": {
             "first_name": "John",
             "address1": "John Doe",
             "phone": null,
             "city": "Louisville",
             "zip": "40202",
             "province": null,
             "country": null,
             "last_name": "Doe",
             "address2": null,
             "company": null,
             "name": "John Doe",
             "country_code": null,
             "province_code": null
         },
         "fulfillments": []
     }
}

Example 2 - Get a non-existing order

GET /v1/orders/99999

Response:

{
    "error": "Not Found."
}