Customer Order Status API

Manage custom customer order statuses

Base URL

https://{tenant}.logzi.com/api/order_in_customer_status/

Every request returns a JSON response. On success result.code == 1; on failure result.code == 0. The customer order status defines custom workflow states for customer orders — with a customizable name, color, and invoicing logic. These statuses can be assigned on the customer order document.

GET /api/order_in_customer_status/get

Retrieve a single customer status by ID.

Query parameters

ParameterTypeRequiredDescription
idintStatus ID

Example request

GET /api/order_in_customer_status/get?id=1
X-API-KEY: {your_api_key}
GET /api/order_in_customer_status/list

List of all customer order statuses.

No parameters required — returns all statuses.

Example request

GET /api/order_in_customer_status/list
X-API-KEY: {your_api_key}
POST /api/order_in_customer_status/save

Create or update a customer status. Use data[id] = 0 for a new status.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new status, >0 = update
customer_status_namestringStatus name (e.g. "In preparation")
customer_status_colorstringHexadecimal color code (e.g. #3498db)
customer_status_keystringUnique key (e.g. in_progress)
customer_status_invoiceint1 = an invoice can be issued in this status
customer_status_sortintSort order

Example request

POST /api/order_in_customer_status/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "customer_status_name": "Előkészítés alatt",
    "customer_status_color": "#f39c12",
    "customer_status_key": "preparing",
    "customer_status_invoice": 0,
    "customer_status_sort": 2
  }
}
POST /api/order_in_customer_status/delete

Delete a customer order status by ID.

POST fields — data object

FieldTypeRequiredDescription
idintID of the status to delete

Example request

POST /api/order_in_customer_status/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 1 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!