catalog

Embed

<a href="https://hermeticor.com/docs/ref-catalog"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9fc720ba-4c3d-4e83-bd29-1f3b952f36da/social-card.svg?v=3e7ae33eec8b" alt="catalog" width="600" height="315"></a>

PUThttps://hermeticor.com/v1/catalog/items/{id}

Create the product under this external id, or replace its fields (unset fields are cleared)

Parameters

idstringpathrequired

Request body

application/json

titlestringrequired

descriptionstring

urlstring

imageUrlstring

priceMinorinteger

currencystring

inventoryinteger

publishedboolean

categoriesstring[]

variantsVariantsItem5[]

Show child parameters

externalIdstringrequired

skustring

titlestringrequired

priceMinorinteger

currencystring

inventoryinteger

urlstring

imageUrlstring

publishedboolean

inventoryPolicystring

deny | continue

backordersstring

visibilitystring

imageThumbnailUrlstring

customMetadataobject

imageThumbnailUrlstring

handlestring

typestring

vendorstring

publishedAtForeignstring

{
  "title": "string",
  "description": "string",
  "url": "string",
  "imageUrl": "string",
  "priceMinor": 0,
  "currency": "string",
  "inventory": 0,
  "published": true,
  "categories": [
    "string"
  ],
  "variants": [
    {
      "externalId": "string",
      "sku": "string",
      "title": "string",
      "priceMinor": 0,
      "currency": "string",
      "inventory": 0,
      "url": "string",
      "imageUrl": "string",
      "published": true,
      "inventoryPolicy": "deny",
      "backorders": "string",
      "visibility": "string",
      "imageThumbnailUrl": "string",
      "customMetadata": {}
    }
  ],
  "customMetadata": {},
  "imageThumbnailUrl": "string",
  "handle": "string",
  "type": "string",
  "vendor": "string",
  "publishedAtForeign": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/catalog/items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","url":"string","imageUrl":"string","priceMinor":0,"currency":"string","inventory":0,"published":true,"categories":["string"],"variants":[{"externalId":"string","sku":"string","title":"string","priceMinor":0,"currency":"string","inventory":0,"url":"string","imageUrl":"string","published":true,"inventoryPolicy":"deny","backorders":"string","visibility":"string","imageThumbnailUrl":"string","customMetadata":{}}],"customMetadata":{},"imageThumbnailUrl":"string","handle":"string","type":"string","vendor":"string","publishedAtForeign":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "feedId": "string",
  "externalId": "string",
  "title": "string",
  "description": "string",
  "url": "string",
  "imageUrl": "string",
  "priceMinor": 0,
  "currency": "string",
  "inventory": 0,
  "published": true,
  "categories": [
    "string"
  ],
  "variants": [
    {
      "id": "string",
      "itemId": "string",
      "externalId": "string",
      "sku": "string",
      "title": "string",
      "priceMinor": 0,
      "currency": "string",
      "inventory": 0,
      "url": "string",
      "imageUrl": "string",
      "published": true,
      "inventoryPolicy": "deny",
      "backorders": "string",
      "visibility": "string",
      "imageThumbnailUrl": "string",
      "customMetadata": {}
    }
  ],
  "updatedAt": "2024-01-01T00:00:00Z",
  "customMetadata": {},
  "imageThumbnailUrl": "string",
  "handle": "string",
  "type": "string",
  "vendor": "string",
  "publishedAtForeign": "string"
}

Schema

idstringrequired

feedIdstringrequired

externalIdstringrequired

titlestringrequired

descriptionstringrequired

urlstringrequired

imageUrlstringrequired

priceMinorintegerrequired

currencystringrequired

inventoryintegerrequired

publishedbooleanrequired

categoriesstring[]required

variantsVariantsItem4[]required

Show child parameters

idstringrequired

itemIdstringrequired

externalIdstringrequired

skustringrequired

titlestringrequired

priceMinorintegerrequired

currencystringrequired

inventoryintegerrequired

urlstringrequired

imageUrlstringrequired

publishedbooleanrequired

inventoryPolicystringrequired

deny | continue

backordersstringrequired

visibilitystringrequired

imageThumbnailUrlstringrequired

customMetadataobjectrequired

updatedAtstringrequired

customMetadataobjectrequired

imageThumbnailUrlstringrequired

handlestringrequired

typestringrequired

vendorstringrequired

publishedAtForeignstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

DELETEhttps://hermeticor.com/v1/catalog/items/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/catalog/items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

5XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

PATCHhttps://hermeticor.com/v1/catalog/items/{id}

Price/stock changes fire back_in_stock and price_drop

Parameters

idstringpathrequired

Request body

application/json

titlestring

descriptionstring

urlstring

imageUrlstring

priceMinorinteger

currencystring

inventoryinteger

publishedboolean

categoriesstring[]

customMetadataobject

imageThumbnailUrlstring

handlestring

typestring

vendorstring

publishedAtForeignstring

{
  "title": "string",
  "description": "string",
  "url": "string",
  "imageUrl": "string",
  "priceMinor": 0,
  "currency": "string",
  "inventory": 0,
  "published": true,
  "categories": [
    "string"
  ],
  "customMetadata": {},
  "imageThumbnailUrl": "string",
  "handle": "string",
  "type": "string",
  "vendor": "string",
  "publishedAtForeign": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/catalog/items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","url":"string","imageUrl":"string","priceMinor":0,"currency":"string","inventory":0,"published":true,"categories":["string"],"customMetadata":{},"imageThumbnailUrl":"string","handle":"string","type":"string","vendor":"string","publishedAtForeign":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/catalog/items/{id}

4XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

5XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

GEThttps://hermeticor.com/v1/catalog/items/{id}/variants

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/catalog/items/{id}/variants" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "itemId": "string",
      "externalId": "string",
      "sku": "string",
      "title": "string",
      "priceMinor": 0,
      "currency": "string",
      "inventory": 0,
      "url": "string",
      "imageUrl": "string",
      "published": true,
      "inventoryPolicy": "deny",
      "backorders": "string",
      "visibility": "string",
      "imageThumbnailUrl": "string",
      "customMetadata": {}
    }
  ],
  "nextCursor": "string"
}

Schema

itemsVariantsItem4[]required

Show child parameters

idstringrequired

itemIdstringrequired

externalIdstringrequired

skustringrequired

titlestringrequired

priceMinorintegerrequired

currencystringrequired

inventoryintegerrequired

urlstringrequired

imageUrlstringrequired

publishedbooleanrequired

inventoryPolicystringrequired

deny | continue

backordersstringrequired

visibilitystringrequired

imageThumbnailUrlstringrequired

customMetadataobjectrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

5XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

POSThttps://hermeticor.com/v1/catalog/items/{id}/variants

Parameters

idstringpathrequired

Request body

application/json

externalIdstringrequired

skustring

titlestringrequired

priceMinorinteger

currencystring

inventoryinteger

urlstring

imageUrlstring

publishedboolean

inventoryPolicystring

deny | continue

backordersstring

visibilitystring

imageThumbnailUrlstring

customMetadataobject

{
  "externalId": "string",
  "sku": "string",
  "title": "string",
  "priceMinor": 0,
  "currency": "string",
  "inventory": 0,
  "url": "string",
  "imageUrl": "string",
  "published": true,
  "inventoryPolicy": "deny",
  "backorders": "string",
  "visibility": "string",
  "imageThumbnailUrl": "string",
  "customMetadata": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/catalog/items/{id}/variants" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"string","sku":"string","title":"string","priceMinor":0,"currency":"string","inventory":0,"url":"string","imageUrl":"string","published":true,"inventoryPolicy":"deny","backorders":"string","visibility":"string","imageThumbnailUrl":"string","customMetadata":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "itemId": "string",
  "externalId": "string",
  "sku": "string",
  "title": "string",
  "priceMinor": 0,
  "currency": "string",
  "inventory": 0,
  "url": "string",
  "imageUrl": "string",
  "published": true,
  "inventoryPolicy": "deny",
  "backorders": "string",
  "visibility": "string",
  "imageThumbnailUrl": "string",
  "customMetadata": {}
}

Schema

idstringrequired

itemIdstringrequired

externalIdstringrequired

skustringrequired

titlestringrequired

priceMinorintegerrequired

currencystringrequired

inventoryintegerrequired

urlstringrequired

imageUrlstringrequired

publishedbooleanrequired

inventoryPolicystringrequired

deny | continue

backordersstringrequired

visibilitystringrequired

imageThumbnailUrlstringrequired

customMetadataobjectrequired

4XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

5XX Default Response

Same as 4XX · PUT /v1/catalog/items/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?