Skip to main content
GET
https://api-ai.textyess.com
/
products
/
{id}
Get Product
curl --request GET \
  --url https://api-ai.textyess.com/products/{id} \
  --header 'x-auth-token: <api-key>'
{
  "product_id": "prod_12345",
  "product_url": "https://yourstore.com/products/sample-product",
  "product_image": "https://example.com/image.jpg",
  "title": "Sample Product",
  "description": "A detailed product description",
  "handle": "sample-product",
  "variants": [
    {
      "id": "var_12345",
      "title": "Default Variant",
      "price": "29.99",
      "inventory_quantity": 100
    }
  ],
  "collections": ["New Arrivals", "Featured"],
  "available": true
}

Overview

The get product endpoint allows you to retrieve detailed information about a specific product in your catalog using its unique identifier.

Authentication

This endpoint requires a valid JWT token in the x-auth-token header. You can find your token in the Developers section:
x-auth-token: your_jwt_token

Path Parameters

id
string
required
The unique identifier of the product you want to retrieve

Response

The response includes the following fields:
product_id
string
The unique identifier of the product
product_url
string
The URL where the product can be viewed
product_image
string
The URL of the product’s main image
title
string
The product’s title
description
string
The product’s description
handle
string
The product’s handle/slug
variants
array
Array of product variants
collections
array
Array of collections the product belongs to
available
boolean
Indicates if the product is currently available
{
  "product_id": "prod_12345",
  "product_url": "https://yourstore.com/products/sample-product",
  "product_image": "https://example.com/image.jpg",
  "title": "Sample Product",
  "description": "A detailed product description",
  "handle": "sample-product",
  "variants": [
    {
      "id": "var_12345",
      "title": "Default Variant",
      "price": "29.99",
      "inventory_quantity": 100
    }
  ],
  "collections": ["New Arrivals", "Featured"],
  "available": true
}