Preo
  • Homepage
  • About
Apps
  • Dashboard
  • App Store
  • Google Play
Social
  • LinkedIn

© 2026 Preo ApS

  • Integration
  • API
InformationSchemas
Webhooks
Webhooks

Schemas

CartItemObjectPayload

​object · readOnly · required
​object · readOnly · required
​object[] · readOnly · required
​object · readOnly · required
price
​number · double · min: 0 · readOnly · required
deposit
​number · double · min: 0 · readOnly · required
packaging_deposit
​number · double · min: 0 · readOnly · required
total
​number · double · min: 0 · readOnly · required
quantity
​integer · min: -2147483648 · max: 2147483647

CartObjectPayload

id
​string · readOnly · required
subtotal
​number · double · readOnly · required
handling_fee
​number · double · readOnly · required
service_fee
​number · double · readOnly · required
discount
​number · double · readOnly · required
tax
​number · double · readOnly · required
total
​number · double · readOnly · required
currency
​string · readOnly · required
​object · readOnly · required
​object[] · readOnly · required
metadata
​readOnly · required
status
​string · enum
  • created - created
  • awaiting_payment - awaiting payment
  • paid - paid
  • abandoned - abandoned
  • expired - expired
Enum values:
created
awaiting_payment
paid
abandoned
expired

ConsentObjectPayload

id
​string · readOnly · required
title
​string · maxLength: 250 · required
scope
​string | null · readOnly · required
type
​string | null · enum
  • terms - terms
  • marketing - marketing
  • notice - notice
Enum values:
terms
marketing
notice

CouponObjectPayload

id
​string · readOnly · required
metadata
​readOnly · required
code
​string · minLength: 6 · maxLength: 32

Leave empty to auto-generate

type
​string · enum
  • regular - regular
  • staff - staff
  • imported - imported
Enum values:
regular
staff
imported

DeploymentObjectPayload

id
​string · readOnly · required
name
​string · maxLength: 200 · required
slug
​string · readOnly · required

DeviceObjectPayload

id
​string · readOnly · required

EditionObjectPayload

id
​string · readOnly · required
slug
​string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required
full_name
​string · readOnly · required
tax_type
​string · readOnly · required
tax_type_display
​string · readOnly · required

Return localized tax type display name

timezone
​string · readOnly · required
start_date
​string | null · date-time

Date of the start of the event

end_date
​string | null · date-time

Date of the end of the event

metadata
​

Additional metadata in form of JSON object

OrderObjectPayload

id
​string · readOnly · required
order_number
​string · readOnly · required
created
​string · date-time · readOnly · required
created_display
​string · readOnly · required

Creation date formatted with edition's timezone and active locale

​object · readOnly · required
​object[] · readOnly · required
type
​string · enum
  • online - Online
  • in-person - In Person
  • imported - Imported
Enum values:
online
in-person
imported
status
​string · enum
  • pending - Pending
  • confirmed - Confirmed
  • completed - Completed
  • cancelled - Cancelled
Enum values:
pending
confirmed
completed
cancelled
amount
​number | null · double
currency
​string | null · enum
  • eur - EUR
  • usd - USD
  • gbp - GBP
  • pln - PLN
  • dkk - DKK
  • sek - SEK
  • nok - NOK
Enum values:
eur
usd
gbp
pln
dkk
sek
nok
metadata
​

PickupPointObjectPayload

id
​string · readOnly · required
name
​string · maxLength: 80 · required

ProductObjectPayload

id
​string · readOnly · required
​object · readOnly · required
image_url
​string · readOnly · required

Return optimized image URL for email display

name
​string · maxLength: 120
product_type
​string | null
metadata
​

Additional metadata in form of JSON object

ProductOptionObjectPayload

id
​string · readOnly · required
name
​string · maxLength: 120

PurchaseActionObjectPayload

id
​string · readOnly · required
action_source
​string | null · enum
  • user - User
  • scanner - Scanner
  • staff - Staff
Enum values:
user
scanner
staff
action_name
​string | null · enum
  • cancel_purchase - Cancel Purchase
  • collect_consumable - Collect
  • collect_rental - Collect
  • exchange_rental - Exchange
  • accept_return - Accept Return
  • refuse_return - Refuse Return
  • collect_multi_use - Collect
  • use - Use
  • use_last_time - Use Last Time
  • add_uses - Add uses
  • check_in - Check In
  • check_out - Check Out
Enum values:
cancel_purchase
collect_consumable
collect_rental
exchange_rental
accept_return
refuse_return
collect_multi_use
use
action_params
​string | null
action_timestamp
​string | null · date-time
status
​string · enum
  • pending - Pending
  • applied - Applied
  • error - Error
Enum values:
pending
applied
error

PurchaseObjectPayload

id
​string · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object[] · readOnly · required
​object · readOnly · required
metadata
​readOnly · required
price_paid
​number · double · readOnly · required
deposit_paid
​number · double · readOnly · required
handling_fee_paid
​number · double · readOnly · required
total_paid
​number · double · min: 0 · readOnly · required
status
​string · enum
  • paid - paid
  • collected - collected
  • in-use - in use
  • used - used
  • rented - rented
  • checked-in - checked in
  • checked-out - checked out
  • returned - returned
  • return-refused - return refused
  • refunded - refunded
  • cancelled - cancelled
Enum values:
paid
collected
in-use
used
rented
checked-in
checked-out
returned
vendor_code
​string | null · maxLength: 250

RefundRequestObjectPayload

id
​string · readOnly · required
amount
​number · double · required
​object · readOnly · required
status
​string · enum
  • requested - requested
  • ready - ready
  • processing - processing
  • awaiting_gateway - awaiting gateway
  • processed - processed
  • failed - failed
  • rejected - rejected
  • invalid - invalid
Enum values:
requested
ready
processing
awaiting_gateway
processed
failed
rejected
invalid
scope
​string · enum
  • purchase_price - Price only
  • purchase_deposit - Deposit only
  • purchase_full - Full purchase (incl. fees)
  • purchase_custom - Custom purchase amount
  • transaction_full - Full transaction
  • transaction_custom - Custom transaction amount
Enum values:
purchase_price
purchase_deposit
purchase_full
purchase_custom
transaction_full
transaction_custom
reason
​string · enum
  • deposit_reclaim - Deposit reclaimed
  • sold_out - Item sold out
  • event_cancelled - Event cancelled
  • product_defect - Product defective
  • duplicate_purchase - Duplicate purchase
  • customer_request - Customer requested
  • compensation - Customer compensation
  • overcharge - Customer overcharged
  • other - Other reason
  • rental_return - Rental returned
Enum values:
deposit_reclaim
sold_out
event_cancelled
product_defect
duplicate_purchase
customer_request
compensation
overcharge
comment
​string | null

Comment added upon custom refund

StaffUserObjectPayload

id
​string · readOnly · required
full_name
​string · readOnly · required

Returns the full name of the user.

email
​string · email · maxLength: 254

TransactionObjectPayload

id
​string · readOnly · required
order_number
​string · readOnly · required
created
​string · date-time · readOnly · required
created_display
​string · readOnly · required

Creation date formatted with edition's timezone and active locale

​object · readOnly · required
​object[] · readOnly · required
service
​string · readOnly · required
amount
​number · double · required
type
​string · enum
  • online - Online
  • in-person - In Person
  • imported - Imported
Enum values:
online
in-person
imported
status
​string · enum
  • pending - pending
  • started - started
  • processing - processing
  • completed - completed
  • failed - failed
  • cancelled - cancelled
Enum values:
pending
started
processing
completed
failed
cancelled
currency
​string | null · enum
  • eur - EUR
  • usd - USD
  • gbp - GBP
  • pln - PLN
  • dkk - DKK
  • sek - SEK
  • nok - NOK
Enum values:
eur
usd
gbp
pln
dkk
sek
nok
metadata
​

UniversalEventPayload

id
​string · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
​object · readOnly · required
campaign
​string · readOnly · required

UserObjectPayload

id
​string · readOnly · required
full_name
​string · readOnly · required
locale
​string · readOnly · required
email
​string | null · email · maxLength: 254
first_name
​string · maxLength: 80
last_name
​string · maxLength: 80
phone_number
​string | null · maxLength: 32
metadata
​

VariantObjectPayload

id
​string · readOnly · required
name
​string · maxLength: 120

E.g. "Blue" or "Size M"

metadata
​

Additional metadata in form of JSON object

VendorObjectPayload

id
​string · readOnly · required
name
​string · maxLength: 100 · required

WalletPassObjectPayload

id
​string · readOnly · required
On this page
  • CartItemObjectPayload
  • CartObjectPayload
  • ConsentObjectPayload
  • CouponObjectPayload
  • DeploymentObjectPayload
  • DeviceObjectPayload
  • EditionObjectPayload
  • OrderObjectPayload
  • PickupPointObjectPayload
  • ProductObjectPayload
  • ProductOptionObjectPayload
  • PurchaseActionObjectPayload
  • PurchaseObjectPayload
  • RefundRequestObjectPayload
  • StaffUserObjectPayload
  • TransactionObjectPayload
  • UniversalEventPayload
  • UserObjectPayload
  • VariantObjectPayload
  • VendorObjectPayload
  • WalletPassObjectPayload