commerce

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-commerce"><img src="https://hermetica.15.204.158.166.sslip.io/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>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/commerce/stores

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/commerce/stores" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "domain": "string",
      "currency": "string",
      "connectionId": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "listId": "string",
      "platform": "string",
      "email": "string",
      "phone": "string",
      "address": {},
      "timezone": "string",
      "primaryLocale": "string",
      "moneyFormat": "string",
      "isSyncing": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

domainstringrequired

currencystringrequired

connectionIdstringrequired

createdAtstringrequired

listIdstringrequired

platformstringrequired

emailstringrequired

phonestringrequired

addressobjectrequired

timezonestringrequired

primaryLocalestringrequired

moneyFormatstringrequired

isSyncingbooleanrequired

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/commerce/stores

POSThttps://hermetica.15.204.158.166.sslip.io/v1/commerce/stores

Request body

application/json

namestringrequired

domainstring

currencystring

connectionIdstring

listIdstring

platformstring

emailstring

phonestring

addressobject

Show child parameters

namestring

address1string

address2string

citystring

provincestring

provinceCodestring

postalCodestring

countrystring

countryCodestring

phonestring

companystring

timezonestring

primaryLocalestring

moneyFormatstring

isSyncingboolean

{
  "name": "string",
  "domain": "string",
  "currency": "string",
  "connectionId": "string",
  "listId": "string",
  "platform": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  },
  "timezone": "string",
  "primaryLocale": "string",
  "moneyFormat": "string",
  "isSyncing": true
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/commerce/stores" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","domain":"string","currency":"string","connectionId":"string","listId":"string","platform":"string","email":"string","phone":"string","address":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"},"timezone":"string","primaryLocale":"string","moneyFormat":"string","isSyncing":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "currency": "string",
  "connectionId": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "listId": "string",
  "platform": "string",
  "email": "string",
  "phone": "string",
  "address": {},
  "timezone": "string",
  "primaryLocale": "string",
  "moneyFormat": "string",
  "isSyncing": true
}

Schema

idstringrequired

namestringrequired

domainstringrequired

currencystringrequired

connectionIdstringrequired

createdAtstringrequired

listIdstringrequired

platformstringrequired

emailstringrequired

phonestringrequired

addressobjectrequired

timezonestringrequired

primaryLocalestringrequired

moneyFormatstringrequired

isSyncingbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/commerce/stores

5XX Default Response

Same as 4XX · GET /v1/commerce/stores

POSThttps://hermetica.15.204.158.166.sslip.io/v1/commerce/activate

Turn ecommerce on: creates the first store if the workspace has none (safe to repeat)

Request body

application/json

namestring

currencystring

{
  "name": "string",
  "currency": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/commerce/activate" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","currency":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "store": {
    "id": "string",
    "name": "string",
    "domain": "string",
    "currency": "string",
    "connectionId": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "listId": "string",
    "platform": "string",
    "email": "string",
    "phone": "string",
    "address": {},
    "timezone": "string",
    "primaryLocale": "string",
    "moneyFormat": "string",
    "isSyncing": true
  },
  "created": true
}

Schema

storeobjectrequired

Show child parameters

idstringrequired

namestringrequired

domainstringrequired

currencystringrequired

connectionIdstringrequired

createdAtstringrequired

listIdstringrequired

platformstringrequired

emailstringrequired

phonestringrequired

addressobjectrequired

timezonestringrequired

primaryLocalestringrequired

moneyFormatstringrequired

isSyncingbooleanrequired

createdbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/commerce/stores

5XX Default Response

Same as 4XX · GET /v1/commerce/stores

GEThttps://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}

Parameters

storeIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores

4XX Default Response

Same as 4XX · GET /v1/commerce/stores

5XX Default Response

Same as 4XX · GET /v1/commerce/stores

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}

Parameters

storeIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}" \
  -H "Authorization: Bearer $SSLIP_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/commerce/stores

5XX Default Response

Same as 4XX · GET /v1/commerce/stores

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}

Parameters

storeIdstringpathrequired

Request body

application/json

namestring

domainstring

currencystring

connectionIdstring

listIdstring

platformstring

emailstring

phonestring

addressobject

Show child parameters

namestring

address1string

address2string

citystring

provincestring

provinceCodestring

postalCodestring

countrystring

countryCodestring

phonestring

companystring

timezonestring

primaryLocalestring

moneyFormatstring

isSyncingboolean

{
  "name": "string",
  "domain": "string",
  "currency": "string",
  "connectionId": "string",
  "listId": "string",
  "platform": "string",
  "email": "string",
  "phone": "string",
  "address": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  },
  "timezone": "string",
  "primaryLocale": "string",
  "moneyFormat": "string",
  "isSyncing": true
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","domain":"string","currency":"string","connectionId":"string","listId":"string","platform":"string","email":"string","phone":"string","address":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"},"timezone":"string","primaryLocale":"string","moneyFormat":"string","isSyncing":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/commerce/stores

4XX Default Response

Same as 4XX · GET /v1/commerce/stores

5XX Default Response

Same as 4XX · GET /v1/commerce/stores

GEThttps://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}/stats

Parameters

storeIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/commerce/stores/{storeId}/stats" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "orders": 0,
  "revenueMinor": 0,
  "refundedMinor": 0,
  "aovMinor": 0,
  "openCarts": 0,
  "abandonedCarts": 0
}

Schema

ordersintegerrequired

revenueMinorintegerrequired

refundedMinorintegerrequired

aovMinorintegerrequired

openCartsintegerrequired

abandonedCartsintegerrequired

4XX Default Response

Same as 4XX · GET /v1/commerce/stores

5XX Default Response

Same as 4XX · GET /v1/commerce/stores

Next part

Updated Nov 3, 2026

Was this page helpful?