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>

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

Add one code with an optional expiry

Parameters

idstringpathrequired

Request body

application/json

codestringrequired

expiresAtstring

redemptionUrlstring

{
  "code": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "redemptionUrl": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/coupon-pools/{id}/codes/one" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","expiresAt":"2024-01-01T00:00:00Z","redemptionUrl":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

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

Schema

idstringrequired

poolIdstringrequired

codestringrequired

statusstringrequired

active | disabled | redeemed

expiredbooleanrequired

expiresAtstringrequired

assignedProfileIdstringrequired

assignedAtstringrequired

redeemedAtstringrequired

usageCountintegerrequired

redemptionUrlstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

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

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

Mark a code redeemed (from an order event)

Parameters

idstringpathrequired

Request body

application/json

codestringrequired

keystring

{
  "code": "string",
  "key": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/coupon-pools/{id}/codes/redeem" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","key":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/coupon-pools/{id}/codes/one

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

codeIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/coupon-pools/{id}/codes/{codeId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/coupon-pools/{id}/codes/one

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

codeIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/coupon-pools/{id}/codes/{codeId}" \
  -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 · POST /v1/coupon-pools/{id}/codes/one

5XX Default Response

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

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

Disable/enable, set expiry, or assign to / release from a profile

Parameters

idstringpathrequired

codeIdstringpathrequired

Request body

application/json

statusstring

active | disabled

expiresAtstring

profileIdstring

redemptionUrlstring

{
  "status": "active",
  "expiresAt": "2024-01-01T00:00:00Z",
  "profileId": "string",
  "redemptionUrl": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/coupon-pools/{id}/codes/{codeId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"active","expiresAt":"2024-01-01T00:00:00Z","profileId":"string","redemptionUrl":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/coupon-pools/{id}/codes/one

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/web-feeds

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "url": "string",
      "format": "json",
      "refreshHours": 0,
      "method": "GET",
      "requestBody": "string",
      "lastFetchedAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "cached": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem95[]required

Show child parameters

idstringrequired

namestringrequired

urlstringrequired

formatstringrequired

json | rss | xml

refreshHoursintegerrequired

methodstringrequired

GET | POST

requestBodystringrequired

lastFetchedAtstringrequired

lastErrorstringrequired

cachedbooleanrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/web-feeds

JSON or RSS URL fetched on a schedule and cached; first fetch is queued now

Request body

application/json

namestringrequired

urlstringrequired

formatstring

json | rss | xml = json

refreshHoursinteger

= 6

methodstring

GET | POST = GET

requestBodystring

{
  "name": "string",
  "url": "string",
  "format": "json",
  "refreshHours": 6,
  "method": "GET",
  "requestBody": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/web-feeds" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","url":"string","format":"json","refreshHours":6,"method":"GET","requestBody":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "url": "string",
  "format": "json",
  "refreshHours": 0,
  "method": "GET",
  "requestBody": "string",
  "lastFetchedAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "cached": true
}

Schema

idstringrequired

namestringrequired

urlstringrequired

formatstringrequired

json | rss | xml

refreshHoursintegerrequired

methodstringrequired

GET | POST

requestBodystringrequired

lastFetchedAtstringrequired

lastErrorstringrequired

cachedbooleanrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/web-feeds/{id}

Includes the cached body

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "url": "string",
  "format": "json",
  "refreshHours": 0,
  "method": "GET",
  "requestBody": "string",
  "lastFetchedAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "cached": true,
  "cache": {}
}

Schema

idstringrequired

namestringrequired

urlstringrequired

formatstringrequired

json | rss | xml

refreshHoursintegerrequired

methodstringrequired

GET | POST

requestBodystringrequired

lastFetchedAtstringrequired

lastErrorstringrequired

cachedbooleanrequired

cacherequired

4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/web-feeds/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/coupon-pools/{id}/codes/{codeId}

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?