Status Fields

A status has a number of properties, represented by fields. Each field defines specific behaviors and characteristics of the status.

Important: The table below shows all supported fields for statuses. Mandatory fields are marked with *. Any field not listed below will be ignored if included in an API request.

Status Field Reference

Field name	Description	Default value	Supported values
description*	Status title	—	string
email_header	Header of an e-mail sent when the status is set	''	HTML
email_subj	Subject of an e-mail sent when the status is set	''	string
is_default	Flag, defines if the status is default (cannot be deleted). It is not recommended to make default status not default.	N	Y, N
lang_code	Language code	en	en, ru, etc.
params	Status parameters	{}	JSON object
status	Letter identifying the status	Set automatically	char
status_id	Status ID	Set automatically	integer
type	Status type	O	Valid status type (only O by default)

Example Status Object

{
  "description": "Processing",
  "email_header": "<h1>Your order is being processed</h1>",
  "email_subj": "Order #12345 is now being processed",
  "is_default": "N",
  "lang_code": "en",
  "params": {},
  "status": "P",
  "status_id": 5,
  "type": "O"
}

Tip: When creating a new status, only the description field is required. Other fields will use their default values if not specified.