List Orders

The List Orders endpoint allows you to retrieve a list of orders based on specific filters such as status, establishment, and date range. By default, it returns today's pending orders from all establishments.

Endpoint

GET https://your-org-uuid.canteenweb.com/api/v1/admin/orders

Query Parameters

Parameter	Type	Required	Description
status	string	No	Filter orders by status: pending, completed, canceled, or archived. Defaults to pending.
establishment	string (UUID)	No	Filter by establishment UUID. Defaults to all establishments.
start_date	string (YYYY-MM-DD)	No	Filter orders with pickup_at on or after this date. Defaults to today.
end_date	string (YYYY-MM-DD)	No	Filter orders with pickup_at on or before this date. Defaults to today.
payment_method_type	string	No	Filter orders by payment method type: cash, card (Debit/Credit), credit (Canteen Credit)

Example Requests

1. List Today's Pending Orders (Default)

curl -X GET "https://your-org-uuid.canteenweb.com/api/v1/admin/orders" \
  -H "Authorization: Bearer your-access-token"

2. List Completed Orders for a Specific Establishment

curl -X GET "https://your-org-uuid.canteenweb.com/api/v1/admin/orders?status=completed&establishment=9e11ee05-32a4-4898-8735-5a7f88003409" \
  -H "Authorization: Bearer your-access-token"

3. List Orders in a Date Range

curl -X GET "https://your-org-uuid.canteenweb.com/api/v1/admin/orders?start_date=2025-02-01&end_date=2025-02-12" \
  -H "Authorization: Bearer your-access-token"

4. List Orders by Payment Method Type

curl -X GET "https://your-org-uuid.canteenweb.com/api/v1/admin/orders?payment_method_type=cash" \
  -H "Authorization: Bearer your-access-token"

Response Structure

The API returns an array of order objects, each containing order details, customer information, establishment details, and order items.

Example Response:

[
  {
    "uuid": "9e31eadd-b0ad-4ec4-866f-8b3418028922",
    "currency": "ARS",
    "reference": "SO-34BE51LA2T",
    "subtotal": {
      "amount": "7006",
      "currency": "ARS",
      "formatted": "$ 70,06"
    },
    "total": {
      "amount": "7006",
      "currency": "ARS",
      "formatted": "$ 70,06"
    },
    "pickup_at": "12/02/25",
    "canceled_at": null,
    "completed_at": null,
    "notes": null,
    "created_at": "2025-02-12T14:58:29.000000Z",
    "updated_at": "2025-02-12T14:58:29.000000Z",
    "can_be_cancelled": false,
    "status": {
      "label": "Pendiente",
      "value": "pending"
    },
    "payment_method_type": {
      "label": "Efectivo",
      "value": "cash"
    },
    "customer": {
      "uuid": "9e11ee05-37b3-42db-b2b1-9fa2d6e017bc",
      "full_name": "Consumidor Final",
      "class": null,
      "parent" : {
        "uuid": "3d11ee05-37b3-42db-b2b1-9fa2d6e017be",
        "full_name": "Consumidor Final (Padre)",
        "email": "[email protected]",
        "phone": "+5491123456789",
        "credit": {
          "amount": "10000",
          "currency": "ARS",
          "formatted": "$ 100,00"
        }
      }
    },
    "establishment": {
      "uuid": "9e11ee05-32a4-4898-8735-5a7f88003409",
      "name": "Sede 1"
    },
    "items": [
      {
        "uuid": "9e31eadd-b3ee-47b6-a332-1d5318ba9bb0",
        "sku": "PEACHCOBBLER",
        "name": "Peach Cobbler",
        "description": null,
        "price": {
          "amount": "7006",
          "currency": "ARS",
          "formatted": "$ 70,06"
        },
        "quantity": 1,
        "total": {
          "amount": "7006",
          "currency": "ARS",
          "formatted": "$ 70,06"
        },
        "image": "",
        "notes": null,
        "fulfilled_quantity": 0,
        "fulfillment_status": "unfulfilled",
        "is_menu": false,
        "status": {
          "label": "Pendiente",
          "value": "pending"
        },
        "created_at": "2025-02-12T14:58:29.000000Z"
      }
    ]
  }
]

Response Fields

Order Fields

Field	Type	Description
uuid	string	Unique identifier of the order.
currency	string	Currency of the order.
reference	string	Order reference code.
subtotal	object	Order subtotal details (amount, currency, formatted value).
total	object	Order total details (amount, currency, formatted value).
pickup_at	string	The scheduled pickup date of the order (YYYY-MM-DD).
canceled_at	string/null	Timestamp when the order was canceled, or null if not canceled.
completed_at	string/null	Timestamp when the order was completed, or null if not completed.
notes	string/null	Any notes added to the order.
can_be_cancelled	boolean	Whether the order can still be canceled.
payment_method_type	object	Payment method used for the order (contains label and value).
status	object	The status of the Order (contains label and value).
created_at	string	The date the order was created (YYYY-MM-DDTHH:MM:SS.ssssssZ / ISO 8601 format).
updated_at	string	The date the order was updated (YYYY-MM-DDTHH:MM:SS.ssssssZ / ISO 8601 format)

Customer Fields

Field	Type	Description
uuid	string	Unique identifier of the customer.
full_name	string	Full name of the customer.
class	string/null	Customer's class (if applicable).
parent	object/null	Parent customer details (if applicable).
parent.uuid	string	Unique identifier of the parent.
parent.full_name	string	Full name of the parent.
parent.email	string/null	Parent customer's email address.
parent.phone	string/null	Parent customer's phone number.
parent.credit	object	Parent customer's credit details (amount, currency, formatted value).

Establishment Fields

Field	Type	Description
uuid	string	Unique identifier of the establishment.
name	string	Name of the establishment.

Order Item Fields

Field	Type	Description
uuid	string	Unique identifier of the order item.
sku	string	SKU (Stock Keeping Unit) of the item.
name	string	Name of the item.
description	string/null	Description of the item.
price	object	Price details (amount, currency, formatted value).
quantity	integer	Quantity of this item in the order.
total	object	Total price of this item (amount, currency, formatted value).
image	string	URL of the item image (if available).
notes	string/null	Additional notes for this item.
fulfilled_quantity	integer	Number of items fulfilled.
fulfillment_status	string	Status of item fulfillment.
is_menu	boolean	Whether this item is from the menu.
status	object	The status of the Order (contains label and value).
created_at	string	Timestamp when the item was added to the order.

Notes

• Orders are always filtered using the pickup_at field as the reference date.
• If no filters are provided, only today's pending orders from all establishments are returned by default.
• Use status, establishment, and date filters to refine your search.