commerce

Embed
Preview of the card
<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}

Change only the fields sent

Parameters

storeIdstringpathrequired
productIdstringpathrequired

Request body

application/json
titlestring
descriptionstring
urlstring
imageUrlstring
priceMinorinteger
currencystring
inventoryinteger
publishedboolean
categoriesstring[]
customMetadataobject
imageThumbnailUrlstring
handlestring
typestring
vendorstring
publishedAtForeignstring
{
  "title": "string",
  "description": "string",
  "url": "string",
  "imageUrl": "string",
  "priceMinor": 0,
  "currency": "string",
  "inventory": 0,
  "published": true,
  "categories": [
    "string"
  ],
  "customMetadata": {},
  "imageThumbnailUrl": "string",
  "handle": "string",
  "type": "string",
  "vendor": "string",
  "publishedAtForeign": "2024-01-01T00:00:00Z"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","description":"string","url":"string","imageUrl":"string","priceMinor":0,"currency":"string","inventory":0,"published":true,"categories":["string"],"customMetadata":{},"imageThumbnailUrl":"string","handle":"string","type":"string","vendor":"string","publishedAtForeign":"2024-01-01T00:00:00Z"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 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
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}

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

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}/variants" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "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": {}
    }
  ],
  "nextCursor": "string"
}
Schema
itemsVariantsItem4[]required
Show child parameters
idstringrequired
itemIdstringrequired
externalIdstringrequired
skustringrequired
titlestringrequired
priceMinorintegerrequired
currencystringrequired
inventoryintegerrequired
urlstringrequired
imageUrlstringrequired
publishedbooleanrequired
inventoryPolicystringrequired
deny | continue
backordersstringrequired
visibilitystringrequired
imageThumbnailUrlstringrequired
customMetadataobjectrequired
nextCursorstringrequired
4XX Default Response

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

5XX Default Response

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

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

Add a variant to a store product under its store id

Parameters

storeIdstringpathrequired
productIdstringpathrequired

Request body

application/json
skustring
titlestringrequired
priceMinorinteger
currencystring
inventoryinteger
urlstring
imageUrlstring
publishedboolean
inventoryPolicystring
deny | continue
backordersstring
visibilitystring
imageThumbnailUrlstring
customMetadataobject
idstringrequired
{
  "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": {},
  "id": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/variants" \
  -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":{},"id":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 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

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

5XX Default Response

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

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

Create or replace a variant of a store product

Parameters

storeIdstringpathrequired
productIdstringpathrequired
variantIdstringpathrequired

Request body

application/json
skustring
titlestringrequired
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 PUT "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
Go
PHP
Ruby
Java

Responses

200 Default Response

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

4XX Default Response

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

5XX Default Response

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

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

Parameters

storeIdstringpathrequired
productIdstringpathrequired
variantIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/commerce/stores/{storeId}/products/{productId}/variants/{variantId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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}

5XX Default Response

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

Updated