Skip to main content
GET
/
api
/
sync
/
v1
/
products
/
{product_id}
Get Product For Sync
curl --request GET \
  --url https://api.example.com/api/sync/v1/products/{product_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "vendor": "<string>",
  "product_type": "<string>",
  "tags": [
    "<string>"
  ],
  "price": "<string>",
  "compare_at_price": "<string>",
  "currency": "<string>",
  "images": [
    {}
  ],
  "has_variants": true,
  "options": [
    {}
  ],
  "variants": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sku": "<string>",
      "barcode": "<string>",
      "option1": "<string>",
      "option2": "<string>",
      "option3": "<string>",
      "price": "<string>",
      "compare_at_price": "<string>",
      "inventory_quantity": 123,
      "available": true,
      "image_url": "<string>",
      "weight": "<string>",
      "weight_unit": "<string>"
    }
  ],
  "in_stock": true,
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

authorization
string | null
X-Stella-Site-Id
string | null
X-Sync-Secret
string | null
X-Site-ID
string | null

Path Parameters

product_id
string<uuid>
required

Response

Successful Response

Full product data for sync.

id
string<uuid>
required
name
string
required
slug
string | null
required
description
string | null
required
vendor
string | null
required
product_type
string | null
required
tags
string[] | null
required
price
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
compare_at_price
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string
required
images
Images · object[]
required
has_variants
boolean
required
options
Options · object[]
required
variants
SyncVariantResponse · object[]
required
in_stock
boolean
required
status
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required