API
GET store

Get Store Information

HTTP Method: GET
URL Path: https://public.zeroxpay.com/v1/store/info
Description: Retrieves general information about the store, including name, ID, and contact details.

Response Structure

The response is a JSON object containing the following fields:

  • created_at (string): The creation date and time of the store record in TIMESTAMPTZ format.
  • id (string): The unique identifier for the store.
  • name (string): The name of the store.
  • store_logo_url (string | null): The URL to the store's logo image. This field is null if no logo has been set.
  • user_id (string): The identifier for the user who owns the store.
  • is_active (boolean): A flag indicating whether the store is currently active (true) or inactive (false).
  • description (string | null): A brief description of the store. This field is null if no description has been provided.
  • store_handle (string | null): A unique handle or slug for the store. This field is null if no handle has been set.

Response Example

{
  "created_at": "2023-01-01 16:48:32.007852+00",
  "id": "store123",
  "name": "My Store",
  "store_logo_url": "https://example.com/logo.png",
  "user_id": "user456",
  "is_active": true,
  "description": "A great place to find unique items.",
  "store_handle": "my-store"
}