Schemas

BlankEnum

CELCategoryValue

id

string · required

name

string · required

CELContextResponse

object · required

object[] · required

object · required

CELDynamicValues

object[] · required

product_types

string[] · required

purchase_statuses

string[] · required

object[] · required

CELEditionValue

slug

string · required

full_name

string · required

CELExample

description

string · required

expression

string · required

CELFunction

name

string · required

syntax

string · required

description

string · required

example

string · required

CELLocationValue

id

string · required

name

string · required

CELMarketingConsentValue

id

string · required

title

string · required

CELProductValue

id

string · required

name

string · required

object[] · required

category_ids

string[] · required

CELSchemaField

type

string · required

description

string

object

CELVariantValue

id

string · required

name

string · required

CELVendorValue

id

string · required

name

string · required

CampaignCreate

organization_id

string · required

edition_id

string · required

segment_id

string · required

name

string · maxLength: 255 · required

channel

string · enum · required

email - Email
sms - SMS

Enum values:

sms

email_message_id

string | null

object

CampaignDetail

id

string · readOnly · required

name

string · maxLength: 255 · required

Human-readable campaign name

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

object · readOnly · required

channel

string · enum · required

Delivery channel

email - Email
sms - SMS

Enum values:

sms

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

email_message_id

string | null · readOnly · required

sms_body

string · readOnly · required

status

string · enum

Current campaign status

draft - Draft
scheduled - Scheduled
calculating - Calculating Segment
sending - Sending
sent - Sent
failed - Failed
cancelled - Cancelled

Enum values:

draft

scheduled

calculating

sending

sent

failed

cancelled

scheduled_at

string | null · date-time

When to send (stored UTC, displayed in edition timezone)

total_recipients

integer · min: 0 · max: 2147483647

Total number of recipients to send to

sent_count

integer · min: 0 · max: 2147483647

Number of messages successfully sent

failed_count

integer · min: 0 · max: 2147483647

Number of messages that failed to send

user_count

integer · min: 0 · max: 2147483647

Snapshot count of users at send time

error_message

string

Error details if campaign failed

started_at

string | null · date-time

When sending started

completed_at

string | null · date-time

When sending finished

CampaignList

id

string · readOnly · required

name

string · maxLength: 255 · required

Human-readable campaign name

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

object · readOnly · required

channel

string · enum · required

Delivery channel

email - Email
sms - SMS

Enum values:

sms

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

status

string · enum

Current campaign status

draft - Draft
scheduled - Scheduled
calculating - Calculating Segment
sending - Sending
sent - Sent
failed - Failed
cancelled - Cancelled

Enum values:

draft

scheduled

calculating

sending

sent

failed

cancelled

scheduled_at

string | null · date-time

When to send (stored UTC, displayed in edition timezone)

total_recipients

integer · min: 0 · max: 2147483647

Total number of recipients to send to

sent_count

integer · min: 0 · max: 2147483647

Number of messages successfully sent

failed_count

integer · min: 0 · max: 2147483647

Number of messages that failed to send

CampaignSchedule

scheduled_at

string · date-time · required

CampaignStats

total_recipients

integer · required

sent

integer · required

failed

integer · required

delivered

integer · required

opened

integer · required

clicked

integer · required

bounced

integer · required

unsubscribed

integer · required

delivery_rate

number · double · required

open_rate

number · double · required

click_rate

number · double · required

unsubscribe_rate

number · double · required

CartPresentation

object[] · required

currency

string · required

ChannelEnum

string · enum

Enum values:

sms

email - Email
sms - SMS

ClientErrorEnum

string · enum

Enum values:

client_error

client_error - Client Error

ColumnTypeEnum

string · enum

Enum values:

customer_email

product_code

quantity

customer_phone

customer_first_name

customer_last_name

customer_full_name

product_name

customer_email - Customer Email (Required)
product_code - Product Code (Required)
quantity - Quantity (Required)
customer_phone - Customer Phone (Optional)
customer_first_name - Customer First Name (Optional)
customer_last_name - Customer Last Name (Optional)
customer_full_name - Customer Full Name (splits into first + last name)
product_name - Product Name (Optional)
unit_price - Unit Price (Optional)
order_id - Order ID (Optional)
item_id - Item ID (Optional)
metadata_purchase - Custom Purchase Metadata
metadata_order - Custom Order Metadata
skip - Skip this column

CommunicationChannelEnum

string · enum

Enum values:

any

sms

pass_push

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

CommunicationTypeEnum

string · enum

Enum values:

transactional

marketing

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

ConsentCreate

organization_id

string · required

title

string · maxLength: 250 · required

type

string · enum

terms - terms
marketing - marketing
notice - notice

Enum values:

terms

marketing

notice

Default: terms

enabled

boolean

Default: true

published

boolean

Default: false

required

boolean

Default: false

object

edition_id

string | null

vendor_org_id

string | null

product_ids

string[]

ConsentDetail

id

string · readOnly · required

organization_id

string | null · readOnly · required

title

string · maxLength: 250 · required

scope

string | null · readOnly · required

published_date

string | null · date-time · readOnly · required

edition_id

string | null · readOnly · required

vendor_org_id

string | null · readOnly · required

product_ids

string[] · readOnly · required

object · required

order

integer · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

enabled

boolean

Is consent visible to new users?

published

boolean

Is consent applicable to new and existing users? Note, that published consents can't be edited.

required

boolean

Is consent required for new and existing users?

ConsentList

id

string · readOnly · required

organization_id

string | null · readOnly · required

title

string · maxLength: 250 · required

scope

string | null · readOnly · required

published_date

string | null · date-time · readOnly · required

edition_id

string | null · readOnly · required

vendor_org_id

string | null · readOnly · required

product_ids

string[] · readOnly · required

object · required

order

integer · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

enabled

boolean

Is consent visible to new users?

published

boolean

Is consent applicable to new and existing users? Note, that published consents can't be edited.

required

boolean

Is consent required for new and existing users?

CurrencyEnum

string · enum

Enum values:

eur

usd

gbp

pln

dkk

sek

nok

eur - EUR
usd - USD
gbp - GBP
pln - PLN
dkk - DKK
sek - SEK
nok - NOK

DataImport

Serializer for reading data imports with full statistics and metadata

id

string · readOnly · required

Unique identifier for the import

object · readOnly · required

Light readonly serializer for embedding in other resources.

stage

string · enum · readOnly · required

Current import stage. uploaded: File uploaded, column extraction in progress. needs_column_mapping: Columns detected, awaiting column mapping configuration. needs_product_mapping: File parsed with mappings, product assignments needed. importing: Import actively running in background. completed: Import finished successfully. failed: Import encountered an error. cancelled: Import was cancelled by user.

uploaded - Uploaded
needs_column_mapping - Needs Column Mapping
needs_product_mapping - Needs Product Mapping
importing - Importing
completed - Completed
failed - Failed
cancelled - Cancelled

Enum values:

uploaded

needs_column_mapping

needs_product_mapping

importing

completed

failed

cancelled

data_file_url

string · readOnly · required

URL to download the uploaded file

data_file_name

string · readOnly · required

Original filename of the uploaded file

readOnly · required

Import statistics including customer, product, and order counts (available in needs_product_mapping, importing, or completed stages)

product_mappings_complete

string · readOnly · required

Whether all product mappings have been assigned to products (available in needs_product_mapping, importing, or completed stages)

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

name

string · maxLength: 200

Name of the import (auto-generated from filename if not provided)

default_country_code

string | null · maxLength: 6

Default country code for phone number normalization (e.g., +45 for Denmark). If not set, uses edition's default country code.

DataImportColumnMapping

Serializer for reading column mappings detected from the imported file

id

string · readOnly · required

Unique identifier for this column mapping

column

string · readOnly · required

Column name as detected from the CSV/Excel file header

column_type

string · required

Assigned column type (e.g., customer_email, product_code, metadata_purchase, skip)

metadata_key

string | null · required

Metadata key (required when column_type is metadata_purchase or metadata_order)

order

string · readOnly · required

Column position in the file

DataImportColumnMappingItem

Serializer for a single column mapping item in update requests

id

string · required

Column mapping ID

column_type

string · enum · required

Column type to assign (e.g., 'customer_email', 'product_code', 'metadata_purchase')

customer_email - Customer Email (Required)
product_code - Product Code (Required)
quantity - Quantity (Required)
customer_phone - Customer Phone (Optional)
customer_first_name - Customer First Name (Optional)
customer_last_name - Customer Last Name (Optional)
customer_full_name - Customer Full Name (splits into first + last name)
product_name - Product Name (Optional)
unit_price - Unit Price (Optional)
order_id - Order ID (Optional)
item_id - Item ID (Optional)
metadata_purchase - Custom Purchase Metadata
metadata_order - Custom Order Metadata
skip - Skip this column

Enum values:

customer_email

product_code

quantity

customer_phone

customer_first_name

customer_last_name

customer_full_name

product_name

metadata_key

string | null

Metadata key (required for metadata_purchase and metadata_order types)

DataImportCreate

Serializer for creating new data imports

edition_id

string · required

Edition identifier where data will be imported

data_file_base64

string · writeOnly · required

Base64 encoded file content (CSV or Excel)

data_file_name

string · writeOnly · required

Original filename (e.g., 'customers.csv')

name

string · maxLength: 200

Name of the import (optional, auto-generated from filename if not provided)

default_country_code

string | null

Default country code for phone normalization (e.g., '+45' for Denmark)

DataImportOrderPreview

Serializer for a single order in the preview

email

string · email · required

phone_number

string | null · required

first_name

string | null · required

last_name

string | null · required

order_id

string | null · required

object[] · required

List of products in the order

phone_number_original

string | null

Original phone number from source before normalization

phone_number_valid

boolean

Default: true

object

Custom metadata for the order

DataImportParsedData

Serializer for parsed data statistics (without order details)

customers_total

integer · required

Total number of unique customers (by email) found in the import file

customers_existing

integer · required

Number of customers that already exist in the database (matched by email)

products_total

integer · required

Total number of unique products (by SKU) found in the import file

products_existing

integer · required

Number of products that already exist in the database (matched by SKU)

orders_total

integer · required

Total number of orders in the import file

orders_existing

integer · required

Number of orders that already exist in the database for this edition (matched by order ID)

DataImportPreviewResponse

Response serializer for preview action with pagination

total

integer · required

Total number of orders in the import

limit

integer · required

Number of orders in this response

offset

integer · required

Starting position in the full result set

object[] · required

List of orders

order_metadata_keys

string[]

List of all order metadata keys found across all orders

purchase_metadata_keys

string[]

List of all purchase metadata keys found across all products

DataImportProductMapping

Serializer for reading product mappings that link imported SKUs to database products

id

string · readOnly · required

Unique identifier for this product mapping

product_sku

string · readOnly · required

Product SKU as found in the imported file

product_name

string · readOnly · required

Product name as found in the imported file (if present)

readOnly · required

Database product assigned to this SKU (null if not yet assigned)

readOnly · required

Database product variant assigned to this SKU (null if not applicable)

quantity_in_import

string · readOnly · required

Total quantity of this SKU across all orders in the import

DataImportProductMappingItem

Serializer for a single product mapping item in update requests

id

string · required

Product mapping ID

product_id

string · required

Product API ID to assign to this SKU

variant_id

string | null

Variant API ID (optional, only for products with variants)

DataImportProductPreview

Serializer for a single product/line item in an order preview

product_name

string · required

Name of the product

product_sku

string · required

Product SKU or unique identifier

quantity

integer · required

Quantity ordered

item_id

string | null

Unique identifier for the line item, if available

unit_price

number | null · double

Unit price of the product

object

Custom metadata for this purchase (product-specific)

DataImportUpdate

Serializer for updating data import settings

name

string · maxLength: 200

Name of the import for easier identification

default_country_code

string | null · maxLength: 6

Default country code for phone number normalization (e.g., '+45' for Denmark)

DataImportValidateMappingsResponse

Response serializer for validate-mappings action

valid

boolean · required

object

DefaultCountryCodeEnum

string · enum

Enum values:

+43

+32

+45

+358

+33

+49

+31

+47

+43 - Austria (+43)
+32 - Belgium (+32)
+45 - Denmark (+45)
+358 - Finland (+358)
+33 - France (+33)
+49 - Germany (+49)
+31 - Netherlands (+31)
+47 - Norway (+47)
+48 - Poland (+48)
+46 - Sweden (+46)
+41 - Switzerland (+41)
+44 - United Kingdom (+44)
+1 - United States (+1)

DefaultLanguageEnum

string · enum

Enum values:

en - English
da - Danish
se - Swedish
nl - Dutch
pl - Polish

Edition

Light readonly serializer for embedding in other resources.

id

string · readOnly · required

full_name

string · readOnly · required

slug

string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required

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

is_draft

boolean

Draft items are not visible to end users

published_at

string | null · date-time

Timestamp when first published

EditionCreate

Serializer for creating editions - org admin/manager only.

organization_id

string · required

Organization ID (org_...)

event_id

string · required

Event ID (evt_...)

name

string · maxLength: 200 · required

Edition name

start_date

string | null · date-time

end_date

string | null · date-time

timezone

string

Default: UTC

default_country_code

string · enum

+43 - Austria (+43)
+32 - Belgium (+32)
+45 - Denmark (+45)
+358 - Finland (+358)
+33 - France (+33)
+49 - Germany (+49)
+31 - Netherlands (+31)
+47 - Norway (+47)
+48 - Poland (+48)
+46 - Sweden (+46)
+41 - Switzerland (+41)
+44 - United Kingdom (+44)
+1 - United States (+1)

Enum values:

+43

+32

+45

+358

+33

+49

+31

+47

Default: +45

default_language

string · enum

en - English
da - Danish
se - Swedish
nl - Dutch
pl - Polish

Enum values:

Default: en

enabled_languages

string[]

Enum values:

tax_type

string · enum

none - None
vat - VAT
sales - Sales tax

Enum values:

none

vat

sales

Default: none

EditionDetail

Full edition details for retrieve/update responses.

id

string · readOnly · required

name

string · maxLength: 200 · required

full_name

string · readOnly · required

slug

string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required

object · readOnly · required

readOnly · required

timezone

string · readOnly · required

status

string · readOnly · required

Date-based status: upcoming, current, past, no_dates

fee_rule_id

string | null · readOnly · required

merchant_account_id

string | null · readOnly · required

object · required

readOnly · required

meta_image_id

string | null · readOnly · required

transaction_receipt_email_id

string | null · readOnly · required

refund_confirmation_email_id

string | null · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · 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

default_country_code

string · enum

Default prefix used for phone number logins

+43 - Austria (+43)
+32 - Belgium (+32)
+45 - Denmark (+45)
+358 - Finland (+358)
+33 - France (+33)
+49 - Germany (+49)
+31 - Netherlands (+31)
+47 - Norway (+47)
+48 - Poland (+48)
+46 - Sweden (+46)
+41 - Switzerland (+41)
+44 - United Kingdom (+44)
+1 - United States (+1)

Enum values:

+43

+32

+45

+358

+33

+49

+31

+47

is_draft

boolean

Draft items are not visible to end users

is_archived

boolean

Archived editions are hidden from admin views and widgets

published_at

string | null · date-time

Timestamp when first published

array

tax_type

string · enum

none - None
vat - VAT
sales - Sales tax

Enum values:

none

vat

sales

default_price_tax_rate

number · double

default_deposit_tax_rate

number · double

default_packaging_deposit_tax_rate

number · double

merchant_account_extra_parameters

merchant_id

Overrides Organization.merchant_id for this edition's organization in split payments

metadata

Additional metadata in form of JSON object

sms_sender_name

string · enum

Unset - Unset
Preo - Preo
Store - Store

Enum values:

Unset

Preo

Store

email_sender_name

string · maxLength: 50

e.g. Sales or Jane Doe

email_sender_address

string · email · maxLength: 254

Address displayed as the sender of the email

email_reply_to

string · email · maxLength: 254

Optional reply-to address

EditionDuplicateRequest

Serializer for duplicating an edition.

name

string · maxLength: 200 · required

Name for the new edition

slug

string · maxLength: 200

Slug for the new edition (optional, auto-generated from name if not provided)

event_id

string | null

Event ID to link to (optional). Use same event, different event, or omit to leave blank.

email_template_mode

string · enum

How to handle email templates: 'copy' duplicates them, 'share' references the same templates

copy - Copy templates
share - Share templates

Enum values:

copy

Default: copy

EditionHealthcheckResponse

Serializer for the complete edition healthcheck response.

edition_id

string · required

API ID of the edition

edition_name

string · required

Full name of the edition

status

string · enum · required

Overall health status of the edition

healthy - healthy
warning - warning
critical - critical

Enum values:

healthy

warning

critical

can_publish

boolean · required

Whether the edition can be published (no critical issues)

object · required

Summary counts of failed checks by severity

object[] · required

List of all check results

EditionHealthcheckResponseStatusEnum

string · enum

Enum values:

healthy

warning

critical

healthy - healthy
warning - warning
critical - critical

EditionListItem

Serializer for list view - compact representation.

id

string · readOnly · required

name

string · maxLength: 200 · required

full_name

string · readOnly · required

slug

string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required

timezone

string · readOnly · required

object · readOnly · required

status

string · readOnly · required

Date-based status: upcoming, current, past, no_dates

created

string · date-time · readOnly · required

modified

string · date-time · 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

is_draft

boolean

Draft items are not visible to end users

is_archived

boolean

Archived editions are hidden from admin views and widgets

published_at

string | null · date-time

Timestamp when first published

EditionMeta

Response structure for _meta endpoint.

object[] · required

EditionWithRole

api_id

string · readOnly · required

sdk_id

string · readOnly · required

name

string · required

slug

string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required

role

string · enum · required

admin - Admin
manager - Manager
staff - Staff
vmanager - Vendor Manager
vstaff - Vendor Staff
guest - Guest

Enum values:

admin

manager

staff

vmanager

vstaff

guest

timezone

string · 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

array

is_draft

boolean

Draft items are not visible to end users

EditionWithRoleRoleEnum

string · enum

Enum values:

admin

manager

staff

vmanager

vstaff

guest

admin - Admin
manager - Manager
staff - Staff
vmanager - Vendor Manager
vstaff - Vendor Staff
guest - Guest

EmailBlock

Polymorphic block serializer for editor.js format. Discriminates by 'type' field.

type

string · enum · required

rich_text - Rich text
image - Image
cta_button - CTA button
magic_link - Magic link
order_summary - Order summary
refund_summary - Refund summary
user_passes - User passes
user_edition_purchases - User edition purchases
divider - Divider
custom_template - Custom template

Enum values:

rich_text

image

cta_button

magic_link

order_summary

refund_summary

user_passes

user_edition_purchases

object · required

id

string | null

Module API ID (for existing modules)

EmailBlockTypeEnum

string · enum

Enum values:

rich_text

image

cta_button

magic_link

order_summary

refund_summary

user_passes

user_edition_purchases

rich_text - Rich text
image - Image
cta_button - CTA button
magic_link - Magic link
order_summary - Order summary
refund_summary - Refund summary
user_passes - User passes
user_edition_purchases - User edition purchases
divider - Divider
custom_template - Custom template

EmailMessageAdopt

Serializer for adopting (copying) an org template to an edition

edition_id

string · required

Target edition to adopt the template into

title

string · maxLength: 200

New title (optional)

EmailMessageCreate

Serializer for creating email messages

organization_id

string · required

title

string · maxLength: 200 · required

object · required

type

string · enum · required

receipt - Purchase receipt
receipt_online - Purchase receipt (online)
reminder - Purchase reminder
refund_confirmation - Refund confirmation
user_portal_access - User portal access
campaign - Campaign
other - Other

Enum values:

receipt

receipt_online

reminder

refund_confirmation

user_portal_access

campaign

other

edition_id

string | null

scope

string · enum

template - Template
edition - Edition

Enum values:

template

edition

Default: edition

template

string · enum

modern - Modern

Enum values:

modern

Default: modern

EmailMessageCreateScopeEnum

string · enum

Enum values:

template

edition

template - Template
edition - Edition

EmailMessageDetail

Serializer for detail view with nested modules

id

string · readOnly · required

title

string · maxLength: 200 · required

subject

string · readOnly · required

type

string · enum · required

receipt - Purchase receipt
receipt_online - Purchase receipt (online)
reminder - Purchase reminder
refund_confirmation - Refund confirmation
user_portal_access - User portal access
campaign - Campaign
other - Other

Enum values:

receipt

receipt_online

reminder

refund_confirmation

user_portal_access

campaign

other

object · readOnly · required

readOnly · required

object[] · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

scope

string · enum

platform - Platform
template - Template
edition - Edition

Enum values:

platform

template

edition

template

string · enum

modern - Modern

Enum values:

modern

EmailMessageDuplicate

Serializer for duplicate request

edition_id

string | null

Target edition (optional, creates org-level copy if omitted)

title

string · maxLength: 200

New title (optional)

EmailMessageList

Serializer for list view of email messages

id

string · readOnly · required

title

string · maxLength: 200 · required

type

string · enum · required

receipt - Purchase receipt
receipt_online - Purchase receipt (online)
reminder - Purchase reminder
refund_confirmation - Refund confirmation
user_portal_access - User portal access
campaign - Campaign
other - Other

Enum values:

receipt

receipt_online

reminder

refund_confirmation

user_portal_access

campaign

other

object · readOnly · required

readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

scope

string · enum

platform - Platform
template - Template
edition - Edition

Enum values:

platform

template

edition

template

string · enum

modern - Modern

Enum values:

modern

locked

boolean

Locked by a scheduled campaign — edits not allowed

EmailMessagePreview

Serializer for preview request

mode

string · enum

mjml - mjml
html - html

Enum values:

mjml

html

Default: mjml

Language code to render the preview in (e.g. 'da', 'en'). Uses default if not set.

en - en
da - da
se - se
pl - pl
nl - nl

object

Mock context for template variables

object[]

Optional blocks to preview without saving

object

Optional subject override for preview

EmailMessagePreviewResponse

Serializer for preview response

html

string · required

subject

string · required

EmailModuleBase

Base serializer for all email modules

id

string · readOnly · required

type

string · enum · readOnly · required

rich_text - Rich text
image - Image
cta_button - CTA button
magic_link - Magic link
order_summary - Order summary
refund_summary - Refund summary
user_passes - User passes
user_edition_purchases - User edition purchases
divider - Divider
custom_template - Custom template

Enum values:

rich_text

image

cta_button

magic_link

order_summary

refund_summary

user_passes

user_edition_purchases

object · readOnly · required

EmailScopeEnum

string · enum

Enum values:

platform

template

edition

platform - Platform
template - Template
edition - Edition

EmailTemplateModeEnum

string · enum

Enum values:

copy

copy - Copy templates
share - Share templates

EnabledLanguagesEnum

string · enum

Enum values:

en - English
da - Danish
se - Swedish
nl - Dutch
pl - Polish

Error403

code

string · enum · required

permission_denied - Permission Denied

Enum values:

permission_denied

detail

string · required

attr

string | null · required

Error404

code

string · enum · required

not_found - Not Found

Enum values:

not_found

detail

string · required

attr

string | null · required

ErrorCode403Enum

string · enum

Enum values:

permission_denied

permission_denied - Permission Denied

ErrorCode404Enum

string · enum

Enum values:

not_found

not_found - Not Found

ErrorResponse403

type

string · enum · required

client_error - Client Error

Enum values:

client_error

object[] · required

ErrorResponse404

type

string · enum · required

client_error - Client Error

Enum values:

client_error

object[] · required

EventSimple

Minimal Event serializer for Edition detail view.

id

string · readOnly · required

name

string · maxLength: 200 · required

EventsEnum

string · enum

Enum values:

consent.given

consent.skipped

consent.withdrawn

consent.expired

purchase.action

wallet.apple.pass-added

wallet.apple.pass-removed

wallet.google.pass-added

consent.given - User gave consent
consent.skipped - User skipped consent
consent.withdrawn - User withdrew consent
consent.expired - User consent expired
purchase.action - Purchase action executed
wallet.apple.pass-added - Apple Wallet pass added
wallet.apple.pass-removed - Apple Wallet pass removed
wallet.google.pass-added - Google Wallet pass added
wallet.google.pass-removed - Google Wallet pass removed
cart.updated - Cart updated
cart.coupon - Coupon applied to cart
cart.abandoned - Cart abandoned
cart.expired - Cart expired due to reservation timeout
cart.reservation-created - Cart reservation created for stock-limited item
order.created - Order created
order.confirmed - Order confirmed
order.completed - Order completed
order.cancelled - Order cancelled
transaction.started - Transaction started
transaction.failed - Transaction failed
transaction.completed - Transaction completed
transaction.cancelled - Transaction cancelled
transaction.imported - Transaction imported
transaction.receipt-resend - Transaction receipt resend requested
refund-request.created - Refund request created
refund-request.processed - Refund request processed
refund-request.failed - Refund request failed
auth.signup - User signed up
auth.login - User logged in
user.auth-request - User authentication request
staff.device-registered - Staff: Device registered
staff.customer-created - Staff: Customer created
staff.customer-edited - Staff: Customer edited
product.sold-out - Product sold out
product.variant-sold-out - Product variant sold out
purchase.vendor-code-assigned - Product vendor code assigned
campaign.scheduled - Campaign scheduled
campaign.sending - Campaign sending started
campaign.sent - Campaign sent
campaign.failed - Campaign failed
campaign.cancelled - Campaign cancelled
campaign.unsubscribed - User unsubscribed from campaign

ExternalOrder

Serializer for external order data.

email

string · email · required

Customer email address

order_id

string · maxLength: 64 · required

External order identifier (used for deduplication)

object[] · required

List of order line items

phone_number

string | null · maxLength: 20

Customer phone number

first_name

string | null · maxLength: 150

Customer first name

last_name

string | null · maxLength: 150

Customer last name

Optional metadata to attach to the order

ExternalOrderImportRequest

Request serializer for importing external orders.

edition_id

string · maxLength: 255 · required

Edition API ID (edt_xxx)

object[] · required

List of orders to import

ExternalOrderImportResponse

Response serializer for order import.

status

string · enum · required

Import status

queued - queued

Enum values:

queued

queued_count

integer · required

Number of orders queued for processing

skipped_count

integer · required

Number of orders skipped (duplicates)

skipped_order_ids

string[] · required

List of order_ids that were skipped as duplicates

ExternalOrderImportResponseStatusEnum

string · enum

Enum values:

queued

queued - queued

ExternalOrderLineItem

Serializer for a single line item in an external order import.

product_id

string · maxLength: 255 · required

Product API ID (prod_xxx)

quantity

integer · min: 1 · required

Quantity of this item

price

number · double · required

Price paid for this item (per unit)

variant_id

string | null · maxLength: 255

Optional variant API ID (var_xxx)

option_ids

array | null

Optional list of product option API IDs

Optional metadata to attach to the purchase

FileDetail

Serializer for file detail view with usage information.

api_id

string · readOnly · required

file_name

string · maxLength: 1000 · required

organization_id

string | null · readOnly · required

object · readOnly · required

file_url

string · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

object · readOnly · required

Models and instances using this file

image_alt_text

string · maxLength: 1000

caption

string · maxLength: 1000

copyright

string · maxLength: 1000

tags

string[]

FileList

Serializer for listing files with basic information.

api_id

string · readOnly · required

file_name

string · maxLength: 1000 · required

organization_id

string | null · readOnly · required

object · readOnly · required

file_url

string · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

image_alt_text

string · maxLength: 1000

caption

string · maxLength: 1000

copyright

string · maxLength: 1000

tags

string[]

FileUpload

Serializer for uploading files. Supports both multipart and base64 uploads.

api_id

string · readOnly · required

organization_id

string · required

file

string · uri · writeOnly

file_base64

string · writeOnly

file_name

string

tags

string[]

HealthcheckRelatedObject

Serializer for related objects with minimal info.

id

string · required

API ID of the related object

name

string · required

Human-readable name of the object

HealthcheckResultItem

Serializer for individual healthcheck results.

category

string · required

Category of the check (email, product, payment, etc.)

check_id

string · required

Unique identifier for this check

severity

string · enum · required

Severity level: critical, warning, or info

critical - critical
warning - warning
info - info

Enum values:

critical

warning

info

passed

boolean · required

Whether the check passed

message

string · required

Human-readable message describing the check result

suggestion

string | null

Suggested action to fix the issue

array | null

Related objects affected by this check

HealthcheckSummary

Serializer for healthcheck summary counts.

critical

integer · required

Number of failed critical checks

warning

integer · required

Number of failed warning checks

info

integer · required

Number of failed info checks

Image

thumbnail

string · uri

optimized

string · uri

large

string · uri

original

string · uri

LanguageEnum

string · enum

Enum values:

en - en
da - da
se - se
pl - pl
nl - nl

MembershipInfoResponse

object · required

Staff user serializer for nested representations

object[] · required

MerchantAccountMetaChoice

Choice entry for merchant account selector, includes payment provider type.

value

string · required

label

string · required

type

string · required

description

string

supported_currencies

string[]

MetaChoice

Generic choice entry with value/label/description for meta endpoints.

value

string · required

label

string · required

description

string

ModeEnum

string · enum

Enum values:

mjml

html

mjml - mjml
html - html

NullEnum

null

OrderCartDetail

Detailed cart serializer for order detail view.

id

string · readOnly · required

object[] · readOnly · required

coupon_code

string | null · readOnly · required

subtotal

number · double · readOnly · required

deposit

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

object · readOnly · required

created

string · date-time · 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

OrderCartDetailStatusEnum

string · enum

Enum values:

created

awaiting_payment

paid

abandoned

expired

created - created
awaiting_payment - awaiting payment
paid - paid
abandoned - abandoned
expired - expired

OrderCartItemDetail

Detailed cart item serializer for order detail view.

id

string · readOnly · required

object · readOnly · required

Simple product serializer for nested representations

readOnly · required

object[] · readOnly · required

price_with_options

number · double · readOnly · required

deposit_with_options

number · double · readOnly · required

handling_fee

number · double · readOnly · required

quantity

integer · min: -2147483648 · max: 2147483647

OrderDetail

Full order serializer for detail view.

id

string · readOnly · required

object · readOnly · required

Light readonly serializer for embedding in other resources.

amount

number · double · min: 0 · readOnly · required

currency

string · enum · readOnly · required

eur - EUR
usd - USD
gbp - GBP
pln - PLN
dkk - DKK
sek - SEK
nok - NOK

Enum values:

eur

usd

gbp

pln

dkk

sek

nok

readOnly · required

object · readOnly · required

Detailed user serializer with full customer profile

object[] · readOnly · required

completed_transaction_id

string | null · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

order_number

string | null · maxLength: 16

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

metadata

OrderListItem

Compact order serializer for list view.

id

string · readOnly · required

object · readOnly · required

Light readonly serializer for embedding in other resources.

amount

number · double · min: 0 · readOnly · required

currency

string · enum · readOnly · required

eur - EUR
usd - USD
gbp - GBP
pln - PLN
dkk - DKK
sek - SEK
nok - NOK

Enum values:

eur

usd

gbp

pln

dkk

sek

nok

customer_name

string | null · readOnly · required

customer_email

string | null · readOnly · required

items_count

integer · readOnly · required

has_payment

boolean · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

order_number

string | null · maxLength: 16

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

OrderPurchaseDetail

Detailed purchase serializer for order detail view.

id

string · readOnly · required

object · readOnly · required

Simple product serializer for nested representations

readOnly · required

object[] · readOnly · required

object · readOnly · required

Simple user serializer for nested representations

price_paid

number · double · readOnly · required

deposit_paid

number · double · readOnly · required

handling_fee_paid

number · double · readOnly · required

max_available_refund_amount

number · double · min: 0 · readOnly · required

available_uses

integer | null · readOnly · required

is_unlimited_use

boolean · readOnly · required

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

vendor_code

string | null · maxLength: 250

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

Organization

id

string · readOnly · required

name

string · maxLength: 100 · required

slug

string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required

object · required

OrganizationWithAccess

api_id

string · readOnly · required

name

string · maxLength: 100 · required

slug

string · readOnly · pattern: ^[-a-zA-Z0-9_]+$ · required

object · required

required

is_default

boolean · readOnly · required

object[] · required

OrganizationWithAccessRoleEnum

string · enum

Enum values:

admin

manager

staff

guest

admin - Admin
manager - Manager
staff - Staff
guest - Guest

PaginatedCampaignListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedConsentListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedDataImportColumnMappingList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedDataImportList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedDataImportProductMappingList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedEditionListItemList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedEmailMessageListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedFileListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

available_tags

string[]

All available tags from accessible files

PaginatedOrderListItemList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedRefundRequestListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedSegmentListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedUserListResponseList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedWebhookDeliveryListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

PaginatedWebhookEndpointListList

count

integer · required

object[] · required

next

string · uri

previous

string · uri

ParseError

code

string · enum · required

parse_error - Parse Error

Enum values:

parse_error

detail

string · required

attr

string | null · required

ParseErrorCodeEnum

string · enum

Enum values:

parse_error

parse_error - Parse Error

ParseErrorResponse

type

string · enum · required

client_error - Client Error

Enum values:

client_error

object[] · required

PatchedCampaignUpdate

name

string · maxLength: 255

segment_id

string

channel

string · enum

email - Email
sms - SMS

Enum values:

sms

email_message_id

string | null

object

PatchedConsentUpdate

title

string · maxLength: 250

type

string · enum

terms - terms
marketing - marketing
notice - notice

Enum values:

terms

marketing

notice

enabled

boolean

published

boolean

required

boolean

object

edition_id

string | null

vendor_org_id

string | null

product_ids

string[]

PatchedDataImportColumnMappingUpdate

Serializer for updating column mappings

object[]

List of column mappings to update

PatchedDataImportProductMappingUpdate

Serializer for updating product mappings

object[]

List of product mappings to update

PatchedDataImportUpdate

Serializer for updating data import settings

name

string · maxLength: 200

Name of the import for easier identification

default_country_code

string | null · maxLength: 6

Default country code for phone number normalization (e.g., '+45' for Denmark)

PatchedEditionUpdate

Serializer for updating editions - edition admin/manager only.

name

string · maxLength: 200

start_date

string | null · date-time

end_date

string | null · date-time

timezone

string

default_country_code

string · enum

+43 - Austria (+43)
+32 - Belgium (+32)
+45 - Denmark (+45)
+358 - Finland (+358)
+33 - France (+33)
+49 - Germany (+49)
+31 - Netherlands (+31)
+47 - Norway (+47)
+48 - Poland (+48)
+46 - Sweden (+46)
+41 - Switzerland (+41)
+44 - United Kingdom (+44)
+1 - United States (+1)

Enum values:

+43

+32

+45

+358

+33

+49

+31

+47

is_draft

boolean

is_archived

boolean

default_language

string · enum

en - English
da - Danish
se - Swedish
nl - Dutch
pl - Polish

Enum values:

enabled_languages

string[]

Enum values:

tax_type

string · enum

none - None
vat - VAT
sales - Sales tax

Enum values:

none

vat

sales

default_price_tax_rate

number · double

default_deposit_tax_rate

number · double

default_packaging_deposit_tax_rate

number · double

fee_rule_id

string | null

merchant_account_id

string | null

object

metadata

sms_sender_name

string · enum

Unset - Unset
Preo - Preo
Store - Store

Enum values:

Unset

Preo

Store

email_sender_name

string | null · maxLength: 50

email_sender_address

string | null · email

email_reply_to

string | null · email

object

meta_image_id

string | null

transaction_receipt_email_id

string | null

refund_confirmation_email_id

string | null

PatchedEmailMessageUpdate

Serializer for updating email message metadata and optionally content blocks

title

string · maxLength: 200

object

type

string · enum

receipt - Purchase receipt
receipt_online - Purchase receipt (online)
reminder - Purchase reminder
refund_confirmation - Refund confirmation
user_portal_access - User portal access
campaign - Campaign
other - Other

Enum values:

receipt

receipt_online

reminder

refund_confirmation

user_portal_access

campaign

other

scope

string · readOnly

template

string · enum

modern - Modern

Enum values:

modern

object[]

PatchedFileUpdate

Serializer for updating file metadata (alt-text, caption, copyright, tags).

image_alt_text

string · maxLength: 1000

caption

string · maxLength: 1000

copyright

string · maxLength: 1000

tags

string[]

PatchedSegmentUpdate

name

string · maxLength: 255

Human-readable segment name

description

string

Optional description of the segment

edition_id

string | null

consent_id

string | null

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

condition

string

CEL expression to evaluate segment membership

PatchedUserUpdateRequest

email

string · email

phone_number

string

first_name

string

last_name

string

PatchedWebhookEndpointUpdate

name

string · maxLength: 120

Descriptive name for this webhook

url

string · uri · maxLength: 200

The endpoint URL to send webhook payloads to

edition_id

string | null

events

string[]

List of events this webhook should receive

Enum values:

consent.given

consent.skipped

consent.withdrawn

consent.expired

purchase.action

wallet.apple.pass-added

wallet.apple.pass-removed

wallet.google.pass-added

is_active

boolean

timeout_seconds

integer · min: 0 · max: 2147483647

Request timeout in seconds

PickupPointSimple

Simple pickup point serializer for nested representations

api_id

string · readOnly · required

name

string · maxLength: 80 · required

is_draft

boolean

Draft items are not visible to end users

ProductOptionSimple

Simple product option serializer for nested representations

api_id

string · readOnly · required

name

string · maxLength: 120

price_mod

number · double

deposit_mod

number · double

ProductSimple

Simple product serializer for nested representations

api_id

string · readOnly · required

object[] · readOnly · required

name

string · maxLength: 120

is_draft

boolean

Draft items are not visible to end users

PurchaseRefund

Serializer for creating refund requests via purchase context. Used with: POST /api/backoffice/purchases/{purchaseId}/refund/ The API is reason-driven: - reason is REQUIRED - scope is auto-derived from reason, but can be overridden (if allowed) - amount is auto-calculated for non-custom scopes

reason

string · enum · required

Business reason for the refund (REQUIRED)

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

Scope of refund (optional - auto-derived from reason, can be overridden if allowed)

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

amount

number | null · double

Refund amount (required for CUSTOM scope, calculated automatically for others)

comment

string

Optional comment explaining the refund reason

Default:

pickup_point_id

string | null

Pickup point where refund is processed

PurchaseSimple

Simple purchase serializer for nested representations

api_id

string · readOnly · required

object · readOnly · required

Simple product serializer for nested representations

object · readOnly · required

Simple user serializer for nested representations

metadata

readOnly · required

vendor_code

string | null · maxLength: 250

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

variant

string | null

ReasonEnum

string · enum

Enum values:

deposit_reclaim

sold_out

event_cancelled

product_defect

duplicate_purchase

customer_request

compensation

overcharge

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

RefundCreate

General-purpose serializer for creating refund requests. Used with: POST /v1/refunds/ Accepts either purchase_id or transaction_id (exactly one required).

reason

string · enum · required

Business reason for the refund

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

purchase_id

string | null

Purchase to refund (mutually exclusive with transaction_id)

transaction_id

string | null

Transaction to refund (mutually exclusive with purchase_id)

Scope of refund (optional - auto-derived from reason)

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

amount

number | null · double

Refund amount (required for CUSTOM scopes, calculated automatically for others)

comment

string

Optional comment explaining the refund reason

Default:

pickup_point_id

string | null

Pickup point where refund is processed

RefundRequest

id

string · readOnly · required

edition_id

string · readOnly · required

readOnly · required

amount

number · double · required

object · readOnly · required

Staff user serializer for nested representations

object · readOnly · required

Simple pickup point serializer for nested representations

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

can_approve

string · readOnly · required

can_reject

string · readOnly · required

organization

string | null

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

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

comment

string | null

Comment added upon custom refund

service_response

refund_date

string | null · date-time

Date when refund was successfully processed

RefundRequestList

id

string · readOnly · required

edition_id

string · readOnly · required

purchase_id

string · readOnly · required

transaction_id

string · readOnly · required

product_name

string · readOnly · required

amount

number · double · required

staff_user_name

string · readOnly · required

created

string · date-time · readOnly · required

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

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

comment

string | null

Comment added upon custom refund

refund_date

string | null · date-time

Date when refund was successfully processed

RefundScopeEnum

string · enum

Enum values:

purchase_price

purchase_deposit

purchase_full

purchase_custom

transaction_full

transaction_custom

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

SegmentCreate

organization_id

string · required

name

string · maxLength: 255 · required

Human-readable segment name

edition_id

string | null

consent_id

string | null

description

string

Optional description of the segment

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

condition

string

CEL expression to evaluate segment membership

SegmentDetail

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

condition

string

CEL expression to evaluate segment membership

calculation_duration

string | null

How long the last calculation took

error_message

string

Error details if calculation failed

SegmentList

id

string · readOnly · required

organization_id

string | null · readOnly · required

edition_id

string | null · readOnly · required

consent_id

string | null · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

description

string

Optional description of the segment

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

last_calculated

string | null · date-time

When segment was last calculated

SegmentSummary

id

string · readOnly · required

name

string · maxLength: 255 · required

Human-readable segment name

communication_type

string · enum

Type of communication - determines user eligibility for compliance

transactional - Transactional (service updates, receipts, etc.)
marketing - Marketing (promotions, campaigns - requires consent)

Enum values:

transactional

marketing

communication_channel

string · enum

Communication channel - filters users by delivery capability

any - Any available channel
email - Email (users with valid email addresses)
sms - SMS (users with valid phone numbers)
pass_push - Pass Push (users with active wallet passes)

Enum values:

any

sms

pass_push

status

string · enum

Current calculation status

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

Enum values:

draft

pending

processing

completed

failed

user_count

integer · min: 0 · max: 2147483647

Cached count of users in segment for performance

ServiceEnum

string · enum

Enum values:

shopify

billetten

custom

shopify - Shopify (Legacy)
billetten - Billetten (Legacy)
custom - Custom

SeverityEnum

string · enum

Enum values:

critical

warning

info

critical - critical
warning - warning
info - info

SmsSenderNameEnum

string · enum

Enum values:

Unset

Preo

Store

Unset - Unset
Preo - Preo
Store - Store

StaffUser

Staff user serializer for nested representations

id

string · readOnly · required

full_name

string · readOnly · required

Returns the full name of the user.

avatar

string · uri · readOnly · required

has_custom_avatar

boolean · readOnly · required

email

string · email · maxLength: 254

first_name

string · maxLength: 30

last_name

string · maxLength: 30

phone_number

string | null · maxLength: 32

Including prefix, without +, e.g. 48555666777 for PL or 4566114422 for DK.

StageEnum

string · enum

Enum values:

uploaded

needs_column_mapping

needs_product_mapping

importing

completed

failed

cancelled

uploaded - Uploaded
needs_column_mapping - Needs Column Mapping
needs_product_mapping - Needs Product Mapping
importing - Importing
completed - Completed
failed - Failed
cancelled - Cancelled

Status3f6Enum

string · enum

Enum values:

requested

ready

processing

awaiting_gateway

processed

failed

rejected

invalid

requested - requested
ready - ready
processing - processing
awaiting_gateway - awaiting gateway
processed - processed
failed - failed
rejected - rejected
invalid - invalid

Status4aaEnum

string · enum

Enum values:

pending

success

failed

retrying

exhausted

pending - Pending
success - Success
failed - Failed
retrying - Retrying
exhausted - Exhausted

Status577Enum

string · enum

Enum values:

paid

collected

in-use

used

rented

checked-in

checked-out

returned

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

StatusAe8Enum

string · enum

Enum values:

draft

scheduled

calculating

sending

sent

failed

cancelled

draft - Draft
scheduled - Scheduled
calculating - Calculating Segment
sending - Sending
sent - Sent
failed - Failed
cancelled - Cancelled

StatusB36Enum

string · enum

Enum values:

pending

confirmed

completed

cancelled

pending - Pending
confirmed - Confirmed
completed - Completed
cancelled - Cancelled

StatusD0bEnum

string · enum

Enum values:

draft

pending

processing

completed

failed

draft - Draft
pending - Pending Calculation
processing - Processing
completed - Completed
failed - Failed

SummaryLine

key

string · required

label

string · required

amount

number · double · required

formatted

string · required

is_negative

boolean · required

is_total

boolean · required

note

string | null · required

TaxTypeEnum

string · enum

Enum values:

none

vat

sales

none - None
vat - VAT
sales - Sales tax

TemplateEnum

string · enum

Enum values:

modern

modern - Modern

TemplateVariable

Serializer for a single template variable

variable

string · required

description

string

TemplateVariableCategory

Serializer for template variable category

name

string · required

object[] · required

TemplateVariablesResponse

Serializer for template variables response

object[] · required

TransactionSimple

Simple transaction serializer for nested representations

id

string · readOnly · required

service

string · readOnly · required

amount

number · double · min: 0 · readOnly · required

currency

string · enum · readOnly · required

eur - EUR
usd - USD
gbp - GBP
pln - PLN
dkk - DKK
sek - SEK
nok - NOK

Enum values:

eur

usd

gbp

pln

dkk

sek

nok

refunded_amount

number · double · min: 0 · readOnly · required

available_refund_amount

number · double · min: 0 · readOnly · required

created

string · date-time · readOnly · 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

service_fee

number · double

Service fee from TransactionFeeRule

handling_fee

number · double

Sum of fees from ProductFeeRules

TransactionStatusEnum

string · enum

Enum values:

pending

started

processing

completed

failed

cancelled

pending - pending
started - started
processing - processing
completed - completed
failed - failed
cancelled - cancelled

TransactionTypeEnum

string · enum

Enum values:

online

in-person

imported

online - Online
in-person - In Person
imported - Imported

TranslatedDict

en

string

da

string

se

string

pl

string

nl

string

Type964Enum

string · enum

Enum values:

terms

marketing

notice

terms - terms
marketing - marketing
notice - notice

TypeF65Enum

string · enum

Enum values:

receipt

receipt_online

reminder

refund_confirmation

user_portal_access

campaign

other

receipt - Purchase receipt
receipt_online - Purchase receipt (online)
reminder - Purchase reminder
refund_confirmation - Refund confirmation
user_portal_access - User portal access
campaign - Campaign
other - Other

UserDetail

Detailed user serializer with full customer profile

api_id

string · readOnly · required

full_name

string · readOnly · required

email

string | null · email · maxLength: 254

phone_number

string | null · maxLength: 32

date_joined

string | null · date-time

last_seen

string | null · date-time

metadata

UserListResponse

id

string · readOnly · required

email

string · email · required

locale

string · readOnly · required

msg_channel

string | null · readOnly · required

date_joined

string · date-time · readOnly · required

phone_number

string | null · maxLength: 32

first_name

string · maxLength: 80

last_name

string · maxLength: 80

is_verified

boolean

is_active

boolean

last_seen

string | null · date-time

metadata

UserSimple

Simple user serializer for nested representations

api_id

string · readOnly · required

full_name

string · readOnly · required

email

string | null · email · maxLength: 254

ValidateCEL

condition

string · required

ValidateCELResponse

valid

boolean · required

error

string | null · required

VariantSimple

Simple product serializer for nested representations

api_id

string · readOnly · required

name

string · maxLength: 120

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

WebhookDeliveryDetail

id

string · readOnly · required

event

string · readOnly · required

created

string · date-time · readOnly · required

endpoint_id

string · readOnly · required

payload

string · required

The payload that was/will be sent (JSON string)

status

string · enum

pending - Pending
success - Success
failed - Failed
retrying - Retrying
exhausted - Exhausted

Enum values:

pending

success

failed

retrying

exhausted

attempts

integer · min: 0 · max: 2147483647

response_status_code

integer | null · min: 0 · max: 2147483647

last_attempt_at

string | null · date-time

next_retry_at

string | null · date-time

signature

string · maxLength: 64

HMAC signature

WebhookDeliveryList

id

string · readOnly · required

event

string · readOnly · required

created

string · date-time · readOnly · required

status

string · enum

pending - Pending
success - Success
failed - Failed
retrying - Retrying
exhausted - Exhausted

Enum values:

pending

success

failed

retrying

exhausted

attempts

integer · min: 0 · max: 2147483647

response_status_code

integer | null · min: 0 · max: 2147483647

last_attempt_at

string | null · date-time

next_retry_at

string | null · date-time

WebhookEndpointCreate

organization_id

string · required

name

string · maxLength: 120 · required

Descriptive name for this webhook

url

string · uri · maxLength: 200 · required

The endpoint URL to send webhook payloads to

events

string[] · required

List of events this webhook should receive

Enum values:

consent.given

consent.skipped

consent.withdrawn

consent.expired

purchase.action

wallet.apple.pass-added

wallet.apple.pass-removed

wallet.google.pass-added

edition_id

string | null

is_active

boolean

timeout_seconds

integer · min: 0 · max: 2147483647

Request timeout in seconds

WebhookEndpointDetail

id

string · readOnly · required

organization_id

string | null · readOnly · required

name

string · maxLength: 120 · required

Descriptive name for this webhook

url

string · uri · maxLength: 200 · required

The endpoint URL to send webhook payloads to

edition_id

string | null · readOnly · required

events

string[] · required

List of events this webhook should receive

Enum values:

consent.given

consent.skipped

consent.withdrawn

consent.expired

purchase.action

wallet.apple.pass-added

wallet.apple.pass-removed

wallet.google.pass-added

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

is_active

boolean

timeout_seconds

integer · min: 0 · max: 2147483647

Request timeout in seconds

secret

string · maxLength: 64

Secret key for HMAC signature verification (optional)

WebhookEndpointList

id

string · readOnly · required

organization_id

string | null · readOnly · required

name

string · maxLength: 120 · required

Descriptive name for this webhook

url

string · uri · maxLength: 200 · required

The endpoint URL to send webhook payloads to

edition_id

string | null · readOnly · required

events

string[] · required

List of events this webhook should receive

Enum values:

consent.given

consent.skipped

consent.withdrawn

consent.expired

purchase.action

wallet.apple.pass-added

wallet.apple.pass-removed

wallet.google.pass-added

created

string · date-time · readOnly · required

modified

string · date-time · readOnly · required

is_active

boolean

timeout_seconds

integer · min: 0 · max: 2147483647

Request timeout in seconds