Introduction

ShopQuery helps merchants expose clean, searchable product catalogs from their store data. The API documentation is for developers integrating that catalog into websites, storefronts, agents, internal tools, or other customer-facing experiences.

These docs cover the v1 catalog endpoints only: products, product search, and collections. Every response is scoped to the merchant connected to the access token used for the request.

Base URL

https://api.shopquery.ai/v1

Authentication

Send an API access token as a bearer token.

Authorization: Bearer <access_token>
Accept: application/json

Requests without a valid token return an authentication error. Valid requests only return records available to the token's merchant.

Pagination

List endpoints return paginated responses.

{
  "meta": {
    "total": 42,
    "perPage": 100,
    "currentPage": 1,
    "lastPage": 1,
    "firstPage": 1,
    "firstPageUrl": "/?page=1",
    "lastPageUrl": "/?page=1",
    "nextPageUrl": null,
    "previousPageUrl": null
  },
  "data": []
}

Use page and perPage to move through larger result sets. If omitted, page defaults to 1 and perPage defaults to 100.

Errors

Most errors return JSON with a message field. Validation errors may include additional validation details from the API framework.

{
  "message": "Unauthorized access"
}