Skip to content

The Order entity at YouCan.

Attribute NameTypeDescription
idstringIdentifier (UUID)
refstringHuman-readable order reference number
totalfloatOrder total (in store currency)
vatfloatVAT amount
currencystringStore currency code
customer_currencystringCurrency the customer used at checkout
customer_currency_ratefloatExchange rate between customer currency and store currency
notesstring, nullInternal seller notes
statusintConfirmation status integer value
status_newstringConfirmation status as a translated label
status_objectobjectFull status object with slug, name, color
payment_statusintPayment status integer value
payment_status_newstringPayment status as a translated label
confirmation_statusintConfirmation status integer value
shipping_statusintShipping status integer value
tagsarrayTags assigned to the order
extra_fieldsarrayExtra checkout fields collected at order time
custom_fieldsarrayCustom fields defined by the merchant
is_refunded_by_platformboolWhether the order was refunded through the platform
platform_feefloatPlatform fee deducted from the order
created_atstringOrder creation date (ISO 8601)
updated_atstringLast update date (ISO 8601)
links.showstringURL to view the order in the seller area