Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Customers
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
    • Get a Collection
  • Regions
    • List Regions
    • Get a Region
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
      GET
    • Update Customer
      POST
    • Create Address for Logged-In Customer
      POST
    • List Customer's Addresses
      GET
    • Get Customer's Address
      GET
    • Update Customer's Address
      POST
    • Remove Customer's Address
      DELETE
    • Register Customer
      POST
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  1. Customers

Update Customer

POST
/store/customers/me
Customers
Update the logged-in customer's details.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request POST '{{BASE_URL}}/store/customers/me' \
--header 'x-publishable-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "company_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "metadata": {}
}'
Response Response Example
200 - Example 1
{
    "customer": {
        "id": "string",
        "email": "user@example.com",
        "default_billing_address_id": "string",
        "default_shipping_address_id": "string",
        "company_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "addresses": [
            {
                "id": "string",
                "address_name": "string",
                "is_default_shipping": true,
                "is_default_billing": true,
                "customer_id": "string",
                "company": "string",
                "first_name": "string",
                "last_name": "string",
                "address_1": "string",
                "address_2": "string",
                "city": "string",
                "country_code": "usd",
                "postal_code": "string",
                "phone": "string",
                "metadata": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "province": "us-ca"
            }
        ]
    }
}

Request

Query Params
fields
string 
fields
optional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Header Params
x-publishable-api-key
string 
required
Publishable API Key created in the Medusa Admin.
Body Params application/json
The details to update in the customer.
company_name
string 
company_name
optional
The customer's company name.
first_name
string 
first_name
optional
The customer's first name.
last_name
string 
last_name
optional
The customer's last name.
phone
string 
phone
optional
The customer's phone.
metadata
object 
optional
The customer's metadata, can hold custom key-value pairs.
Examples

Responses

🟢200OK
application/json
OK
Body
The customer's details.
customer
object (StoreCustomer) 
required
The customer's details.
id
string 
id
required
The customer's ID.
email
string <email>
email
required
The customer's email.
default_billing_address_id
string 
default_billing_address_id
required
The ID of the address used for billing by default.
default_shipping_address_id
string 
default_shipping_address_id
required
The ID of the address used for shipping by default.
company_name
string 
company_name
required
The customer's company name.
first_name
string 
first_name
required
The customer's first name.
last_name
string 
last_name
required
The customer's last name.
phone
string 
phone
optional
The customer's phone.
metadata
object 
optional
The customer's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
optional
The date the customer was created.
updated_at
string <date-time>
updated_at
optional
The date the customer was updated.
deleted_at
string <date-time>
deleted_at
optional
The date the customer was deleted.
addresses
array[object (StoreCustomerAddress) {18}] 
required
The customer's addresses.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
Get Logged-in Customer
Next
Create Address for Logged-In Customer
Built with