Store

Get a store by ID

get

Query parameters

idstringRequired

The UUID of the store to retrieve

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Responses

200

The store has been successfully retrieved.

application/json

idstringRequired

Unique identifier

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

namestringRequired

Store name

descriptionstring · nullableRequired

Store description

Default: null

brandIdstringRequired

Brand identifier

brandNamestringRequired

Brand name

internalCodestring · nullableRequired

Internal code of the store

Default: null

400

Invalid input format.

401

Unauthorized

404

Store not found.

get

/partners/store

HTTPcURLJavaScriptPython

GET /partners/store?id=text HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Accept: */*

{
  "id": "text",
  "createdAt": "2026-02-23T22:34:29.815Z",
  "updatedAt": "2026-02-23T22:34:29.815Z",
  "name": "text",
  "description": "text",
  "brandId": "text",
  "brandName": "text",
  "groups": [
    {
      "id": "text",
      "createdAt": "2026-02-23T22:34:29.815Z",
      "updatedAt": "2026-02-23T22:34:29.815Z",
      "name": "text",
      "description": "text",
      "internalCode": "text",
      "color": "text"
    }
  ],
  "supportEmails": [
    {
      "id": "text",
      "createdAt": "2026-02-23T22:34:29.815Z",
      "updatedAt": "2026-02-23T22:34:29.815Z",
      "email": "text",
      "default": true
    }
  ],
  "internalCode": "text",
  "postalAddress": {
    "country": "AF",
    "streetName": "text",
    "addressLine": "text",
    "latitude": "text",
    "longitude": "text",
    "city": "text",
    "zipCode": "text"
  },
  "newReviewUris": {
    "google": "text",
    "tripadvisor": "text"
  }
}

List stores

post

Header parameters

X-API-KEYstringRequired

Partner API Key

X-API-SECRETstringRequired

Partner API Secret

Body

application/json

limitnumber · min: 1 · max: 100Optional

Pagination limit

Default: 10

pagenumber · min: 1Optional

Page to retrieve

Default: 1

brandsstring[] · min: 1 · max: 100 · nullableOptional

Brand IDs to filter stores

Responses

201

The stores have been successfully listed.

application/json

400

Invalid input format.

401

Unauthorized

post

/partners/store/list

HTTPcURLJavaScriptPython

POST /partners/store/list HTTP/1.1
Host: api.fullwhere.com
X-API-KEY: text
X-API-SECRET: text
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "limit": 10,
  "page": 1,
  "brands": [
    "text"
  ]
}

{
  "items": [
    {
      "id": "text",
      "createdAt": "2026-02-23T22:34:29.815Z",
      "updatedAt": "2026-02-23T22:34:29.815Z",
      "name": "text",
      "description": "text",
      "brandId": "text",
      "brandName": "text",
      "groups": [
        {
          "id": "text",
          "createdAt": "2026-02-23T22:34:29.815Z",
          "updatedAt": "2026-02-23T22:34:29.815Z",
          "name": "text",
          "description": "text",
          "internalCode": "text",
          "color": "text"
        }
      ],
      "supportEmails": [
        {
          "id": "text",
          "createdAt": "2026-02-23T22:34:29.815Z",
          "updatedAt": "2026-02-23T22:34:29.815Z",
          "email": "text",
          "default": true
        }
      ],
      "internalCode": "text",
      "postalAddress": {
        "country": "AF",
        "streetName": "text",
        "addressLine": "text",
        "latitude": "text",
        "longitude": "text",
        "city": "text",
        "zipCode": "text"
      },
      "newReviewUris": {
        "google": "text",
        "tripadvisor": "text"
      }
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  }
}