Retrieve details about a specific store

GET api/stores/store_id

Retrieve details about a specific store.

Request syntax

get api/stores/<store_id>

Request parameters

The request accepts no parameters.

Response syntax

{
    "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
`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
404	404 Not Found	No store with the specified `store_id` exists.

Examples

Example: Retrieve details about a specific store

This example retrieves details about the store with ID 25511.

ruby api.rb <customer_code> get api/stores/25511

Response

{
  "id": 25511,
  "store_number": "2324",
  "store_name": "Lucas Test",
  "hostname": "pfc2324pay0",
  "group": "US_ENGAGE",
  "owner_name": "Store: 2324 (Honolulu/HI)",
  "level_of_hierarchy": null,
  "card_acceptor_identifier": "",
  "created_at": "2024-04-24T21:21:20.114Z",
  "updated_at": "2024-04-25T14:46:57.655Z"
}

Example: Retrieve a store that doesn't exist

This example requests a store ID that doesn't exist.

ruby api.rb <customer_code> get api/stores/999999999

Response

{
  "message": "404 Not Found"
}