Skip to main content
DELETE
/
store
/
customers
/
me
/
addresses
/
{address_id}
JS SDK
import Medusa from "@medusajs/js-sdk"

let MEDUSA_BACKEND_URL = "http://localhost:9000"

if (process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL) {
  MEDUSA_BACKEND_URL = process.env.NEXT_PUBLIC_MEDUSA_BACKEND_URL
}

export const sdk = new Medusa({
  baseUrl: MEDUSA_BACKEND_URL,
  debug: process.env.NODE_ENV === "development",
  publishableKey: process.env.NEXT_PUBLIC_MEDUSA_PUBLISHABLE_KEY,
})

// TODO must be authenticated as the customer to delete their address
sdk.store.customer.deleteAddress("caddr_123")
.then(({ deleted, parent: customer }) => {
  console.log(customer)
})
{ "id": "<string>", "object": "address", "deleted": true, "parent": { "id": "<string>", "email": "jsmith@example.com", "default_billing_address_id": "<string>", "default_shipping_address_id": "<string>", "company_name": "<string>", "first_name": "<string>", "last_name": "<string>", "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", "province": "us-ca", "postal_code": "<string>", "phone": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } ], "phone": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } }

Authorizations

​
connect.sid
string
cookie
required

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

​
x-medusa-locale
string

The locale in BCP 47 format to retrieve localized content.

Example:

"en-US"

Path Parameters

​
address_id
string
required

The address's ID.

Query Parameters

​
fields
string

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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the Retrieve Custom Links documentation.

​
locale
string

The locale in BCP 47 format to retrieve localized content.

Example:

"en-US"

Response

OK

The deletion's details.

​
id
string
required

The address's ID.

​
object
string
default:address
required

The name of the deleted object.

​
deleted
boolean
required

Whether the address was deleted.

​
parent
object

The details of the customer the address belongs to.