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

Bulk Create/Update Custom Statuses

POST

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

Bulk create/update custom sub-statuses across one or more parent statuses. The payload is treated as the canonical set for the included parents:

Items with id → update (must belong to the same store & parent)

Items without id → create

Order of items determines display_order (0, 1, 2, …)

Omitted existing items for the included parents are deleted

Validation Notes

statuses must be a non-empty array.

parent_status_id must be one of: 1, 2, 17, 3, 5, 7, 12.

Each sub_statuses[i].name must include at least one of en or ar.

If id is provided, it must exist and belong to the current store & the specified parent_status_id.

🔑 Scopes

orders.read_write - Orders Read & Write

🔑 Permission

can:orders.custom.statuses.manage

Request

Header Params

Body Params application/json

Example

{
    "statuses": [
        {
            "parent_status_id": 1,
            "sub_statuses": [
                {
                    "name": {
                        "en": "Awaiting Approval",
                        "ar": "بانتظار الموافقة"
                    },
                    "color": "#FFAA00",
                    "is_active": true,
                    "display_order": 0
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '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]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "statuses": [
        {
            "parent_status_id": 1,
            "sub_statuses": [
                {
                    "name": {
                        "en": "Awaiting Approval",
                        "ar": "بانتظار الموافقة"
                    },
                    "color": "#FFAA00",
                    "is_active": true,
                    "display_order": 0
                }
            ]
        }
    ]
}'

Responses

🟢200OK

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,
                "created_at": "2025-09-01T10:15:30Z",
                "updated_at": "2025-09-10T14:02:00Z"
            }
        ]
    }
]

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

List Custom Statuses

Update Order by ID