Skip to main content
GET
/
v1
/
partner
/
orders
/
statuses
Enum of valid order statuses
curl --request GET \
  --url https://api.dev.shadowchef.co/v1/partner/orders/statuses \
  --header 'Authorization: Basic <encoded-value>'
{
  "request_id": "8591cb6fa8ce518302af4ab3210b2a42",
  "data": [
    {
      "id": 1,
      "status": "PLACED",
      "translation": {
        "en": "PLACED",
        "id": "Ditempatkan",
        "ja": "配置されました",
        "km": "ទាន់សម័យ",
        "ms": "Diletakkan",
        "th": "วาง",
        "tl": "Placed",
        "vi": "Đặt",
        "zh": "放置",
        "zh-tw": "下訂"
      }
    },
    {
      "id": 2,
      "status": "ACCEPTED",
      "translation": {
        "en": "ACCEPTED",
        "id": "Diterima",
        "ja": "承認されました",
        "km": "បានទទួលយក",
        "ms": "Diterima",
        "th": "ยอมรับ",
        "tl": "Accepted",
        "vi": "Đã chấp nhận",
        "zh": "接受",
        "zh-tw": "接受"
      }
    },
    {
      "id": 3,
      "status": "CANCELLED",
      "translation": {
        "en": "CANCELLED",
        "id": "Dibatalkan",
        "ja": "キャンセルされました",
        "km": "បោះបង់",
        "ms": "Dibatalkan",
        "th": "ยกเลิก",
        "tl": "Cancelled",
        "vi": "Hủy bỏ",
        "zh": "取消",
        "zh-tw": "取消"
      },
      "translation_btn": [
        {
          "order_type_id": 1,
          "action_btn_text": {
            "en": "Canceled",
            "id": "Dibatalkan",
            "ja": "キャンセル",
            "tl": "Kinansela",
            "vi": "Đã hủy"
          },
          "past_order_action_btn_text": {
            "en": "Canceled",
            "id": "Dibatalkan",
            "ja": "キャンセル",
            "tl": "Kinansela",
            "vi": "Đã hủy"
          }
        },
        {
          "order_type_id": 2,
          "action_btn_text": {
            "en": "Canceled",
            "id": "Dibatalkan"
          },
          "past_order_action_btn_text": {
            "en": "Canceled",
            "id": "Dibatalkan"
          }
        },
        {
          "order_type_id": 3,
          "action_btn_text": {
            "en": "Canceled",
            "id": "Dibatalkan"
          },
          "past_order_action_btn_text": {
            "en": "Canceled",
            "id": "Dibatalkan"
          }
        }
      ]
    },
    {
      "id": 4,
      "status": "READY",
      "translation": {
        "en": "READY",
        "id": "Sedia",
        "ja": "準備完了",
        "tl": "Ready",
        "vi": "Sẵn sàng"
      },
      "translation_btn": [
        {
          "order_type_id": 1,
          "action_btn_text": {
            "en": "Ready",
            "id": "Siap",
            "vi": "Sẵn sàng"
          }
        },
        {
          "order_type_id": 2,
          "action_btn_text": {
            "en": "Ready",
            "id": "Siap"
          }
        },
        {
          "order_type_id": 3,
          "action_btn_text": {
            "en": "Ready",
            "id": "Siap"
          }
        }
      ]
    },
    {
      "id": 5,
      "status": "DELIVERED",
      "translation": {
        "en": "DELIVERED",
        "id": "Dikirim",
        "ja": "配達されました",
        "tl": "Delivered",
        "vi": "Giao hàng"
      },
      "translation_btn": [
        {
          "order_type_id": 1,
          "action_btn_text": {
            "en": "Complete",
            "vi": "Hoàn thành"
          },
          "past_order_action_btn_text": {
            "en": "Completed",
            "id": "Selesai"
          }
        },
        {
          "order_type_id": 2,
          "action_btn_text": {
            "en": "Complete"
          },
          "past_order_action_btn_text": {
            "en": "Completed"
          }
        },
        {
          "order_type_id": 3,
          "action_btn_text": {
            "en": "Complete"
          },
          "past_order_action_btn_text": {
            "en": "Completed"
          }
        }
      ]
    },
    {
      "id": 6,
      "status": "SCHEDULED",
      "translation": {
        "en": "SCHEDULED",
        "id": "Jadual",
        "tl": "Scheduled",
        "vi": "Lên lịch"
      }
    },
    {
      "id": 7,
      "status": "DRIVER ASSIGNED",
      "translation": {
        "en": "DRIVER ASSIGNED",
        "id": "Penunggang Ditugaskan",
        "tl": "Driver Assigned",
        "vi": "Tài xế đã được chỉ định"
      }
    },
    {
      "id": 8,
      "status": "DRIVER ARRIVED",
      "translation": {
        "en": "DRIVER ARRIVED",
        "id": "Pengemudi Tiba",
        "tl": "Driver Arrived",
        "vi": "Tài xế đã đến"
      }
    },
    {
      "id": 9,
      "status": "PICKED UP",
      "translation": {
        "en": "PICKED UP",
        "id": "Diambil",
        "tl": "Picked Up",
        "vi": "Được nhặt lên"
      }
    },
    {
      "id": 10,
      "status": "PENDING",
      "translation": {
        "en": "PENDING",
        "id": "Tertunda",
        "tl": "Pending",
        "vi": "Đang chờ xử lý"
      }
    },
    {
      "id": 11,
      "status": "VOID",
      "translation": {
        "en": "VOID",
        "id": "Batal",
        "tl": "Pending",
        "vi": "Vô hiệu"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Authorization: Basic base64(partner_key:secret_key).

Credentials are issued by a klikit operator. The plaintext secret_key is shown once at issuance and cannot be retrieved later — store it securely. If lost, ask your operator to rotate the secret to receive a new one. The old secret stops working immediately on rotation; there is no overlap window.

Response

200 - application/json

Order-status enum

Canonical response wrapper. Every response — success or error — carries the request_id so you can quote one id to klikit support to correlate a request end-to-end.

request_id
string
required
Example:

"req_4d1b7e3f-..."

data
object[]

Endpoint-specific payload on success.

error
object

Machine-readable error code + human message. The code is stable across releases — switch on code in your client code rather than parsing the message text.

Common codes you will encounter as a partner:

CodeHTTPMeaning
auth_missing401Authorization header absent / malformed
auth_invalid_credential401partner_key or secret_key did not verify
auth_revoked403Credential is revoked
auth_forbidden403Credential not authorized for the requested scope
request_invalid400Body / query parameters failed validation
request_missing_idempotency_key400Write endpoint called without Idempotency-Key
request_invalid_range400Date range > 90 days
resource_not_found404Order / store / mapping does not exist
resource_unmapped404Stock / availability call referenced an unknown SKU
state_invalid_transition409Order PATCH not allowed by current state
state_idempotency_conflict409Same Idempotency-Key reused with a different body
rate_limit_exceeded429Per-credential rate cap hit
downstream_unavailable502An internal klikit dependency is unreachable