Headers

• Account-ID string(uuid) Required

  Account ID - Can be found on the Dashboard under Settings → API Tokens

Path parameters

• order string(uuid) Required

Responses

• 201 application/json

  Note added

  Hide response attribute Show response attribute object

  • data object

    Represents a customer order containing transaction details, vouchers, and redeemables

    Hide data attributes Show data attributes object

    • id string(uuid)

      Unique identifier for the order. Internal use only - not displayed to customers. Use this ID for API operations like retrieving order details, adding notes, or resending vouchers.

    • is_live boolean

      Indicates if this is a live (production) order (true) or a test order (false). Test orders are used for testing and training purposes and don't affect reporting or billing.

    • is_imported boolean

      Indicates if this order was imported from an external system rather than created through Enjovia checkout or terminal. Imported orders may have limited edit capabilities and different validation rules.

    • reference string

      Human-readable order reference number for tracking, customer service, and order lookup. Displayed to: Internal staff in dashboard, exports, and reports. Shown to buyers.

    • custom_checkout_fields object
    • tags object

      Key-value pairs for categorizing and filtering orders. Generated from store, product, enhancement, and user tags. Maximum 20 tags per order, each value maximum 100 characters. Useful for campaign tracking, source attribution, or custom categorization.

      Hide tags attribute Show tags attribute object

      • * string Additional properties
    • created_at string(date-time)

      Timestamp when the order was created

    • updated_at string(date-time)

      Timestamp when the order was last modified

    • store object

      Store information needed for API operations

      Hide store attributes Show store attributes object

      • id string(uuid)

        Store UUID

      • subdomain string

        Store subdomain used in Store-Subdomain header

      • name string

        Store display name

      • currency object

        Store currency configuration

        Hide currency attribute Show currency attribute object

        • code string

          Currency code (e.g., usd, gbp, eur)

    • transaction object

      Payment transaction details for an order including pricing, taxes, discounts, and buyer information

      Hide transaction attributes Show transaction attributes object

      • id string(uuid)

        Unique identifier for the transaction. Internal use only - not displayed to customers. Use this ID for API operations like updating payment references or resending receipts.

      • list_prices_include_tax boolean

        Indicates whether the list_price field includes tax (true) or is pre-tax (false). Important for correct price display and accounting.

      • list_price integer

        Total list price in cents (smallest currency unit) before discounts are applied. Whether this includes tax depends on the list_prices_include_tax field.

      • promotion_name string | null

        Display name of the promotion applied to this transaction, if any

      • promotion_code string | null

        The specific promotion code used by the customer, if applicable

      • discounts object

        Breakdown of all discounts applied to this transaction by type. Keys represent discount types, values are amounts in cents.

        Hide discounts attribute Show discounts attribute object

        • * integer Additional properties
      • tax_percentages object

        Breakdown of tax amounts by tax rate. Keys are tax rates as strings (e.g., "0.2" for 20%, "0" for tax-exempt items). Values are the total tax amount in cents for all items taxed at that rate.

        Hide tax_percentages attribute Show tax_percentages attribute object

        • * integer Additional properties
      • tax integer

        Total tax amount in cents (smallest currency unit)

      • value integer

        Final transaction amount in cents (smallest currency unit) after all discounts and including tax. This is the amount charged to the customer.

      • currency_code string

        ISO 4217 currency code in lowercase (e.g., usd, gbp, eur). Determines the currency for all monetary values in this transaction.

      • buyer object

        Customer information collected during checkout

        Hide buyer attributes Show buyer attributes object

        • email string(email)

          Buyer's email address for receipts and communication

        • name string

          Buyer's name as provided during checkout

      • marketing_consent boolean

        Indicates whether the buyer opted in to receive marketing communications

      • completed_at string(date-time) | null

        Timestamp when the transaction payment was completed. Null if payment is pending or failed.

      • type string

        Transaction type indicating how the order was placed:

        • online: Created through online storefront checkout
        • offline: Created through terminal/POS or manually by staff

        Values are online or offline.

      • is_imported boolean

        Indicates if this transaction was imported from an external system

      • payment_gateway string | null

        Payment gateway used to process the transaction (e.g., Stripe, PayPal). Null for offline/manual transactions.

      • payment_reference string | null

        External payment reference or transaction ID from the payment gateway. Used for reconciliation and refunds. Examples: Stripe checkout session ID (cs_live_xxx), PayPal transaction ID, or custom reference for offline payments.

    • redeemables array[object]

      All redeemable items included in this order. Each redeemable represents a single item that can be redeemed.

      A redeemable item that can be redeemed by a customer. Represents either a monetary value (gift card) or a standard item (experience, product, service).

      Hide redeemables attributes Show redeemables attributes object

      • id string(uuid)

        Unique identifier for the redeemable. Internal use only - not displayed to customers. Use this ID for API operations like redemption, cancellation, top-up, or validity updates.

      • type string

        Type of redeemable:

        • monetary: Gift card or voucher with a monetary value that can be redeemed for any amount up to its balance
        • standard: Single-use voucher for a specific experience, product, or service

        Values are monetary or standard.

      • status string

        Current redemption status:

        • issued: Active and eligible to be redeemed
        • not_yet_valid: Created but not yet within the valid_from/valid_to date range
        • redeemed: Fully redeemed (standard type) or has zero balance remaining (monetary type)
        • expired: Past the valid_to date and can no longer be redeemed
        • cancelled: Manually cancelled and cannot be redeemed

        Values are issued, not_yet_valid, redeemed, expired, or cancelled.

      • valid_from string(date) | null

        First date this redeemable can be used (inclusive). Null means valid immediately.

      • valid_to string(date) | null

        Last date this redeemable can be used (inclusive). Null means no expiration date.

      • valid_days array[string] | null

        Specific days of the week when this redeemable can be used. Null or empty array means valid all days.

        Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

      • currency_code string

        ISO 4217 currency code in lowercase. Applies to monetary_value for monetary type redeemables.

      • monetary_value integer | null

        For monetary type: Remaining balance in cents (smallest currency unit). Can be partially redeemed. For standard type: Always null.

      • name string

        Display name of the redeemable item, typically the product name. For variant products, combines product name and variant name (e.g., "Spa Day - Deluxe Package"). Displayed to: Customers on redemption screens, voucher details, and in terminal/POS during redemption.

      • custom_fields object

        Additional custom data for the redeemable, such as product-specific attributes or redemption instructions. Structure varies by product configuration.

        Additional properties are allowed.

      • tags object

        Key-value pairs for categorizing and filtering redeemables. Inherited from the parent product and order.

        Hide tags attribute Show tags attribute object

        • * string Additional properties
      • created_at string(date-time)

        Timestamp when the redeemable was created

      • updated_at string(date-time)

        Timestamp when the redeemable was last modified (e.g., redeemed, topped up, validity updated)

      • is_live boolean

        Indicates if this is a live (production) redeemable (true) or a test redeemable (false)

      • invalid_reason string | null

        Human-readable explanation of why this redeemable cannot currently be redeemed (e.g., "Expired on 2024-12-31", "Not valid on weekends"). Null if redeemable is valid.

      • redeem_locations array[object]

        List of redeem locations where this redeemable can be redeemed.

        Redeem location information needed for API operations

        Hide redeem_locations attributes Show redeem_locations attributes object

        • id string(uuid)

          Location UUID used in Redeem-Location-ID header

        • name string

          Location display name

        • is_active boolean

          Whether the location is currently active

    • vouchers array[object]

      Vouchers grouping one or more redeemables for delivery. A single order may contain multiple vouchers.

      A voucher groups one or more redeemables for delivery to a customer. Vouchers handle the presentation and delivery method (email, postal, collection) of redeemable items.

      Hide vouchers attributes Show vouchers attributes object

      • id string(uuid)

        Unique identifier for the voucher. Internal use only - not displayed to customers. Use this ID for API operations like downloading PDFs or resending emails.

      • reference string

        Unique human-readable voucher reference code used for lookup and customer support. Displayed to: Customers in voucher emails, PDF vouchers, and on voucher QR code pages. Also searchable in the dashboard. Maximum 30 characters.

      • name string

        Display name of the voucher, typically derived from the product name. Displayed to: Customers on PDF vouchers and in emails. Also shown in dashboard.

      • recipient_name string | null

        Name of the person receiving this voucher. Used for personalization in emails and printed vouchers. Displayed to: Customers in voucher emails ("To: [recipient_name]") and on PDF vouchers. Maximum 60 characters. Null if not provided.

      • from_name string | null

        Name of the person sending this voucher. Used for personalization in gift messages. Displayed to: Customers in voucher emails ("From: [from_name]") and on PDF vouchers. Maximum 60 characters. Null if not provided.

      • message string | null

        Personal message from sender to recipient, displayed on the voucher. Displayed to: Customers on PDF vouchers and in voucher emails as the gift message. Maximum 191 characters. Null if no message provided.

      • custom_fields object

        Additional custom data for the voucher, such as design template settings or delivery-specific information. Structure varies by voucher configuration.

        Additional properties are allowed.

      • created_at string(date-time)

        Timestamp when the voucher was created

      • updated_at string(date-time)

        Timestamp when the voucher was last modified

      • order_date string(date-time)

        Timestamp when the parent order was created. Useful for sorting vouchers by purchase date.

      • redeemables array[object]

        All redeemable items included in this voucher. A voucher always contains at least one redeemable.

        A redeemable item that can be redeemed by a customer. Represents either a monetary value (gift card) or a standard item (experience, product, service).

        Hide redeemables attributes Show redeemables attributes object

        • id string(uuid)

          Unique identifier for the redeemable. Internal use only - not displayed to customers. Use this ID for API operations like redemption, cancellation, top-up, or validity updates.

        • type string

          Type of redeemable:

          • monetary: Gift card or voucher with a monetary value that can be redeemed for any amount up to its balance
          • standard: Single-use voucher for a specific experience, product, or service

          Values are monetary or standard.

        • status string

          Current redemption status:

          • issued: Active and eligible to be redeemed
          • not_yet_valid: Created but not yet within the valid_from/valid_to date range
          • redeemed: Fully redeemed (standard type) or has zero balance remaining (monetary type)
          • expired: Past the valid_to date and can no longer be redeemed
          • cancelled: Manually cancelled and cannot be redeemed

          Values are issued, not_yet_valid, redeemed, expired, or cancelled.

        • valid_from string(date) | null

          First date this redeemable can be used (inclusive). Null means valid immediately.

        • valid_to string(date) | null

          Last date this redeemable can be used (inclusive). Null means no expiration date.

        • valid_days array[string] | null

          Specific days of the week when this redeemable can be used. Null or empty array means valid all days.

          Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

        • currency_code string

          ISO 4217 currency code in lowercase. Applies to monetary_value for monetary type redeemables.

        • monetary_value integer | null

          For monetary type: Remaining balance in cents (smallest currency unit). Can be partially redeemed. For standard type: Always null.

        • name string

          Display name of the redeemable item, typically the product name. For variant products, combines product name and variant name (e.g., "Spa Day - Deluxe Package"). Displayed to: Customers on redemption screens, voucher details, and in terminal/POS during redemption.

        • custom_fields object

          Additional custom data for the redeemable, such as product-specific attributes or redemption instructions. Structure varies by product configuration.

          Additional properties are allowed.

        • tags object

          Key-value pairs for categorizing and filtering redeemables. Inherited from the parent product and order.

          Hide tags attribute Show tags attribute object

          • * string Additional properties
        • created_at string(date-time)

          Timestamp when the redeemable was created

        • updated_at string(date-time)

          Timestamp when the redeemable was last modified (e.g., redeemed, topped up, validity updated)

        • is_live boolean

          Indicates if this is a live (production) redeemable (true) or a test redeemable (false)

        • invalid_reason string | null

          Human-readable explanation of why this redeemable cannot currently be redeemed (e.g., "Expired on 2024-12-31", "Not valid on weekends"). Null if redeemable is valid.

        • redeem_locations array[object]

          List of redeem locations where this redeemable can be redeemed.

          Redeem location information needed for API operations

          Hide redeem_locations attributes Show redeem_locations attributes object

          • id string(uuid)

            Location UUID used in Redeem-Location-ID header

          • name string

            Location display name

          • is_active boolean

            Whether the location is currently active

    • notes_count integer

      Total number of notes attached to this order

    • notes array[object]

      Internal notes added by staff for order management and customer service.

      Internal note attached to an order for staff communication and order management

      Hide notes attributes Show notes attributes object

      • content string

        The note content/message. Supports plain text, maximum 1000 characters.

      • created_at string(date-time)

        Timestamp when the note was created

      • user object

        Staff member who created the note

        Hide user attribute Show user attribute object

        • name string

          Display name of the staff member

• 404

  Order not found

• 422

  Validation error