Skip to main content
GET
/
products
/
{productId}
/
variants
/
{variantId}
cURL
curl --request GET \
  --url https://admin.fanfare.io/api/products/{productId}/variants/{variantId} \
  --header 'Authorization: Bearer <token>'
{
  "options": [
    {
      "optionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "optionName": "<string>",
      "value": "<string>",
      "valueId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inventoryQuantity": 123,
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "price": "<string>",
  "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sku": "<string>",
  "metadata": {},
  "primaryExternalId": "<string>",
  "primaryLastSyncedAt": "2023-11-07T05:31:56Z",
  "primarySourceVendor": "<string>",
  "primarySyncSourceId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>"
}

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Path Parameters

productId
string
required
variantId
string
required

Response

Product variant retrieved successfully

options
object[]
required
archived
boolean
required
createdAt
string<date-time>
required
createdBy
string
required
id
string<uuid>
required
inventoryPolicy
enum<string>
required
Available options:
untracked,
deny,
continue
inventoryQuantity
integer
required
organizationId
string<uuid>
required
price
string
required
Pattern: ^\d{1,12}(\.\d{1,8})?$
productId
string<uuid>
required
sku
string
required
Minimum string length: 1
metadata
object | null
primaryExternalId
string | null
primaryLastSyncedAt
string<date-time> | null
primarySourceVendor
string | null
primarySyncSourceId
string | null
updatedAt
string<date-time> | null
updatedBy
string | null