Guide / Order Status Management
KO EN

Order Status Management

Order Status Management allows administrators to manage the master list of order statuses used in the iShop order workflow. Each status defines a code, display name, sorting order, active state, terminal state, and badge color used throughout the order management system.

Order statuses control how orders move through the fulfillment process. Use clear status names and consistent workflow order so administrators can understand each order state quickly.

Overview

The Order Status Management screen is used to manage the OrderStatus master data in the database. These statuses appear in order lists, order detail screens, filters, badges, and workflow actions.

Area Description
Status List Displays all registered order statuses with code, preview, display name, active state, terminal state, and actions.
Add Status Opens the order status editor for creating a new status.
Seed Defaults Creates or restores the default order statuses.
Search and Filters Allows administrators to filter by keyword, active state, inactive state, and terminal state.
Status Editor Used to configure code, display name, sort order, description, CSS class, flags, colors, and preview.

Status Summary

The summary badges at the top show the current number of order statuses.

Badge Description
Total Total number of order statuses registered in the system.
Active Number of statuses currently enabled.
Terminal Number of final or closed statuses.

Status List

The Status List shows all order statuses in workflow order. Administrators can sort statuses, review badge previews, edit status settings, and disable statuses when they are no longer used.

Column Description
Order The workflow order. Use the up and down buttons to adjust the display or workflow sequence.
Code The internal status code. Example: PAID, PREPARING, SHIPPED.
Preview Shows the badge style that will be displayed in order screens.
DisplayName The user-facing status label.
Active Shows whether the status is enabled.
Terminal Shows whether this status is a final closed status.
Actions Provides Edit and Disable actions.

Default Status Examples

The default workflow may include statuses such as:

Status Code Display Name Meaning Terminal
PAID Paid Payment has been completed. No
PREPARING Preparing Items are being prepared for shipment. No
SHIPPED Shipped The order has been shipped or is in transit. No
COMPLETED Completed The order is fully completed. Yes
CANCELLED Cancelled The order has been cancelled. Yes
PARTIAL_CANCELLED Partial Cancelled Part of the order has been cancelled. No
REFUNDED Refunded The order has been refunded. Yes
PARTIAL_REFUNDED Partial Refunded Part of the order has been refunded. No
FAILED Failed The payment or order failed. Yes

Search and Filters

Use the search and filter tools to quickly find status records.

Control Description
Search Searches by status code, display name, or description.
All Shows all statuses.
Active Shows only active statuses.
Inactive Shows only inactive statuses.
Terminal Shows only final or closed statuses.

Add Status

Click Add Status to create a new order status.

  1. Open Admin > iShop > Status List.
  2. Click Add Status.
  3. Enter a status code.
  4. Enter the display name.
  5. Set the sort order.
  6. Enter a description if needed.
  7. Enter a badge CSS class if needed.
  8. Set active and terminal flags.
  9. Choose badge colors.
  10. Review the live preview.
  11. Click Save.

Seed Defaults

The Seed Defaults button creates or restores the standard order statuses. Use this when the system needs the default workflow statuses.

Use Seed Defaults carefully. Depending on implementation, it may create missing default statuses or update existing default records.

Status Editor

The Status Editor is used to configure each order status.

Section Description
Base Info Configures status code, display name, sort order, description, and badge CSS class.
Flags Controls active state and terminal state.
Colors & Preview Controls badge background, border, text colors, and live preview.

Base Info

Field Description
StatusCode The internal code used by the system. English letters, numbers, and underscores are recommended.
DisplayName The status name displayed on the user screen.
SortOrder Controls workflow and list order. Smaller values are placed first.
Description Optional explanation for the status.
BadgeCssClass Optional CSS hook for custom styling. Example: is-paid.

StatusCode

StatusCode is the internal identifier of the order status. Use stable values because code may be referenced by order logic, filters, badges, or workflow rules. 

Recommended:
PAID
PREPARING
SHIPPED
COMPLETED
CANCELLED
PARTIAL_REFUNDED

Avoid:
Paid Order!
preparing status
배송완료###
In edit mode, StatusCode may be locked and cannot be changed. This prevents breaking existing orders or workflow references.

DisplayName

DisplayName is the label shown on the screen. It can be more readable than the internal code. 

Examples:
Paid
Preparing
Shipped
Completed
Cancelled
Refunded

SortOrder

SortOrder determines how statuses are ordered in the list and workflow. Smaller values are placed first. 

Example:
10 = Paid
20 = Preparing
30 = Shipped
40 = Completed

Description

Description is optional. Use it to explain what the status means.

BadgeCssClass

BadgeCssClass is an optional CSS hook used for additional styling. 

Examples:
is-paid
is-preparing
is-shipped
is-completed
is-cancelled
is-refunded
is-failed

Flags

Flags define whether the status is available and whether it represents the end of an order workflow.

Flag Description
IsActive Shows this status in the list and makes it available for use.
IsTerminal Marks this status as a final completed or closed status.

IsActive

  • Turn on IsActive when the status should be available in order workflows.
  • Turn it off when the status should no longer be used.

IsTerminal

IsTerminal means the status is a final state. A terminal status usually indicates that the order should not continue through normal fulfillment steps. 

Common terminal statuses:
COMPLETED
CANCELLED
REFUNDED
FAILED
Do not mark intermediate statuses such as PAID, PREPARING, or SHIPPED as terminal unless your workflow requires it.

Colors and Preview

The Colors & Preview section controls how the status badge appears in order screens. The preview updates immediately as you type.

Color Field Description
ColorBg Badge background color.
ColorBorder Badge border color.
ColorText Badge text color. 
Example:
ColorBg: #1F4FD8
ColorBorder: #183FAE
ColorText: #FFFFFF

Live Preview

The Live Preview button or preview area shows how the status badge will appear before saving. Use it to confirm readability and color contrast.

Edit Status

Click Edit to modify an existing status. In edit mode, the status code may be locked to protect existing order references.

  1. Click Edit on the target status.
  2. Update display name, sort order, description, flags, or colors.
  3. Check the preview.
  4. Click Save.

Disable Status

Click Disable to deactivate a status. A disabled status may no longer appear in status selection lists.

Disabling a status is usually safer than deleting it because existing orders may still reference that status.

Recommended Workflow

  1. Seed default statuses if the system has no status records.
  2. Review the default order workflow.
  3. Adjust SortOrder to match the desired order flow.
  4. Add custom statuses only when needed.
  5. Set terminal flags for final statuses.
  6. Choose badge colors with clear contrast.
  7. Disable unused statuses instead of deleting them.
  8. Test order status changes in Order Management.

Common Use Cases

Use Case Recommended Action
Create a custom fulfillment step Add a new active status and place it in the correct SortOrder position.
Mark an order workflow as completed Use a terminal status such as Completed.
Temporarily stop using a status Disable the status instead of deleting it.
Improve readability Set clear badge colors and verify the live preview.
Restore standard workflow Use Seed Defaults if default statuses are missing.

Important Notes

  • StatusCode should be stable and should not be changed after orders use it.
  • SortOrder affects workflow display and list order.
  • Terminal statuses represent final or closed states.
  • Only active statuses should be used in normal order processing.
  • Badge colors should have enough contrast for readability.
  • Do not disable statuses that are still required by active workflows.

Best Practices

  • Use uppercase English status codes with underscores.
  • Use short and clear display names.
  • Keep workflow order simple and logical.
  • Use terminal status only for final states.
  • Use consistent badge colors across similar status types.
  • Test status changes from the Order Details screen.
  • Document any custom statuses used by the business.
Order statuses are master data for the order workflow. Configure them carefully because they affect order management, filtering, reporting, fulfillment, and customer service.