Delete

Delete

Delete

Deletes a location from an account.

Request

Method
URL
DELETE

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.
itemUniqueId

Guid
The unique ID of the location.

Headers

Name
Required
Type
Description
APIKey
checked
Guid
A valid API key with a scope of AccountLists

Remarks

A location cannot be deleted while it is still referenced elsewhere on the account (for example, by a customer). Attempting to delete a location that is in use will fail with a 409 Conflict.

Response

Headers

None

Status Code

Code
Description
204 No Content
The location was deleted.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API-keys feature, or the key does not have the required scope.
404 Not Found
No location was found with that id for this account.
409 Conflict
The location is currently in use elsewhere on the account and cannot be deleted.

Body

None