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 Order 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: {{Autherization}}' \
--header 'X-MANAGER-TOKEN: {{Access-Token}}' \
--header 'Accept: application/json' \
--header 'Accept-Language: en'

Responses

🟢200OK

application/json

Body

Example

{
    "code": "SUCCESS_WITH_LIST_PAYLOAD_OBJECTS",
    "message": null,
    "payload": [
        {
            "id": 1,
            "status": "جديد",
            "code": "new",
            "is_customizable": true,
            "sub_statuses": [
                {
                    "id": 10005,
                    "name": {
                        "ar": "جاري التغليف",
                        "en": "packaging"
                    },
                    "code": "packaging",
                    "color": "#c33c3c",
                    "is_active": true,
                    "display_order": 1,
                    "parent_status_id": 2,
                    "created_at": "2025-09-14 12:47:57",
                    "updated_at": "2025-09-14 12:47:57"
                }
            ]
        }
    ]
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-01-30 20:55:20

List Orders

List Order Credit Notes