🍘Products

Search all products

Retrieves all products, optionally filtering by a search query.

GEThttp://localhost:3002/subscriptions/allProducts

Query parameters

Response

A list of products.

Body

productIdstring

shopstring

commerceTypestring

productCategoryNamestring

productCategoryIdstring

productCategoryisLeafboolean

productCategoryisRootboolean

excludeFromAddOnsboolean

minVariantPriceAmountnumber

minVariantPriceCurrencystring

maxVariantPriceAmountnumber

maxVariantPriceCurrencystring

totalVariantsnumber

variantsarray of Variant (object)

vendorstring

statusstring

tracksInventoryboolean

titlestring

tagsarray of string

createdAtstring

descriptionHtmlstring

publishedAtstring

sellingPlanGroupCountnumber

customProductTypestring

standardizedProductTypestring

onlineStoreUrlstring

onlineStorePreviewUrlstring

legacyResourceIdstring

productTypestring

handlestring

featuredImageUrlstring

Request

const response = await fetch('http://localhost:3002/subscriptions/allProducts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "productId": "text",
    "shop": "text",
    "commerceType": "text",
    "productCategoryName": "text",
    "productCategoryId": "text",
    "productCategoryisLeaf": false,
    "productCategoryisRoot": false,
    "excludeFromAddOns": false,
    "minVariantPriceAmount": 0,
    "minVariantPriceCurrency": "text",
    "maxVariantPriceAmount": 0,
    "maxVariantPriceCurrency": "text",
    "totalVariants": 0,
    "variants": [
      {
        "variantId": "text",
        "createdAt": "text",
        "barCode": "text",
        "sellableOnlineQuantity": 0,
        "taxable": false,
        "title": "text",
        "position": 0,
        "displayName": "text",
        "price": 0,
        "imageUrl": "text",
        "inventoryQuantity": 0,
        "availableForSale": false,
        "weight": 0,
        "weightUnit": "text",
        "inventoryPolicy": "text",
        "sku": "text"
      }
    ],
    "vendor": "text",
    "status": "text",
    "tracksInventory": false,
    "title": "text",
    "tags": [
      "text"
    ],
    "createdAt": "text",
    "descriptionHtml": "text",
    "publishedAt": "text",
    "sellingPlanGroupCount": 0,
    "customProductType": "text",
    "standardizedProductType": "text",
    "onlineStoreUrl": "text",
    "onlineStorePreviewUrl": "text",
    "legacyResourceId": "text",
    "productType": "text",
    "handle": "text",
    "featuredImageUrl": "text"
  }
]

Get all product variants by product ID

Retrieves a list of all product variants associated with a given product ID.

GEThttp://localhost:3002/subscriptions/variants/{productId}

Path parameters

productId*string

The unique identifier of the product to retrieve variants for.

Response

A list of product variants.

Body

id*string

Unique identifier for the product variant.

title*string

The title of the product variant.

positioninteger

The position of the product variant in the list.

imageobject

createdAtstring (date-time)

The creation date of the product variant.

barcodestring

The barcode of the product variant.

sellableOnlineQuantityinteger

The quantity of the product variant that is available for sale online.

taxableboolean

Indicates if the product variant is taxable.

weightUnitstring

The unit of weight for the product variant.

displayNamestring

The display name of the product variant.

pricenumber (float)

The price of the product variant.

inventoryQuantityinteger

The inventory quantity of the product variant.

availableForSaleboolean

Indicates if the product variant is available for sale.

weightnumber (float)

The weight of the product variant.

inventoryPolicystring

The inventory policy of the product variant.

skustring

The stock keeping unit (SKU) of the product variant.

productobject

Request

const response = await fetch('http://localhost:3002/subscriptions/variants/{productId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "title": "text",
    "image": {
      "url": "text"
    },
    "createdAt": "2024-09-19T22:01:33.936Z",
    "barcode": "text",
    "taxable": false,
    "weightUnit": "text",
    "displayName": "text",
    "price": 0,
    "availableForSale": false,
    "weight": 0,
    "inventoryPolicy": "text",
    "sku": "text",
    "product": {
      "title": "text"
    }
  }
]

PreviousDELETE NextSubscription Plans

Last updated 6 months ago

[ { "productId": "text", "shop": "text", "commerceType": "text", "productCategoryName": "text", "productCategoryId": "text", "productCategoryisLeaf": false, "productCategoryisRoot": false, "excludeFromAddOns": false, "minVariantPriceAmount": 0, "minVariantPriceCurrency": "text", "maxVariantPriceAmount": 0, "maxVariantPriceCurrency": "text", "totalVariants": 0, "variants": [ { "variantId": "text", "createdAt": "text", "barCode": "text", "sellableOnlineQuantity": 0, "taxable": false, "title": "text", "position": 0, "displayName": "text", "price": 0, "imageUrl": "text", "inventoryQuantity": 0, "availableForSale": false, "weight": 0, "weightUnit": "text", "inventoryPolicy": "text", "sku": "text" } ], "vendor": "text", "status": "text", "tracksInventory": false, "title": "text", "tags": [ "text" ], "createdAt": "text", "descriptionHtml": "text", "publishedAt": "text", "sellingPlanGroupCount": 0, "customProductType": "text", "standardizedProductType": "text", "onlineStoreUrl": "text", "onlineStorePreviewUrl": "text", "legacyResourceId": "text", "productType": "text", "handle": "text", "featuredImageUrl": "text" } ]