UmbCheckout Documentation
Buy a LicenseUmbraco HostingUmbraco Development
  • 🛒UmbCheckout Documentation
  • 📔Getting Started
    • Overview
    • License Comparison
    • Installation
    • Configuration
    • Starter Kits
      • Stripe
        • Installation
    • Anonymous Telemetry
    • Developer License
    • Affiliate Scheme
    • Buy a License
  • 🛠️Configuration
    • Configuration Options
    • Product Variants
  • 🛒Core Services
    • Session Service
    • Database Service
    • Basket Service
    • Object Reference
      • Basket
      • Customer
      • UmbCheckoutMetaData
      • UmbCheckoutSession
      • LineItem
      • UmbCheckoutConfiguration
      • MultiUrlPicker
    • Cookies
    • Addons
      • Database Service
    • Property Editors
      • MetaData Property Editor
  • 🆘Support
    • Issue Tracker
    • Milestones
    • Roadmap
    • Support Tickets
  • 💰Payment Providers
    • Payment Providers
      • Stripe
        • Installation
        • Configuration
        • Payment Flow / Lifecycle
        • Stripe Email Notifications
        • Payment Methods
        • Receipts
        • Shipping Rates
        • Services
          • Stripe Shipping Rate ApiService
          • Stripe Shipping Rate Database Service
          • Stripe Session Service
          • Stripe Basket Controller
          • Stripe Webhook Api
            • How to test the Stripe Webhook on localhost
        • Notification Handlers
          • StripeResponseNotificationHandler
        • Notifications
          • OnCheckoutSessionCompletedNotification
          • OnCheckoutSessionExpiredNotification
          • OnPaymentFailedNotification
          • OnChargeFailedNotification
          • OnPaymentIntentSucceededNotification
          • OnPaymentIntentPaymentFailedNotification
          • OnPaymentIntentCreatedNotification
          • OnPaymentIntentCancelledNotification
          • OnChargeSucceededNotification
          • OnShippingRateSavedNotification
          • OnShippingRateDeletedNotification
          • OnPaymentSuccessNotification
        • Webhooks
          • OnChargeFailedWebhook
          • OnChargeSucceededWebhook
          • OnCheckoutSessionCompletedWebhook
          • OnCheckoutSessionExpiredWebhook
          • OnPaymentFailedWebhook
          • OnPaymentIntentCancelledWebhook
          • OnPaymentIntentCreatedWebhook
          • OnPaymentIntentPaymentFailedWebhook
          • OnPaymentIntentSucceededWebhook
          • OnPaymentSuccessWebhook
          • OnShippingRateDeletedWebhook
          • OnShippingRateSavedWebhook
        • Object Reference
          • TaxRate
          • Property
          • Validation
          • Config
          • TaxRateResponse
          • ShippingRateResponse
          • ShippingRate
        • uSync
          • Installation
          • Synchronising Changes
        • Addons
          • Tax Rates
          • Services
            • Stripe Tax Rate ApiService
            • Stripe Tax Rate Database Service
          • Notifications
            • OnStripeTaxRateSavedNotification
            • OnStripeTaxRateDeletedNotification
          • Webhooks
            • OnStripeTaxRateDeletedWebhook
            • OnStripeTaxRateSavedWebhook
          • Property Editors
            • Tax Rates Property Editor
          • uSync
            • Installation
            • Synchronising Changes
        • View Components
          • Basket View Component
          • Add to Basket Button View Component
        • Umbraco Forms Workflow
      • PayPal
      • Klarna
      • Apple Pay
      • Google Pay
      • Bacs Direct Debit / SEPA Direct Debit
  • ⏳Scheduled Tasks & Notifications
    • Remove Expired Baskets From Database
    • Basket Notifications
      • OnBasketAddedNotification
      • OnBasketAddedManyNotification
      • OnBasketAddManyStartedNotification
      • OnBasketAddStartedNotification
      • OnBasketClearedNotification
      • OnBasketClearStartedNotification
      • OnBasketReducedNotification
      • OnBasketReduceStartedNotification
      • OnBasketRemovedManyNotification
      • OnBasketRemovedNotification
      • OnBasketRemoveManyStartedNotification
      • OnBasketRemoveStartedNotification
    • Session Notifications
      • OnSessionClearedNotification
      • OnSessionClearStartedNotification
      • OnSessionCreatedNotification
      • OnSessionCreateStartedNotification
      • OnSessionGetNotification
      • OnSessionGetStartedNotification
      • OnSessionUpdatedNotification
      • OnSessionUpdateStartedNotification
    • Payment Provider Notifications
      • OnProviderClearSessionStartedNotification
      • OnProviderCreateSessionStartedNotification
      • OnProviderGetSessionNotification
      • OnProviderGetSessionStartedNotification
      • OnProviderSessionClearedNotification
      • OnProviderSessionCreatedNotification
    • Configuration Notifications
      • OnConfigurationSavedNotification
  • 🔌Extensions
    • Convert Extensions
    • CultureInfo Extensions
    • Decimal Extensions
  • 👨‍💻View Components
    • Basket Link View Component
  • 🔁Synchronising
    • uSync
      • Installation
      • Synchronising Changes
  • ✉️Umbraco Forms
    • Workflow
  • 🏗️Source Code Repositories
    • UmbCheckout
    • UmbCheckout.Stripe
    • UmbCheckout.uSync
    • UmbCheckout.Stripe.uSync
    • UmbCheckout.Stripe.Forms
Powered by GitBook
On this page
Edit on GitHub
  1. Core Services
  2. Object Reference

Basket

PreviousObject ReferenceNextCustomer

Last updated 5 months ago

The Basket object contains the below properties

Property Name
Type
Use

Id

string

The Basket id

SessionId

string

The UmbCheckout Session Id

CustomerReferenceId

string?

A unique reference which can be used to identify the order

Customer

Information relating to the customer

LineItems

IEnumerable<>

The line items (products) contained in the Basket

ItemCount

long

The total count of line item quantity

Total

decimal

The sub total of the Basket, excluding Tax and Shipping

MetaData

Dictionary<string, string>

Used to store meta data against the basket

🛒
Customer?
LineItem