Order Statuses

View Order Status Endpoint

Structure

Order Status
Name
 Type
 Description
id int The id of the order status
name string The name of the order status
state string The state of the order status
group object The Group of the order status
Order Status Group
Name
 Type
 Description
id int The id of the order status group
name string The name of the order status group

Example Request

GET /api/order-statuses/{id}

Example Response

{
    "id": 2,
    "name": "On Hold",
    "state": "on_hold",
    "group": {
        "id": 1,
        "name": "test"
    }
}

Order Status Index Endpoint

Structure

See View Order Status Endpoint for the structure of the order status payload inside the data array.

Example Request

GET /api/order-statuses?per_page=2

Example Response

{
    "current_page": 1,
    "data": [
        //
    ],
    "first_page_url": "http://aero.test/api/order-statuses?page=1",
    "from": 1,
    "last_page": 5,
    "last_page_url": "http://aero.test/api/order-statuses?page=5",
    "next_page_url": "http://aero.test/api/order-statuses?page=2",
    "path": "http://aero.test/api/order-statuses",
    "per_page": 2,
    "prev_page_url": null,
    "to": 2,
    "total": 9
}

See View Order Status Endpoint for the structure of the order status payload inside the data array.