Schemas

BlankEnum

CartItemObjectPayload

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

CartObjectPayloadStatusEnum

string · enum

Enum values:

created

awaiting_payment

paid

abandoned

expired

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

CentrifugoCredentials

ws_url

string · uri · required

channel

string · required

token

string · required

ContentsEnum

string · enum

Enum values:

customer_card

customer_card - Customer Card

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

CouponObjectPayloadTypeEnum

string · enum

Enum values:

regular

staff

imported

regular - regular
staff - staff
imported - imported

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

CustomerLookupRequest

email

string · email · required

org_id

string

NullEnum

null

OrderSerializerUser

id

string · readOnly · required

edition

string · readOnly · required

edition_id

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

purchase_ids

string[] · readOnly · required

object[] · 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

amount

number | null · double

metadata

OrderSerializerUserStatusEnum

string · enum

Enum values:

pending

confirmed

completed

cancelled

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

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

PurchaseSerializerUser

id

string · readOnly · required

edition

string · readOnly · required

edition_id

string · readOnly · required

order_id

string | null · readOnly · required

transaction_id

string | null · readOnly · required

product

string · required

product_type

string · required

variant_metadata

readOnly · required

metadata

readOnly · required

available_uses

integer | null · readOnly · required

available_uses_today

integer · readOnly · required

Number of uses of this product available today

is_unlimited_use

boolean · readOnly · required

price_paid

number · double · readOnly · required

deposit_paid

number · double · readOnly · required

handling_fee_paid

number · double · readOnly · required

purchased_date

string · date-time · required

variant

string | null

options

string[]

code

string · maxLength: 40

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

PurchaseSerializerUserStatusEnum

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

ServedFromEnum

string · enum

Enum values:

cache

origin

cache - cache
origin - origin

TransactionSerializerUser

id

string · readOnly · required

service

string · readOnly · required

amount

number · double · required

created

string · date-time · readOnly · required

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

UserProfile

id

string · required

email

string | null · email · required

first_name

string | null · required

last_name

string | null · required

phone_number

string | null · required

locale

string · required

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

WalletCacheMetadata

served_from

string · enum · required

cache - cache
origin - origin

Enum values:

cache

origin

served_at

string · date-time · required

WalletPass

id

string · readOnly · required

edition

string | null · readOnly · required

edition_id

string | null · readOnly · required

apple_url

string · readOnly · required

google_url

string · readOnly · required

object · readOnly · required

contents

string · enum

customer_card - Customer Card

Enum values:

customer_card

serial_number

string · maxLength: 128

WalletPassDesign

id

string · readOnly · required

name

string · readOnly · required

WalletResponse

object · required

object[] · required

object · required

CartItemObjectPayload

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

OrderSerializerUser

id

string · readOnly · required

edition

string · readOnly · required

edition_id

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

purchase_ids

string[] · readOnly · required

object[] · 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

amount

number | null · double

metadata

PurchaseSerializerUser

id

string · readOnly · required

edition

string · readOnly · required

edition_id

string · readOnly · required

order_id

string | null · readOnly · required

transaction_id

string | null · readOnly · required

product

string · required

product_type

string · required

variant_metadata

readOnly · required

metadata

readOnly · required

available_uses

integer | null · readOnly · required

available_uses_today

integer · readOnly · required

Number of uses of this product available today

is_unlimited_use

boolean · readOnly · required

price_paid

number · double · readOnly · required

deposit_paid

number · double · readOnly · required

handling_fee_paid

number · double · readOnly · required

purchased_date

string · date-time · required

variant

string | null

options

string[]

code

string · maxLength: 40

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

PurchaseSerializerUserStatusEnum

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

TransactionSerializerUser

id

string · readOnly · required

service

string · readOnly · required

amount

number · double · required

created

string · date-time · readOnly · required

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

WalletPass

id

string · readOnly · required

edition

string | null · readOnly · required

edition_id

string | null · readOnly · required

apple_url

string · readOnly · required

google_url

string · readOnly · required

object · readOnly · required

contents

string · enum

customer_card - Customer Card

Enum values:

customer_card

serial_number

string · maxLength: 128