Customer Login

POST/store/auth

Log a customer in and includes the Cookie session in the response header. The cookie session can be used in subsequent requests to authenticate the customer. When using Medusa's JS or Medusa React clients, the cookie is automatically attached to subsequent requests.

Request

string

required

The Customer's email.

password

string

required

The Customer's password.

{
  "email": "string",
  "password": "string"
}

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

User does not exist or incorrect credentials(401)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

The customer's details.

customer

object (Customer)

required

A customer can make purchases in your store and manage their profile.

string

required

The customer's ID

Example:

cus_01G2SG30J8C85S4A5CHM2S1NS2

string <email>

required

The customer's email

first_name

string | null

required

The customer's first name

Example:

Arno

last_name

string | null

required

The customer's last name

Example:

Willms

billing_address_id

string | null

required

The customer's billing address ID

Example:

addr_01G8ZH853YPY9B94857DY91YGW

phone

string | null

required

The customer's phone number

Example:

16128234334802

has_account

boolean

required

Whether the customer has an account or not

Default:

false

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

orders

array [object]

optional

The details of the orders this customer placed.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

groups

array[object (Customer Group) {8}]

optional

The customer groups the customer belongs to.

shipping_addresses

array[object (Address) {18}]

optional

The details of the shipping addresses associated with the customer.

billing_address

object (Address)

optional

An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.

{
  "customer": {
    "id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
    "email": "user@example.com",
    "first_name": "Arno",
    "last_name": "Willms",
    "billing_address_id": "addr_01G8ZH853YPY9B94857DY91YGW",
    "phone": 16128234334802,
    "has_account": false,
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "deleted_at": "2019-08-24T14:15:22.123Z",
    "orders": [
      {}
    ],
    "metadata": {
      "car": "white"
    },
    "groups": [
      {
        "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
        "name": "VIP",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "deleted_at": "2019-08-24T14:15:22.123Z",
        "customers": [
          {}
        ],
        "price_lists": [
          {}
        ],
        "metadata": {
          "car": "white"
        }
      }
    ],
    "shipping_addresses": [
      {
        "id": "addr_01G8ZC9VS1XVE149MGH2J7QSSH",
        "customer_id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
        "customer": {},
        "company": "Acme",
        "first_name": "Arno",
        "last_name": "Willms",
        "address_1": "14433 Kemmer Court",
        "address_2": "Suite 369",
        "city": "South Geoffreyview",
        "province": "Kentucky",
        "postal_code": 72093,
        "phone": 16128234334802,
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "deleted_at": "2019-08-24T14:15:22.123Z",
        "country_code": "st",
        "metadata": {
          "car": "white"
        },
        "country": {
          "id": 109,
          "name": "ITALY",
          "display_name": "Italy",
          "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
          "region": {},
          "iso_2": "it",
          "iso_3": "ita",
          "num_code": 380
        }
      }
    ],
    "billing_address": {
      "id": "addr_01G8ZC9VS1XVE149MGH2J7QSSH",
      "customer_id": "cus_01G2SG30J8C85S4A5CHM2S1NS2",
      "customer": {},
      "company": "Acme",
      "first_name": "Arno",
      "last_name": "Willms",
      "address_1": "14433 Kemmer Court",
      "address_2": "Suite 369",
      "city": "South Geoffreyview",
      "province": "Kentucky",
      "postal_code": 72093,
      "phone": 16128234334802,
      "created_at": "2019-08-24T14:15:22.123Z",
      "updated_at": "2019-08-24T14:15:22.123Z",
      "deleted_at": "2019-08-24T14:15:22.123Z",
      "country_code": "st",
      "metadata": {
        "car": "white"
      },
      "country": {
        "id": 109,
        "name": "ITALY",
        "display_name": "Italy",
        "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G",
        "region": {},
        "iso_2": "it",
        "iso_3": "ita",
        "num_code": 380
      }
    }
  }
}

Last modified: a year ago