Delete an address - Spree Commerce documentation

DELETE

api

store

customers

addresses

{id}

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

await client.customer.addresses.delete('addr_abc123', {
  token: '<token>',
})

{
  "error": {
    "code": "record_not_found",
    "message": "Address not found"
  }
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Authorization

string

header

required

JWT token for authenticated customers

Headers

x-spree-api-key

string

required

Authorization

string

required

Path Parameters

string

required

Response

address deleted

Get an address

Update an address

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

await client.customer.addresses.delete('addr_abc123', {
  token: '<token>',
})

{
  "error": {
    "code": "record_not_found",
    "message": "Address not found"
  }
}