Delete a store

DELETE api/stores/store_id

Delete a store.

Request syntax

delete api/stores/<store_id>

Request parameters

The request accepts no parameters.

Response syntax

{
    "exporter_job": integer,
    "id": integer,
    "store_number": "string",
    "store_name": "string",
    "hostname": "string",
    "group": "string",
    "owner_name": "string",
    "level_of_hierarchy": "string",
    "card_acceptor_identifier": "string",
    "created_at": "timestamp",
    "updated_at": "timestamp"
}

Response parameters

If the action is successful, an HTTP 200 response is returned. The following data is returned in JSON format.

Field	Type	Description
`exporter_job`	Integer	The ID of the exporter job performing the delete action.
`id`	Integer	The store ID.
`store_number`	String	The store number.
`store_name`	String	The store name.
`hostname`	String	The hostname of the node or server that manages the store, for example `pfc2324pay0`. Empty if no host is assigned.
`group`	String	The store group, for example `US_ENGAGE`.
`owner_name`	String	A display name generated from the store number, city, and state, for example `Store: 9901 (Austin/TX)`.
`level_of_hierarchy`	String	The level of hierarchy the store is assigned to, for example `United States > NE > NJ`. `null` if the store isn't assigned to a level of hierarchy.
`card_acceptor_identifier`	String	The card acceptor identifier for the store. This parameter is only returned if the ETL feature is turned on.
`created_at`	Timestamp	The timestamp for when the store was initially created.
`updated_at`	Timestamp	The timestamp indicating when the store was last updated.

Errors

The following are common errors returned by this API.

Code	Message	Cause
-	-	-

Examples

Example: Delete a store

This example deletes the store with ID 25651.

ruby api.rb <customer_code> delete api/stores/25651

Response

{
  "exporter_job": 1781621,
  "id": 25651,
  "store_number": "9901",
  "store_name": "Docs Test Store",
  "hostname": "",
  "group": null,
  "owner_name": "Store: 9901 (Austin/TX)",
  "level_of_hierarchy": null,
  "card_acceptor_identifier": null,
  "created_at": "2026-10-10T17:36:20.630Z",
  "updated_at": "2026-10-10T17:40:22.489Z"
}