GET

List Statuses

Retrieve a list of all custom order statuses configured in your system.

Endpoint

HTTP Request

GET /v1/statuses

Authentication

This endpoint requires a valid API key with canViewStatuses permission. The API key must be passed in the X-API-Key header.

Required Header

X-API-Key: your_api_key_here

Response

Returns all custom statuses with detailed configuration:

200 OK - Success Response

{
  "statuses": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Processing",
      "public_name": "Your order is being processed",
      "use_public_name": true,
      "display_name": "Your order is being processed",
      "color": "#2948ff",
      "order": 1,
      "is_independent": false,
      "notifications": {
        "email": true,
        "sms": false,
        "whatsapp": true
      },
      "shopify_order_effect": "NONE",
      "max_duration": {
        "enabled": true,
        "seconds": 86400,
        "skip_weekends": false,
        "show_public_overdue_date": true
      },
      "sub_status_group": {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Shipping Methods",
        "options": [
          {
            "id": "770e8400-e29b-41d4-a716-446655440002",
            "name": "Standard Shipping",
            "order": 1
          },
          {
            "id": "880e8400-e29b-41d4-a716-446655440003",
            "name": "Express Shipping",
            "order": 2
          }
        ]
      }
    },
    {
      "id": "990e8400-e29b-41d4-a716-446655440004",
      "name": "Completed",
      "public_name": "Order completed",
      "use_public_name": false,
      "display_name": "Completed",
      "color": "#10b981",
      "order": 5,
      "is_independent": true,
      "notifications": {
        "email": false,
        "sms": false,
        "whatsapp": false
      },
      "shopify_order_effect": "MARKS_ORDER_FULFILLED",
      "max_duration": {
        "enabled": false,
        "seconds": 0,
        "skip_weekends": false,
        "show_public_overdue_date": false
      },
      "sub_status_group": null
    }
  ],
  "summary": {
    "total": 2
  }
}

Response Fields

Root Response Object

Field	Type	Description
`statuses`	array	Array of status objects
`summary`	object	Summary object with count

Status Object Fields

Field	Type	Description
`id`	string	UUID of the status
`name`	string	Internal name of the status
`public_name`	string	Customer-facing name
`use_public_name`	boolean	Whether to use public name for customers
`display_name`	string	Computed display name (public_name if use_public_name is true, otherwise name)
`color`	string	Hex color code for the status
`order`	number	Display order in workflow
`is_independent`	boolean	Whether status can be used independently of workflow
`notifications`	object	Object containing notification settings
`shopify_order_effect`	string	Effect on Shopify order (e.g., NONE, MARKS_ORDER_FULFILLED)
`max_duration`	object	Object containing duration limit settings
`sub_status_group`	object \| null	Object containing sub-status group details, or null

Notifications Object Fields

Field	Type	Description
`email`	boolean	Whether email notifications are enabled
`sms`	boolean	Whether SMS notifications are enabled
`whatsapp`	boolean	Whether WhatsApp notifications are enabled

Max Duration Object Fields

Field	Type	Description
`enabled`	boolean	Whether max duration is enabled
`seconds`	number	Maximum duration in seconds
`skip_weekends`	boolean	Whether to skip weekends in duration calculation
`show_public_overdue_date`	boolean	Whether to show overdue date to customers

Sub-Status Group Object Fields

Field	Type	Description
`id`	string	UUID of the sub-status group
`name`	string	Name of the sub-status group
`options`	array	Array of sub-status options

Sub-Status Option Fields

Field	Type	Description
`id`	string	UUID of the sub-status option
`name`	string	Name of the sub-status option
`order`	number	Display order of the sub-status option

Summary Object Fields

Field	Type	Description
`total`	number	Total number of statuses

Examples

Basic Request

cURL Request

curl -X GET "https://ultimate-custom-order-status.app.msmtech.ca/api/v1/statuses" \
  -H "X-API-Key: your_api_key_here"

Rate Limiting

This endpoint is subject to per-minute and per-day rate limits based on your API key. Rate limit information is returned in the response headers:

X-RateLimit-Limit-Minute: Maximum requests per minute
X-RateLimit-Remaining-Minute: Remaining requests in current minute
X-RateLimit-Reset-Minute: Unix timestamp when minute window resets
X-RateLimit-Limit-Day: Maximum requests per day
X-RateLimit-Remaining-Day: Remaining requests in current day
X-RateLimit-Reset-Day: Unix timestamp when day window resets
Retry-After: Seconds to wait before retrying (when rate limited)

Error Responses

401 Unauthorized

Missing or invalid API key

401 Unauthorized

{
  "error": "Invalid API key"
}

403 Forbidden

API key lacks required permissions

403 Forbidden

{
  "error": "Insufficient permissions"
}

500 Internal Server Error

Server error occurred

500 Internal Server Error

{
  "error": "Internal server error",
  "details": {
    "message": "Error description"
  }
}