GET
/
orders
curl --request GET \
  --url https://take.app/api/platform/orders
[
  {
    "id": "<string>",
    "status": "ORDER_STATUS_PENDING",
    "paymentStatus": "PAYMENT_STATUS_PENDING",
    "fulfillmentStatus": "UNFULFILLED",
    "customer": {
      "name": "<string>",
      "phone": "<string>",
      "email": "jsmith@example.com"
    },
    "items": [
      {
        "productId": "<string>",
        "quantity": 123
      }
    ],
    "totalAmount": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
api_key
string
query
required

Response

200
application/json
Get all orders in the store
​
id
string
​
status
enum<string>

Note: ORDER_STATUS_FULFILLED is legacy and should be labeled as 'Completed' in UI

Available options:
ORDER_STATUS_PENDING,
ORDER_STATUS_CONFIRMED,
ORDER_STATUS_FULFILLED,
ORDER_STATUS_CANCELLED
​
paymentStatus
enum<string>
Available options:
PAYMENT_STATUS_PENDING,
PAYMENT_STATUS_CONFIRMING,
PAYMENT_STATUS_PARTIAL,
PAYMENT_STATUS_PAID,
PAYMENT_STATUS_REFUNDED
​
fulfillmentStatus
enum<string>
Available options:
UNFULFILLED,
READY,
OUT_FOR_DELIVERY,
FULFILLED
​
customer
object
​
items
object[]
​
totalAmount
number

Total amount in cents

​
createdAt
string