Skip to main content
GET
/
api
/
v1
/
items
/
{id}
Get an item by ID
curl --request GET \
  --url https://integrations.polinate.ai/api/v1/items/{id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>'
{
  "id": "itm_123",
  "name": "Widget",
  "handle": "widget-1",
  "type": "OTHER",
  "status": "ACTIVE",
  "variants": [
    {
      "id": "var_small",
      "itemId": "itm_123",
      "variantName": "Small",
      "sku": "SKU-S",
      "currency": "AUD",
      "price": 9.99,
      "cost": 5,
      "weight": 0.5,
      "unitOfMeasure": "kg",
      "sequence": 1
    },
    {
      "id": "var_large",
      "itemId": "itm_123",
      "variantName": "Large",
      "sku": "SKU-L",
      "currency": "AUD",
      "price": 14.99,
      "cost": 8,
      "weight": 1,
      "unitOfMeasure": "kg",
      "sequence": 2
    }
  ]
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

Path Parameters

​
id
string
required
Example:

"itm_123"

Response

OK

​
id
string
required
​
name
string
required
​
handle
string
required
​
description
string | null
​
imgUrl
string | null
​
customType
string | null
​
brand
string | null
​
vendorName
string | null
​
type
string
​
status
string
​
properties
object
​
createdAt
string
​
updatedAt
string
​
deletedAt
string | null
​
variants
object[]