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>

GEThttps://hermeticor.com/v1/catalog/bulk-jobs

Filter by resource, op and status; page with nextCursor

Parameters

resourcestringquery

items | variants | categories | coupon_codes

opstringquery

create | update | delete

statusstringquery

queued | processing | complete | failed

cursorstringquery

limitintegerquery

= 50

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "resource": "items",
      "op": "create",
      "status": "queued",
      "total": 0,
      "succeeded": 0,
      "failed": 0,
      "errors": [
        {
          "index": 0,
          "message": "string"
        }
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsPostV1CatalogBulkJobsResponse[]required

Show child parameters

idstringrequired

resourcestringrequired

items | variants | categories | coupon_codes

opstringrequired

create | update | delete

statusstringrequired

queued | processing | complete | failed

totalintegerrequired

succeededintegerrequired

failedintegerrequired

errorsErrorsItem3[]required

Show child parameters

indexintegerrequired

messagestringrequired

createdAtstringrequired

completedAtstringrequired

nextCursorstring

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/catalog/bulk-jobs

POSThttps://hermeticor.com/v1/catalog/bulk-jobs

Queue up to 1000 records; poll GET /v1/catalog/bulk-jobs/{id}

Request body

application/json

resourcestringrequired

items | variants | categories | coupon_codes

opstringrequired

create | update | delete

recordsobject[]required

poolIdstring

{
  "resource": "items",
  "op": "create",
  "records": [
    {}
  ],
  "poolId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/catalog/bulk-jobs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resource":"items","op":"create","records":[{}],"poolId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "resource": "items",
  "op": "create",
  "status": "queued",
  "total": 0,
  "succeeded": 0,
  "failed": 0,
  "errors": [
    {
      "index": 0,
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

resourcestringrequired

items | variants | categories | coupon_codes

opstringrequired

create | update | delete

statusstringrequired

queued | processing | complete | failed

totalintegerrequired

succeededintegerrequired

failedintegerrequired

errorsErrorsItem3[]required

Show child parameters

indexintegerrequired

messagestringrequired

createdAtstringrequired

completedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

5XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

GEThttps://hermeticor.com/v1/catalog/bulk-jobs/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/catalog/bulk-jobs

4XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

5XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "kind": "string",
  "lowStockThreshold": 0,
  "total": 0,
  "available": 0,
  "description": "string",
  "discountType": "string",
  "amount": 0,
  "target": "string",
  "startsAt": "2024-01-01T00:00:00Z",
  "endsAt": "2024-01-01T00:00:00Z",
  "enabled": true,
  "redemptionUrl": "string",
  "maxUses": 0
}

Schema

idstringrequired

namestringrequired

kindstringrequired

lowStockThresholdintegerrequired

totalintegerrequired

availableintegerrequired

descriptionstringrequired

discountTypestringrequired

amountintegerrequired

targetstringrequired

startsAtstringrequired

endsAtstringrequired

enabledbooleanrequired

redemptionUrlstringrequired

maxUsesintegerrequired

4XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

5XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

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

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/coupon-pools/{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 · GET /v1/catalog/bulk-jobs

5XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

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

Rename, set threshold, or edit the promo rule (type, amount, target, dates, enabled)

Parameters

idstringpathrequired

Request body

application/json

namestring

lowStockThresholdinteger

descriptionstring

discountTypestring

fixed | percentage | shipping

amountinteger

targetstring

per_item | total | shipping

startsAtstring

endsAtstring

enabledboolean

redemptionUrlstring

maxUsesinteger

{
  "name": "string",
  "lowStockThreshold": 0,
  "description": "string",
  "discountType": "fixed",
  "amount": 0,
  "target": "per_item",
  "startsAt": "2024-01-01T00:00:00Z",
  "endsAt": "2024-01-01T00:00:00Z",
  "enabled": true,
  "redemptionUrl": "string",
  "maxUses": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/coupon-pools/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","lowStockThreshold":0,"description":"string","discountType":"fixed","amount":0,"target":"per_item","startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z","enabled":true,"redemptionUrl":"string","maxUses":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/coupon-pools/{id}

4XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

5XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

GEThttps://hermeticor.com/v1/coupon-codes

Codes across every pool: by profile, status, expiry range

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

active | disabled | redeemed

assignedstringquery

true | false

qstringquery

profileIdstringquery

expiresFromstringquery

expiresTostringquery

poolIdstringquery

Code samples

cURL

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

TypeScript

Python

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

Same as 4XX · GET /v1/catalog/bulk-jobs

5XX Default Response

Same as 4XX · GET /v1/catalog/bulk-jobs

Next part

Updated Nov 8, 2026

Was this page helpful?