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>
GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/bought-together

Pairs of products that are bought in the same order

Parameters

limitintegerquery
= 20
sincestringquery
untilstringquery
storeIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/bought-together" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "productA": "string",
      "titleA": "string",
      "productB": "string",
      "titleB": "string",
      "orders": 0
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
productAstringrequired
titleAstringrequired
productBstringrequired
titleBstringrequired
ordersintegerrequired
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/{storeId}/bought-together

GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/product-rankings

Best-selling products across the whole store

Parameters

bystringquery
revenue | units = revenue
limitintegerquery
= 20
sincestringquery
untilstringquery
storeIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/product-rankings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "productId": "string",
      "title": "string",
      "units": 0,
      "revenueMinor": 0,
      "orders": 0
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
productIdstringrequired
titlestringrequired
unitsintegerrequired
revenueMinorintegerrequired
ordersintegerrequired
4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/bought-together

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/bought-together

GEThttps://hermeticor.com/v1/commerce/orders

Parameters

limitintegerquery
= 50
cursorstringquery
statusstringquery
pending | paid | shipped | cancelled | refunded
profileIdstringquery
emailstringquery
promoCodestringquery
conversionSourcestringquery
campaignIdstringquery
sincestringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/commerce/orders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "storeId": "string",
      "externalId": "string",
      "profileId": "string",
      "email": "string",
      "status": "pending",
      "currency": "string",
      "totalMinor": 0,
      "discountMinor": 0,
      "taxMinor": 0,
      "shippingMinor": 0,
      "refundedMinor": 0,
      "promoCode": "string",
      "promoPoolId": "string",
      "campaignId": "string",
      "conversionSource": "string",
      "trackingUrl": "string",
      "placedAt": "2024-01-01T00:00:00Z",
      "landingPageId": "string",
      "adRef": "string",
      "clickId": "string",
      "utm": {},
      "shippingAddress": {},
      "billingAddress": {},
      "orderUrl": "string",
      "financialStatus": "string",
      "fulfillmentStatus": "string",
      "shippedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem140[]required
Show child parameters
idstringrequired
storeIdstringrequired
externalIdstringrequired
profileIdstringrequired
emailstringrequired
statusstringrequired
pending | paid | shipped | cancelled | refunded
currencystringrequired
totalMinorintegerrequired
discountMinorintegerrequired
taxMinorintegerrequired
shippingMinorintegerrequired
refundedMinorintegerrequired
promoCodestringrequired
promoPoolIdstringrequired
campaignIdstringrequired
conversionSourcestringrequired
trackingUrlstringrequired
placedAtstringrequired
landingPageIdstringrequired
adRefstringrequired
clickIdstringrequired
utmobjectrequired
shippingAddressobjectrequired
billingAddressobjectrequired
orderUrlstringrequired
financialStatusstringrequired
fulfillmentStatusstringrequired
shippedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/bought-together

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/bought-together

GEThttps://hermeticor.com/v1/commerce/stores/{storeId}/orders

Parameters

limitintegerquery
= 50
cursorstringquery
statusstringquery
pending | paid | shipped | cancelled | refunded
profileIdstringquery
emailstringquery
promoCodestringquery
conversionSourcestringquery
campaignIdstringquery
sincestringquery
storeIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/commerce/stores/{storeId}/orders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/commerce/orders

4XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/bought-together

5XX Default Response

Same as 4XX · GET /v1/commerce/stores/{storeId}/bought-together

Updated