Create an item and its variants

curl --request POST \
  --url https://integrations.polinate.ai/api/v1/items \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>' \
  --data '
{
  "item": {
    "name": "Widget",
    "handle": "widget-1",
    "type": "OTHER",
    "status": "ACTIVE"
  },
  "variants": [
    {
      "variantName": "Default",
      "currency": "AUD",
      "price": 12.34,
      "cost": 8.5
    }
  ]
}
'

{
  "success": true,
  "id": "itm_123",
  "variantIds": [
    "var_abc",
    "var_def"
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "fieldErrors": {}
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "fieldErrors": {}
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "fieldErrors": {}
}

POST

api

items

curl --request POST \
  --url https://integrations.polinate.ai/api/v1/items \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>' \
  --data '
{
  "item": {
    "name": "Widget",
    "handle": "widget-1",
    "type": "OTHER",
    "status": "ACTIVE"
  },
  "variants": [
    {
      "variantName": "Default",
      "currency": "AUD",
      "price": 12.34,
      "cost": 8.5
    }
  ]
}
'

{
  "success": true,
  "id": "itm_123",
  "variantIds": [
    "var_abc",
    "var_def"
  ]
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "fieldErrors": {}
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "fieldErrors": {}
}

{
  "errorCode": "<string>",
  "message": "<string>",
  "fieldErrors": {}
}

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}}"

Idempotency-Key

string

Idempotency key for POST operations

Example:

"{{idempotencyKey}}"

Body

application/json

item

object

required

Show child attributes

variants

object[]

required

Minimum array length: 1

Show child attributes

Response

Created - Returns item ID and variant IDs in submission order

success

boolean

required

string

required

The created item ID

variantIds

string[]

required

Array of created variant IDs in the same order as the request

Items

Buyers

Pricing

Invoices

Orders

Create an item and its variants

Headers

Body

Response