Upsert product

Bearer authproducts.writeAlpha

Alpha: This endpoint is available only to approved API integrations and may change without notice.

Creates or updates an external OMS product by external_id. Included variants are independently upserted by their external_id; variants omitted from a request are left unchanged. Set active to false to disable a product or variant while retaining its history.

POSTapi.superfiliate.com/api/v1/products

Body parametersapplication/json

sourcestringrequired
Stable source/provider key for this external catalog
external_idstringrequired
Stable product identifier in the external OMS
titlestringrequired
Product display name
urlstringrequired
HTTP(S) URL for the external product
html_descriptionstring | null
Optional HTML. Omit to preserve the current value; send null to clear it.
image_urlstringrequired
HTTP(S) URL for product image
activeboolean
Defaults to true for a new product
Variants to create or update. Omitted variants remain unchanged.
- external_idstringrequired
  Stable variant identifier
- titlestringrequired
  Variant display name
- skustring | null
  Omit to preserve the current value; send null to clear it.
- image_urlstring | null
  URL for image.
- pricestring | null
  Optional decimal price in the authenticated shop's configured currency
- activeboolean
  Defaults to true for a new variant
- The options for this resource.
  namestringrequired
  Human-readable name for this resource.
  valuestringrequired
  The value for this resource.

Responses

Product upserted

idinteger
sourcestring
The source for this resource.
external_idstring | null
Identifier for the related external.
titlestring
The title for this resource.
urlstring
URL for url.
html_descriptionstring | null
The html description for this resource.
image_urlstring | null
URL for image.
activeboolean
The active for this resource.
The variants for this resource.
- idinteger
- external_idstring
  Identifier for the related external.
- titlestring
  The title for this resource.
- skustring | null
  The sku for this resource.
- image_urlstring | null
  URL for image.
- pricestring | null
  Price in the authenticated shop's configured currency.
- activeboolean
  The active for this resource.
- The options for this resource.
  namestring
  Human-readable name for this resource.
  valuestring
  The value for this resource.

curl "https://api.superfiliate.com/api/v1/products" \ -X POST \ -H "Authorization: Bearer $SF_CLIENT_ID:$SF_CLIENT_SECRET" \ -H "Content-Type: application/json" \ -d '{ "source": "custom_oms", "external_id": "everyday-t-shirt", "title": "Everyday T-shirt", "url": "https://store.example/products/t-shirt", "html_description": "<p>Soft cotton.</p>", "image_url": "https://cdn.example.com/products/t-shirt.jpg", "variants": [ { "external_id": "everyday-t-shirt-black-medium", "title": "Black / Medium", "sku": "TSHIRT-BLK-M", "price": "29.99", "options": [ { "name": "Color", "value": "Black" }, { "name": "Size", "value": "Medium" } ] } ] }'

{ "id": 123456, "source": "custom_oms", "external_id": "everyday-t-shirt", "title": "Everyday T-shirt", "url": "https://store.example/products/t-shirt", "html_description": "<p>Soft cotton.</p>", "image_url": "https://cdn.example.com/products/t-shirt.jpg", "active": true, "variants": [ { "id": 123457, "external_id": "everyday-t-shirt-black-medium", "title": "Black / Medium", "sku": "TSHIRT-BLK-M", "image_url": null, "price": "29.99", "active": true, "options": [ { "name": "Color", "value": "Black" }, { "name": "Size", "value": "Medium" } ] } ] }