Customer Login

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "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:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "orders": [
            {}
        ],
        "metadata": {
            "car": "white"
        },
        "groups": [
            {
                "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
                "name": "VIP",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "customers": [
                    {}
                ],
                "price_lists": [
                    {}
                ],
                "metadata": {
                    "car": "white"
                }
            }
        ],
        "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:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "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
            }
        },
        "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:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "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
                }
            }
        ]
    }
}

🟠400Client Error or Multiple Errors

🟠401User does not exist or incorrect credentials

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error