commerce

Embed

<a href="https://hermeticor.com/docs/ref-commerce"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a95d6f25-c648-492d-bcb5-a74907109222/social-card.svg?v=3e7ae33eec8b" alt="commerce" width="600" height="315"></a>

PATCHhttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

Change only the fields sent

Parameters

storeIdstringpathrequired

productIdstringpathrequired

variantIdstringpathrequired

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/commerce/stores/{storeId}/products/{productId}/variants/{variantId}" \
  -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/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

storeIdstringpathrequired

productIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "url": "string",
      "variantIds": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem142[]required

Show child parameters

idstringrequired

urlstringrequired

variantIdsstring[]required

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

POSThttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images

Parameters

storeIdstringpathrequired

productIdstringpathrequired

Request body

application/json

idstringrequired

urlstringrequired

variantIdsstring[]

{
  "id": "string",
  "url": "string",
  "variantIds": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"string","url":"string","variantIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "url": "string",
  "variantIds": [
    "string"
  ]
}

Schema

idstringrequired

urlstringrequired

variantIdsstring[]required

4XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}

Parameters

storeIdstringpathrequired

productIdstringpathrequired

imageIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores/{storeId}/products/{productId}/images

4XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

PUThttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}

Parameters

storeIdstringpathrequired

productIdstringpathrequired

imageIdstringpathrequired

Request body

application/json

urlstringrequired

variantIdsstring[]

{
  "url": "string",
  "variantIds": [
    "string"
  ]
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","variantIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores/{storeId}/products/{productId}/images

4XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

DELETEhttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}

Parameters

storeIdstringpathrequired

productIdstringpathrequired

imageIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}" \
  -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/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

PATCHhttps://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}

Parameters

storeIdstringpathrequired

productIdstringpathrequired

imageIdstringpathrequired

Request body

application/json

urlstring

variantIdsstring[]

{
  "url": "string",
  "variantIds": [
    "string"
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/images/{imageId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","variantIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores/{storeId}/products/{productId}/images

4XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

GEThttps://hermeticor.com/v1/commerce/attribution/metrics

Parameters

storeIdstringquery

sincestringquery

untilstringquery

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/commerce/attribution/metrics" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "orders": 0,
      "revenueMinor": 0,
      "refundedMinor": 0,
      "aovMinor": 0,
      "conversionSource": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

ordersintegerrequired

revenueMinorintegerrequired

refundedMinorintegerrequired

aovMinorintegerrequired

conversionSourcestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

5XX Default Response

Same as 4XX · PATCH /v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}

Next part

Updated Nov 8, 2026

Was this page helpful?