Skip to main content
GET
/
api
/
sync
/
availability
Check Availability
curl --request GET \
  --url https://api.example.com/api/sync/availability \
  --header 'X-Site-ID: <x-site-id>' \
  --header 'X-Sync-Secret: <x-sync-secret>'
{
  "available": true,
  "quantity": 123,
  "price": "<string>",
  "compare_at_price": "<string>",
  "sku": "<string>",
  "variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_name": "<string>",
  "option1": "<string>",
  "option2": "<string>",
  "option3": "<string>"
}

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

​
X-Sync-Secret
string
required
​
X-Site-ID
string
required

Query Parameters

​
product_id
string<uuid>
required
​
option1
string | null
​
option2
string | null
​
option3
string | null

Response

Successful Response

Response for real-time availability check.

​
available
boolean
required
​
quantity
integer
required
​
price
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
compare_at_price
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
sku
string | null
required
​
variant_id
string<uuid>
required
​
product_id
string<uuid>
required
​
product_name
string
required
​
option1
string | null
required
​
option2
string | null
required
​
option3
string | null
required