API Reference
/
Orders

PubQ Data API (v1)

API for accessing data related to companies, sales locations, and orders.

Download OpenAPI description
openApi.json
openApi.yaml
Overview
PubQ Support

support@pubq.se

License

MIT

Languages
Servers
Mock server

https://docs.pubq.se/_mock/apis/openapi/

Production server

https://data.pubq.se/v1/api/

Companies

Operations

Orders

Operations

Get Orders by Sales Location ID

Request

Retrieves a list of orders for a specific sales location (unit) within a given date range.

Path
idstringrequired

The ID of the sales location (routeName).

Query
frominteger(int64)required

The start date in Unix timestamp format.

tointeger(int64)required

The end date in Unix timestamp format.

curl -i -X GET \
  'https://docs.pubq.se/_mock/apis/openapi/orders/{id}?from=0&to=0'

Responses

Successful response

Bodyapplication/jsonArray [
dateISOstringrequired

The date and time of the order in ISO format.

dateTimestampintegerrequired

The Unix timestamp of the order date.

totalAmountintegerrequired

The total amount of the order (in cents).

discountAmountintegerrequired

The discount amount applied to the order (in cents).

userIdstringrequired

The ID of the user who placed the order.

totalItemsintegerrequired

The total number of items in the order.

timeslotobject(Timeslot)
paymentobjectrequired

The payment information.

itemsArray of objects(OrderItem)required

An array of items in the order.

items[].​namestringrequired

The name of the item.

items[].​quantityintegerrequired

The quantity of the item.

items[].​idstringrequired

The ID of the item.

items[].​totalPricenumberrequired

The total price of the item.

items[].​basePricenumberrequired

The base price of the item.

items[].​categorystringrequired

The category of the item.

items[].​descriptionstringrequired

The description of the item.

items[].​externalIdstring or null

The external ID of the item, if available.

]
Response
application/json
[
  {
    "dateISO": "string",
    "dateTimestamp": 0,
    "totalAmount": 0,
    "discountAmount": 0,
    "userId": "string",
    "totalItems": 0,
    "timeslot": { … },
    "payment": {},
    "items": [ … ]
  }
]

Metrics

Operations