catalog

Embed
Preview of the card
<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>
GEThttps://hermeticor.com/v1/coupon-pools/{id}/codes

Parameters

limitintegerquery
= 50
cursorstringquery
statusstringquery
active | disabled | redeemed
assignedstringquery
true | false
qstringquery
profileIdstringquery
expiresFromstringquery
expiresTostringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/coupon-pools/{id}/codes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "poolId": "string",
      "code": "string",
      "status": "active",
      "expired": true,
      "expiresAt": "2024-01-01T00:00:00Z",
      "assignedProfileId": "string",
      "assignedAt": "2024-01-01T00:00:00Z",
      "redeemedAt": "2024-01-01T00:00:00Z",
      "usageCount": 0,
      "redemptionUrl": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem91[]required
Show child parameters
idstringrequired
poolIdstringrequired
codestringrequired
statusstringrequired
active | disabled | redeemed
expiredbooleanrequired
expiresAtstringrequired
assignedProfileIdstringrequired
assignedAtstringrequired
redeemedAtstringrequired
usageCountintegerrequired
redemptionUrlstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

POSThttps://hermeticor.com/v1/coupon-pools/{id}/codes

Parameters

idstringpathrequired

Request body

application/json
codesstring[]required
{
  "codes": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/coupon-pools/{id}/codes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"codes":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "added": 0
}
Schema
addedintegerrequired
4XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

5XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

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

Search items across every feed and API-written products

Parameters

limitintegerquery
= 50
cursorstringquery
qstringquery
categorystringquery
feedIdstringquery
inStockstringquery
true | false
idsstringquery
publishedstringquery
true | false
sortstringquery
created | -created | updated | -updated = created

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/catalog/items" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem92[]required
Show child parameters
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
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

5XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

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

Request body

application/json
externalIdstringrequired
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
customMetadataobject
imageThumbnailUrlstring
handlestring
typestring
vendorstring
publishedAtForeignstring
{
  "externalId": "string",
  "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 POST "https://hermeticor.com/v1/catalog/items" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"string","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
Go
PHP
Ruby
Java

Responses

201 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

Same as 4XX · GET /v1/coupon-pools/{id}/codes

5XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

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

By row id or external id

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/catalog/items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/catalog/items

4XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

5XX Default Response

Same as 4XX · GET /v1/coupon-pools/{id}/codes

Updated