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>

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

Parameters

idstringpathrequired

Request body

application/json

skustring

titlestring

priceMinorinteger

currencystring

inventoryinteger

urlstring

imageUrlstring

publishedboolean

inventoryPolicystring

deny | continue

backordersstring

visibilitystring

imageThumbnailUrlstring

customMetadataobject

{
  "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 PATCH "https://hermeticor.com/v1/catalog/variants/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"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

200 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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

GEThttps://hermeticor.com/v1/catalog/categories

Filter by ids, name (contains) or item; page with nextCursor

Parameters

limitintegerquery

= 100

cursorstringquery

idsstringquery

namestringquery

itemstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/catalog/categories" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "externalId": "string",
      "name": "string",
      "itemCount": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem94[]required

Show child parameters

idstringrequired

externalIdstringrequired

namestringrequired

itemCountintegerrequired

nextCursorstring

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

POSThttps://hermeticor.com/v1/catalog/categories

Request body

application/json

externalIdstringrequired

namestringrequired

{
  "externalId": "string",
  "name": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/catalog/categories" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"string","name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "externalId": "string",
  "name": "string",
  "itemCount": 0
}

Schema

idstringrequired

externalIdstringrequired

namestringrequired

itemCountintegerrequired

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

GEThttps://hermeticor.com/v1/catalog/categories/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/catalog/categories

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

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

Also removes the category from its items

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/catalog/categories/{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 · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

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

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

{
  "name": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/catalog/categories/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/catalog/categories

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

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

The category objects this item is in

Parameters

limitintegerquery

= 100

cursorstringquery

idsstringquery

namestringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/catalog/categories

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

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

op = add | remove | set

Parameters

idstringpathrequired

opstringpathrequired

add | remove | set

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/catalog/items/{id}/categories/{op}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ids": [
    "string"
  ]
}

Schema

idsstring[]required

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/catalog/items/{id}/categories/{op}

4XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

5XX Default Response

Same as 4XX · PATCH /v1/catalog/variants/{id}

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

op = add | remove | set

Parameters

idstringpathrequired

opstringpathrequired

add | remove | set

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/catalog/categories/{id}/items/{op}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java