πProducts
Retrieves all products, optionally filtering by a search query.
Query parameters
querystringOptional
Optional search query to filter products by title.
Responses
200
A list of products.
application/json
404
No products found matching the criteria.
get
GET /subscriptions/allProducts HTTP/1.1
Host: localhost:3002
Accept: */*
[
{
"productId": "text",
"shop": "text",
"commerceType": "text",
"productCategoryName": "text",
"productCategoryId": "text",
"productCategoryisLeaf": true,
"productCategoryisRoot": true,
"excludeFromAddOns": true,
"minVariantPriceAmount": 1,
"minVariantPriceCurrency": "text",
"maxVariantPriceAmount": 1,
"maxVariantPriceCurrency": "text",
"totalVariants": 1,
"variants": [
{
"variantId": "text",
"createdAt": "text",
"barCode": "text",
"sellableOnlineQuantity": 1,
"taxable": true,
"title": "text",
"position": 1,
"displayName": "text",
"price": 1,
"imageUrl": "text",
"inventoryQuantity": 1,
"availableForSale": true,
"weight": 1,
"weightUnit": "text",
"inventoryPolicy": "text",
"sku": "text"
}
],
"vendor": "text",
"status": "text",
"tracksInventory": true,
"title": "text",
"tags": [
"text"
],
"createdAt": "text",
"descriptionHtml": "text",
"publishedAt": "text",
"sellingPlanGroupCount": 1,
"customProductType": "text",
"standardizedProductType": "text",
"onlineStoreUrl": "text",
"onlineStorePreviewUrl": "text",
"legacyResourceId": "text",
"productType": "text",
"handle": "text",
"featuredImageUrl": "text"
}
]
Retrieves a list of all product variants associated with a given product ID.
Path parameters
productIdstringRequired
The unique identifier of the product to retrieve variants for.
Responses
200
A list of product variants.
application/json
500
Server error, such as when the query fails due to backend issues.
get
GET /subscriptions/variants/{productId} HTTP/1.1
Host: localhost:3002
Accept: */*
[
{
"id": "text",
"title": "text",
"position": 1,
"image": {
"url": "text"
},
"createdAt": "2025-06-27T08:57:49.003Z",
"barcode": "text",
"sellableOnlineQuantity": 1,
"taxable": true,
"weightUnit": "text",
"displayName": "text",
"price": 1,
"inventoryQuantity": 1,
"availableForSale": true,
"weight": 1,
"inventoryPolicy": "text",
"sku": "text",
"product": {
"title": "text"
}
}
]
Last updated
Was this helpful?