Remove an Address from Customer

JS SDK

import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.customer.deleteAddress("cus_123", "cus_addr_123")
.then(({ customer }) => {
  console.log(customer)
})

{
  "id": "<string>",
  "object": "<string>",
  "deleted": true,
  "parent": {
    "id": "<string>",
    "has_account": true,
    "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": "us",
        "province": "us-ca",
        "postal_code": "<string>",
        "phone": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "groups": [
      {
        "id": "<string>",
        "name": "<string>",
        "customers": [
          {}
        ],
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "phone": "<string>",
    "metadata": {},
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

DELETE

admin

customers

{id}

addresses

{address_id}

JS SDK

import Switchyard from "@switchyard/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.customer.deleteAddress("cus_123", "cus_addr_123")
.then(({ customer }) => {
  console.log(customer)
})

{
  "id": "<string>",
  "object": "<string>",
  "deleted": true,
  "parent": {
    "id": "<string>",
    "has_account": true,
    "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": "us",
        "province": "us-ca",
        "postal_code": "<string>",
        "phone": "<string>",
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "groups": [
      {
        "id": "<string>",
        "name": "<string>",
        "customers": [
          {}
        ],
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "phone": "<string>",
    "metadata": {},
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The customer's ID.

address_id

string

required

The customer 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.

Response

The deletion's details.

string

required

The customer's ID.

object

string

required

The name of the deleted object.

deleted

boolean

required

Whether the Customer was deleted.

parent

object

The customer's details.

Show child attributes

parent.id

string

required

The customer's ID.

parent.has_account

boolean

required

Whether the customer is registered.

parent.email

string<email>

required

The customer's email.

parent.default_billing_address_id

string

required

The ID of the address used as the default billing address.

parent.default_shipping_address_id

string

required

The ID of the address used as the default shipping address.

parent.company_name

string

required

The customer's company name.

parent.first_name

string

required

The customer's first name.

parent.last_name

string

required

The customer's last name.

parent.addresses

object[]

required

The customer's addresses.

Show child attributes

parent.addresses.id

string

required

The address's ID.

parent.addresses.address_name

string

required

The address's name.

parent.addresses.is_default_shipping

boolean

required

Whether the address is the default shipping address.

parent.addresses.is_default_billing

boolean

required

Whether the address is the default billing address.

parent.addresses.customer_id

string

required

The ID of the customer that this address belongs to.

parent.addresses.company

string

required

The customer's company.

parent.addresses.first_name

string

required

The customer's first name.

parent.addresses.last_name

string

required

The customer's last name.

parent.addresses.address_1

string

required

The address's first line.

parent.addresses.address_2

string

required

The address's second line.

parent.addresses.city

string

required

The address's city.

parent.addresses.country_code

string

required

The address's country code.

Example:

"us"

parent.addresses.province

string

required

The address's lower-case ISO 3166-2 province code.

Example:

"us-ca"

parent.addresses.postal_code

string

required

The address's postal code.

parent.addresses.phone

string

required

The address's phone.

parent.addresses.metadata

object

required

The address's metadata, used to store custom key-value pairs.

parent.addresses.created_at

string<date-time>

required

The address's creation date.

parent.addresses.updated_at

string<date-time>

required

The address's update date.

parent.groups

object[]

The customer's groups.

Show child attributes

parent.groups.id

string

required

The customer group's ID.

parent.groups.name

string

required

The customer group's name.

parent.groups.customers

object[]

required

The customer group's customers.

parent.groups.metadata

object

required

The customer group's metadata, used to store custom key-value pairs.

parent.groups.created_at

string<date-time>

required

The customer group's creation date.

parent.groups.updated_at

string<date-time>

required

The customer group's update date.

parent.phone

string

The customer's phone.

parent.metadata

object

The customer's metadata, used to store custom key-value pairs.

parent.created_by

string

The ID of the user that created this customer, if available.

parent.created_at

string<date-time>

The customer's creation date.

parent.updated_at

string<date-time>

The customer's update date.

parent.deleted_at

string<date-time>

The customer's deletion date.

Update a Customer's Address

Manage Customer Groups of Customer

⌘I

Overview

Scanner API

Admin API

Authorizations

Path Parameters

Query Parameters

Response