Bulk Create/Update Custom Order Statuses

POST

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

Bulk creates or updates custom order statuses for multiple parent statuses. This is a full replacement operation, allowing merchants to manage all custom order sub-statuses in a single request.

🔑Scopes

third_order_read, third_order_write - third_order_read, third_order_write

Important Behavior: if an id is supplied for a sub-status, that custom status must belong to the current store and the specified parent status.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server error

🟠403Forbidden

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zid.sa/v1/managers/store/orders/custom-statuses' \
--header 'Authorization: {{Autherization}}' \
--header 'Store-ID: {{StoreId}}' \
--header 'Content-Type: application/json' \
--data '{
    "statuses": [
        {
            "parent_status_id": 1,
            "sub_statuses": [
                {
                    "name": {
                        "ar": "قيد المراجعة",
                        "en": "Under Review"
                    },
                    "color": "#FF5733",
                    "is_active": true
                }
            ]
        }
    ]
}'

Response Example

200 - Example 1

{
    "code": "SUCCESS_WITH_LIST_PAYLOAD_OBJECTS",
    "message": null,
    "payload": [
        {
            "id": 1,
            "status": "New",
            "code": "new_order",
            "is_customizable": true,
            "sub_statuses": [
                {
                    "id": 10,
                    "name": {
                        "ar": "قيد المراجعة",
                        "en": "Under Review"
                    },
                    "code": "under_review",
                    "color": "#FF5733",
                    "is_active": true,
                    "display_order": 0,
                    "parent_status_id": 1,
                    "created_at": "2026-08-10T12:00:00",
                    "updated_at": "2026-08-10T12:00:00"
                }
            ]
        }
    ]
}

Modified at 2026-09-10 09:23:46

Order Fulfillment Inventories

Reverse Orders