Custom Order Statuses

To fit every business needs, We bringing more customization to the order entity such as custom order statuses, So we can set your own status based on its context to the order entity

Get statuses list

Endpoint: https://api.youcan.shop/orders/settings

Method: GET

Required Scopes

• read-orders-statuses

Response

[200]

{
    "order_statuses": {
        "payment": [
            {
                "slug": "unpaid",
                "name": "unpaid",
                "color": "#F5A623FF"
            },
            {
                "slug": "paid",
                "name": "paid",
                "color": "#D0021BFF"
            }
        ],
        "shipping": [
            {
                "slug": "shipped",
                "name": "shipped",
                "color": "#115E59FF"
            },
            {
                "slug": "processing",
                "name": "processing",
                "color": "#C2410CFF"
            }
        ],
        "ordersStatus": [
            {
                "slug": "open",
                "name": "open",
                "color": "#4A90E2FF"
            }
        ]
    }
}

Update statuses list

We explicitly accept the json schema above to have a custom statuses list for all order scopes.

Endpoint: https://api.youcan.shop/orders/settings

Method: PUT

Response

[200] Status is successfully updated

{
    "status": 200,
    "detail": "Status is successfully updated",
    "meta": []
}