Delete Customer Address

DELETE 
/customers/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to delete a customer address. The address is identified by id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about customer lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

addressId stringrequired

Address id

Responses

200

Delete Customer Address - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

object
messages string[]

Example (from schema)

{
  "data": {},
  "messages": [
    "Address deleted"
  ]
}

Delete Customer Address - 200

{
  "data": {},
  "messages": [
    "Address deleted"
  ]
}

404

Delete Customer Address - 404 (customer) / Delete Customer Address - 404 (address)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 60007,
    "messages": [
      "Parent resource [Customer] with id [25496] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/60007",
    "status": 404,
    "type": "ParentCustomerNotFound"
  }
}

Delete Customer Address - 404 (address)

{
  "error": {
    "code": 90006,
    "messages": [
      "Address with id [106100] not found for [Customers] with id [25494]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/90006",
    "status": 404,
    "type": "AddressNotFound"
  }
}

Delete Customer Address - 404 (customer)

{
  "error": {
    "code": 60007,
    "messages": [
      "Parent resource [Customer] with id [25496] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/60007",
    "status": 404,
    "type": "ParentCustomerNotFound"
  }
}

Loading...