Files
medusa-store/www/docs/content/modules/customers/customers.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770)
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

4.2 KiB
Raw Blame History

description
description
Learn about what Customers are in Medusa and how they are implemented. Customers are individuals that make purchases in your store.

Customers

In this document, youll learn about Customers and their relation to other entities in Medusa.

Introduction

Customers are individuals that make purchases in your store. In Medusa, there are two types of customers: registered customers and guests or unregistered customers.

Both registered and unregistered customers can make purchases. However, only registered customers can log into their accounts and manage their details and orders.

An admin user can view and manage their customers, their details, their orders, and what customer group theyre in.


Customer Entity Overview

A customer is stored in the database as a Customer entity. A customer has attributes related to the customers details such as first_name, last_name, and phone. However, the only required attribute is email.

has_account Attribute

As mentioned earlier, customers can be either registered or unregistered. The type of customer is identified in the has_account attribute. This is a boolean attribute that indicates whether the customer is registered.

For example, when a guest customer places an order, a new Customer record is created with the email used (if it doesnt already exist) and the value for has_account is false. When the unregistered customer creates an account using the same email, a new Customer record will be created with the value of has_account set to true.

Email Uniqueness

An email is unique to a type of customer. So, an email can be associated with only one registered customer (where has_account is true), and one unregistered customer (where has_account is false).

In the example mentioned above, after the unregistered customer places an order with an email, then creates an account with the same email, two Customer records are created. Each of these records have different has_account value.

:::info

This architecture allows creating the Claim Order flow, where a registered customer can claim an order they placed as an unregistered customer. You can learn more about it in this documentation.

:::


Relations to Other Entities

CustomerGroup

Customer groups allow dividing customers into groups of similar attributes, then apply special pricing or rules for these customer groups.

:::info

You can learn more about customer groups in this documentation.

:::

A customer can belong to more than one customer group. The relation between the Customer and CustomerGroup entities is available on both entities:

  • You can access the customer groups of a customer by expanding the groups relation and accessing customer.groups.
  • You can access the customers in a customer group by expanding the customers relation and accessing customerGroup.customers.

Orders

Customers can have more than one order. The relation between the Customer and Order entities is available on both entities:

  • You can access the orders of a customer by expanding the orders relation and accessing customer.orders.
  • You can access the customer that placed an order by expanding the customer relation and accessing order.customer.

Address

A customer can have a billing address and more than one shipping address. Both billing and shipping addresses are represented by the Address entity.

The relation between the Customer and Address entities is available on both entities:

  • You can access the billing address of a customer by expanding the billing_address relation and accessing customer.billing_address. You can also access the shipping addresses of a customer by expanding the shipping_addresses relation and accessing customer.shipping_addresses.
  • Likewise, you can access the customer that an address is associated with by expanding the customer relation and accessing address.customer.

See Also