Linkable
Products

List products

GET
/v1/stores/{store_id}/products

Returns products and their variants for a store. Use variant_id from a variant when creating an order.

Authorization

ClientToken
AuthorizationBearer <token>

Bearer token issued by Linkable. Pass in the Authorization: Bearer <token> header.

In: header

Path Parameters

store_id*string
Formatuuid

Query Parameters

q?string

Search query. Interpreted according to search_type: product title (default), product_id (UUID), shopify_id, or variant SKU. Example: ?q=HOODIE&search_type=sku finds products with a variant SKU containing "HOODIE" (e.g. "emb - HOODIE - MAROON-L"). SKU search needs at least 3 characters.

search_type?string

How to interpret q: name (ILIKE on title), product_id (exact UUID), shopify_id (exact Shopify product ID), sku (partial, case-insensitive match on variant SKU; q must be at least 3 characters, otherwise 400).

Default"name"

Value in

  • "name"
  • "product_id"
  • "shopify_id"
  • "sku"
status?string

Value in

  • "ACTIVE"
  • "ARCHIVED"
  • "DRAFT"
limit?integer
Rangevalue <= 100
Default20
cursor?string

Pagination cursor from previous response.

Response Body

application/json

curl -X GET "https://example.com/v1/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/products"
{  "data": [    {      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",      "title": "string",      "status": "ACTIVE",      "variants": [        {          "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6",          "title": "string",          "sku": "string",          "price": "string"        }      ]    }  ],  "next_cursor": "string"}