• Overview
  • Examples
  • Recipes
  • Commerce Modules
  • Architectural Modules
  • Integrations
  • Storefront Development
    • SDKs and Tools
    • create-medusa-app
    • Medusa CLI
    • JS SDK
    • Next.js Starter Storefront
    General
    • Medusa Configurations
    • Deployment Guides
    • Troubleshooting Guides
    Admin
    • Admin Widget Injection Zones
    • Admin Components
    Lists
    • Container Dependencies
    • Events List
    References
    • Workflows SDK
    • Data Model Language
    • Service Factory
    • Helper Steps
    • Core Workflows
    • Testing Framework
    Other
    • Contribution Guidelines
      • Docs
      • Admin Translations
    • Usage
  • Get Started
  • Product
    Commerce Modules
    Architectural Modules
  • Resources
    Guides
    Examples
    Recipes
    Admin Components
    Storefront Development
    UI Library
  • Tools & SDKs
    Medusa CLI
    JS SDK
    Next.js Starter
    create-medusa-app
    Integrations
  • Framework
    Modules
    API Routes
    Workflows
    Data Models
    Subscribers
    Scheduled Jobs
    Loaders
    Admin Customizations
    Links
    Query
  • Reference
    Admin API
    Store API
    Core Workflows
    Data Model Language
    Service Factory
    Events Reference
    Admin Widget Injection Zones
v2.1.2·Report Issue
Homepage
Medusa v1
Changelog
Troubleshooting
Hide Sidebar⌘\
Theme
Light
Dark
Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

CustomerDTO

The customer details.

Loading...
Was this page helpful?
Edit this page
      Guides
      • All Areas
      • Guides
      • References
      • Admin API (v2)
      • Store API (v2)
      • Medusa UI
      Navigation↑↓
      Open Result↵
      idstring
      The ID of the customer.
      emailstring
      The email of the customer.
      has_accountboolean
      A flag indicating if customer has an account or not.
      default_billing_address_idnull | string
      The associated default billing address's ID.
      default_shipping_address_idnull | string
      The associated default shipping address's ID.
      company_namenull | string
      The company name of the customer.
      first_namenull | string
      The first name of the customer.
      last_namenull | string
      The last name of the customer.
      addressesCustomerAddressDTO[]
      The addresses of the customer.
      phonenull | string
      The phone of the customer.
      groupsobject[]
      The groups of the customer.
      metadataRecord<string, unknown>
      Holds custom data in key-value pairs.
      created_bynull | string
      Who created the customer.
      deleted_atnull | string | Date
      The deletion date of the customer.
      created_atstring | Date
      The creation date of the customer.
      updated_atstring | Date
      The update date of the customer.