01.software Docs

getListingGroupsQueryCatalog

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
GET
/api/products/listing-groups/query/catalog

Publishable-key-safe paginated catalog; stock, marketPrices and raw Product internals are excluded.

Authorization

publishableKey
headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

Query Parameters

locale?string
Value in"ko""en""all"
fallbackLocale?string
Value in"ko""en""none""false"
market?string
Length1 <= length
page?integer
Range1 <= value
limit?integer
Range1 <= value <= 100
sort?string

One allowed ListingPublicSort field or CSV of 1–5 fields; optional - prefix.

whereJson?string

JSON-encoded ListingPublicWhere; invalid JSON/nonempty operators/recursive and-or constraints are rejected.

Response Body

Actual shaped success body

application/json
  1. response
docs*array<>
totalDocs*number
limit*number
totalPages*number
page*number
pagingCounter*number
hasPrevPage*boolean
hasNextPage*boolean
prevPage*number|null
nextPage*number|null

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X GET 'https://api.01.software/api/products/listing-groups/query/catalog'
Example Response
{  "docs": [    {      "product": {        "id": "string",        "slug": "string",        "handle": "string",        "title": "string",        "subtitle": "string",        "images": [          "string"        ],        "featuredImage": "string",        "priceRange": {          "minVariantPrice": {            "amount": 0          },          "maxVariantPrice": {            "amount": 0          },          "isPriceRange": true        },        "compareAtPriceRange": {          "minVariantPrice": {            "amount": 0          },          "maxVariantPrice": {            "amount": 0          }        },        "availableForSale": true,        "selectedOrFirstAvailableVariant": "string",        "variants": {          "docs": [            {              "id": "string",              "optionValues": [                "string"              ],              "price": 0,              "compareAtPrice": 0,              "resolvedPrice": {                "amount": 0,                "compareAtPrice": 0,                "currency": "string",                "marketId": "string",                "source": "fixed"              },              "isUnlimited": true,              "inventoryPolicy": "deny",              "isActive": true,              "thumbnail": "string",              "images": [                "string"              ],              "_order": "string"            }          ]        }      },      "groups": [        {          "optionId": "string",          "optionTitle": "string",          "optionValueId": "string",          "optionValueLabel": "string",          "optionValueSlug": "string",          "optionValueSwatch": {            "type": "color",            "color": "string",            "mediaItemId": null          },          "variantIds": [            "string"          ],          "variantCount": 0,          "variants": [            {              "id": "string",              "optionValues": [                "string"              ],              "price": 0,              "compareAtPrice": 0,              "resolvedPrice": {                "amount": 0,                "compareAtPrice": 0,                "currency": "string",                "marketId": "string",                "source": "fixed"              },              "isUnlimited": true,              "inventoryPolicy": "deny",              "isActive": true,              "thumbnail": "string",              "images": [                "string"              ],              "_order": "string"            }          ],          "listing": {            "selectionHintVariant": "string",            "primaryImage": "string",            "minPrice": 0,            "maxPrice": 0,            "minCompareAtPrice": 0,            "maxCompareAtPrice": 0,            "isPriceRange": true,            "availableForSale": true          }        }      ]    }  ],  "totalDocs": 0,  "limit": 0,  "totalPages": 0,  "page": 0,  "pagingCounter": 0,  "hasPrevPage": true,  "hasNextPage": true,  "prevPage": 0,  "nextPage": 0}