Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

List Custom Statuses

GET

https://api.zid.sa/v1/managers/store/orders/custom-statuses

Fetch main order statuses with their custom sub-statuses for the authenticated manager’s store.

🔑Scopes

orders.read_write - Orders Read & Write

🔑Permission

can:orders.custom.statuses.view

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/managers/store/orders/custom-statuses' \
--header 'Authorization: Authorization: Bearer [your token]' \
--header 'Accept: application/json' \
--header 'Accept-Language: ar' \
--header 'X-MANAGER-TOKEN: X-MANAGER-TOKEN: [your token]'

Responses

🟢200Array of main statuses with nested sub_statuses.

application/json

Body

Example

[
    {
        "id": 1,
        "status": "New",
        "code": "new",
        "is_customizable": true,
        "sub_statuses": [
            {
                "id": 12,
                "name": "Awaiting Approval",
                "code": "awaiting_approval",
                "color": "#FFAA00",
                "is_active": true,
                "display_order": 0,
                "parent_status_id": 1
            }
        ]
    }
]

Modified at 2025-09-23 04:30:38

Orders

Bulk Create/Update Custom Statuses