Fetch Single Order

Get single order through order id. You need to provide the order id as a path parameter.

Basic Information

  • Method: GET
  • URI: /orders/:order_id
  • Response Format: JSON

Headers

The following headers should be sent along with the request

  • Accept: application/json
  • Authorization: Your API Key

Request

Sample Request

https://dev-fc-api.aymakan.net/api/v1/orders/order-190

Response

Sample response is added here:

{
    "success": true,
    "message": "",
    "data": {
        "order_id": "order-190",
        "order_status": "on_hold",
        "customer": {
            "id": "",
            "first_name": "",
            "last_name": "",
            "mobile": "",
            "mobile_code": "",
            "email": "",
            "avatar": "",
            "gender": ""
        },
        "order_items": [],
        "total": 1,
        "billing_address": {
            "address1": "123 Main Street",
            "address2": "",
            "city": "New York",
            "country": "United States",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "123-456-7890",
            "state": "NY",
            "zip": "10001",
            "state_code": "NY",
            "country_code": "US",
            "latitude": 40.7128,
            "longitude": -74.006
        },
        "shipping_address": {
            "address1": "456 Elm Street",
            "address2": "",
            "city": "Los Angeles",
            "country": "United States",
            "first_name": "Jane",
            "last_name": "Smith",
            "phone": "987-654-3210",
            "state": "CA",
            "zip": "90001",
            "state_code": "CA",
            "country_code": "US",
            "latitude": 34.0522,
            "longitude": -118.2437
        },
        "transactions": [
            {
                "created_at": "2023-12-06T12:58:23.527Z",
                "amount": 699,
                "type": 0,
                "card_number": "",
                "source_account": "",
                "destination_account": "",
                "status": 0,
                "description": ""
            }
        ],
        "slot": {
            "delivery_date": "",
            "start_time": 0,
            "end_time": 0
        },
        "order_created_at": "2023-12-01T09:00:00Z",
        "invoice": {
            "currency": "USD",
            "subtotal": 699,
            "shipping_tax": 0,
            "sub_total_tax_inclusive": true,
            "sub_total_discount_inclusive": true,
            "shipping_tax_inclusive": false,
            "shipping_discount_inclusive": false,
            "shipping_price": 0,
            "shipping_refund": 0,
            "tax": 69.9,
            "tax_percent": 10,
            "discount": 100,
            "total": 768.9,
            "total_paid": 768.9
        },
        "shipment": {
            "shipment_created_at": "0001-01-01T00:00:00Z",
            "order_delivered_at": "0001-01-01T00:00:00Z",
            "order_shipped_at": "0001-01-01T00:00:00Z"
        },
        "payment_method": "Prepaid",
        "meta_data": {
            "is_update_order_allowed": false
        }
    },
    "meta": null
}