GET Custom Order Statuses

To get all custom order statuses.

HTTP Request

https://access.way2order.com/api/v1/getcustomorderstatuses

Request Header

Content-Type: application/json
Authorization: Bearer {access_token}

Request Response

[
    {
        "name": "Pending Import",
        "code": "afcb8a57e7c80729e83e43c3287d6a57",
        "description": "Orders which have not been imported yet",
        "parent": "New",
        "internal": true,
        "default": true
    },
    {
        "name": "Import Complete",
        "code": "a1735d312ebd13a6ebd05364bd7adf09",
        "description": "",
        "parent": "New",
        "internal": true,
        "default": false
    },
    {
        "name": "Packing",
        "code": "b329ba12c0741c5e01d134c8b113d4ae",
        "description": "Order is in Packing Department",
        "parent": "Confirmed",
        "internal": false,
        "default": false
    },
    {
        "name": "Ready for Invoicing",
        "code": "96bb8b04b8c99026979b255e4957d27f",
        "description": "Order is in Accounts Department",
        "parent": "Confirmed",
        "internal": false,
        "default": false
    },
    {
        "name": "Ready for Dispatch",
        "code": "e8cda08fdd6b61b2d795a44a46bf9c6a",
        "description": "Order is Ready for Dispatch",
        "parent": "Confirmed",
        "internal": false,
        "default": false
    },
    {
        "name": "Dispatched",
        "code": "781429507d290704fa92b1e88b8bb72b",
        "description": "",
        "parent": "Complete",
        "internal": false,
        "default": false
    }
]

Attribute Details

Attribute	Type	Description
name	String	Custom Order Status Name
code	String	Custom Order Status ID
description	String	Custom Order Status Description
parent	String	Parent Order Status (New, Confirmed, On-Hold, In-Process or Complete)
internal	Boolean	true if for internal use, false otherwise
default	Integer	true if to be applied by default, false otherwise