Orders

The Order object represents a customer order received through a POS integration or created via the API.

Orders are the central link between your POS system and Harlyy's feedback engine. Each order captures customer details, line items, payment status, and metadata, and can be associated with survey submissions to tie feedback directly to the transaction that prompted it.

The Order Object

Schema Order not found in OpenAPI spec.

Retrieve Orders

Retrieve orders for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the orders for.

pageinteger

The page number to retrieve.

pageSizeinteger

The number of items per page.

filtersarray

sortsarray

expandstring

Returns200

The orders.

No external docs found for ListResponse_Order.

Endpoint

GET /v2/businesses/{business}/orders

Retrieve an Order

Retrieve a order for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to retrieve the order for.

orderstringPath RequiredField must be in path.

The ID of the order to retrieve.

expandstring

Returns200

The order was found.

No external docs found for ObjectResponse_Order.

Endpoint

GET /v2/businesses/{business}/orders/{order}

Create an Order

Create an order for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to create the order for.

Schema undefined not found in OpenAPI spec.

Returns201

The order was created.

No external docs found for ObjectResponse_Order.

Endpoint

POST /v2/businesses/{business}/orders

Update an Order

Update an order for a business

Parameters

businessstringPath RequiredField must be in path.

The ID of the business to update the order for.

orderstringPath RequiredField must be in path.

The ID of the order to update.

Schema undefined not found in OpenAPI spec.

Returns200

The order was updated.

No external docs found for ObjectResponse_Order.

Endpoint

PATCH /v2/businesses/{business}/orders/{order}