Skip to main content
API docs by Redocly

Palm Open API (1.0)

Download OpenAPI specification:Download

Public API for third-party integrations with Palm POS.

Orders

List orders

Retrieve orders across all stores in the organization, sorted by creation time (newest first). Supports filtering and cursor-based pagination.

Authorizations:
ApiKeyHeader
path Parameters
orgId
required
string <uuid>

Organization ID

query Parameters
store_id
string <uuid>

Filter by a specific store

view
string
Default: "all"
Enum: "all" "active" "history"

all — no filter; active — excludes completed/cancelled; history — only completed/cancelled

payment_status
string

Comma-separated payment statuses (e.g. paid,unpaid)

fulfillment_status
string

Comma-separated fulfillment statuses (e.g. completed,cancelled)

source
string

Comma-separated order sources (e.g. pos,kiosk)

from
string

Start date/time (RFC 3339 or YYYY-MM-DD)

to
string

End date/time (RFC 3339 or YYYY-MM-DD; date-only = end of day)

amount_min
integer

Minimum totalCents (inclusive)

amount_max
integer

Maximum totalCents (inclusive)

page_size
integer [ 1 .. 200 ]
Default: 200

Number of orders per page (1–200). Capped to 50 when expand includes items.

before
string <date-time>

Pagination cursor — pass the createdAt of the last order from the previous page (RFC 3339 Nano)

expand
string
Example: expand=items,payments

Comma-separated list of sub-resources to inline in each order object. Allowed values: items, payments, refunds, tax_breakdown. When specified, the server batch-loads the requested sub-resources for all orders in the current page and includes them in the response.

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "hasMore": false
}

Get order details

Retrieve full details of a single order including line items, refunds, and tax breakdown.

Authorizations:
ApiKeyHeader
path Parameters
orgId
required
string <uuid>

Organization ID

orderId
required
string <uuid>

Order ID

Responses

Response samples

Content type
application/json
{
  • "order": {
    }
}