Organization API: Org Staff Orders
Every Organization API operation tagged Org Staff Orders.
Base URL: https://api.coritan.com/api/v1. Paths below are complete.
To try these requests in the browser, open the interactive Organization API reference.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/orgs/{org_slug}/staff/orders/board |
Staff orders board |
Staff orders board
Section titled Staff orders boardGET /api/v1/orgs/{org_slug}/staff/orders/board
Orders in six columns for a board view: pending_payment,
provisioning, install_failed, active_recent (went live in the
last 7 days), suspended and canceled_recent (ended in the last 7
days).
Each column answers { key, label, count, items }. count is every
order in the column and items the newest 30, each in the shape
GET /staff/orders answers. The counts equal what the order list and
GET /staff/orders/stats show for the same audience: install_failed
is the list's failed count, and provisioning plus
install_failed is its stuck count. Any member of the brand's staff
may read it.
Parameters
Section titled Parameters| Name | In | Type | Required | Description |
|---|---|---|---|---|
org_slug |
path | string | yes | |
audience |
query | string or null | no | paid: orders of paying customers. free: the free tier. Left out, every order. |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |