Reference
Status Values
Shared status and role values used across Merchant API workflows.
This page explains shared status values without repeating every endpoint schema. Use workflow pages for where a status appears and what to do next. Use OpenAPI for the exact enum definitions.
Order Status
order_status describes the business order state.
| Value | Meaning |
|---|---|
pending | Order has been created and is waiting for downstream processing. |
charged | Order processing reached a chargeable state. |
uncharged | Order did not result in a merchant charge. |
review_required | Order needs operational review before it can be treated as final. |
Message Status
message_status describes normalized delivery state when delivery information is available.
| Value | Meaning |
|---|---|
ENROUTE | Message is in transit. |
DELIVRD | Message was delivered. |
EXPIRED | Message expired before delivery. |
DELETED | Message was deleted before delivery. |
UNDELIV | Message was not delivered. |
ACCEPTD | Message was accepted by downstream delivery handling. |
UNKNOWN | Delivery result is unknown. |
REJECTD | Message was rejected by downstream delivery handling. |
READ | Recipient read state when the channel supports read receipts. |
SMS delivery reports commonly use the SMPP-style uppercase values above. A missing message_status means delivery information is not available yet.
Bulk Job Status
bulk_job_status describes the job-level state for bulk upload and execution.
| Value | Meaning |
|---|---|
items_ready | Upload itemization completed and at least one row can be executed. |
executed | Execution was accepted and row processing has completed. |
failed | Upload itemization or job processing failed before execution could complete. |
Bulk Item Status
bulk_item_status describes one uploaded row inside a bulk job.
| Value | Meaning |
|---|---|
pending | Row was accepted during upload and is waiting for execution. |
filled | Row produced an SMS order. |
rejected | Row failed upload validation or send-time checks. |
User Role
role describes the API user's platform role.
| Value | Meaning |
|---|---|
site_admin | Internal site administrator role. |
merchant_admin | Merchant administrator role. |
api | Merchant API integration role. |