loyalty

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-loyalty"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/c47a3b2d-9cb6-4aa8-8a09-6a1cefb21e33/social-card.svg?v=3e7ae33eec8b" alt="loyalty" width="600" height="315"></a>
GEThttps://hermeticor.com/hub/{ws}/api/me

Everything the signed-in shopper sees

Parameters

wsstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/hub/{ws}/api/me"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "title": "string",
  "accentColor": "string",
  "shopUrl": "string",
  "sections": {
    "orders": true,
    "wishlist": true,
    "recommendations": true,
    "loyalty": true,
    "preferences": true
  },
  "profile": {
    "firstName": "string",
    "email": "string"
  },
  "orders": [
    {
      "id": "string",
      "number": "string",
      "placedAt": "2024-01-01T00:00:00Z",
      "status": "string",
      "fulfillmentStatus": "string",
      "total": {
        "minor": 0,
        "currency": "string"
      },
      "trackingUrl": "string",
      "shippedAt": "2024-01-01T00:00:00Z",
      "lines": [
        {
          "title": "string",
          "quantity": 0
        }
      ]
    }
  ],
  "wishlist": [
    {
      "productId": "string",
      "title": "string",
      "url": "string",
      "imageUrl": "string"
    }
  ],
  "recommendations": [
    {
      "productId": "string",
      "title": "string",
      "url": "string",
      "imageUrl": "string"
    }
  ],
  "loyalty": {
    "programName": "string",
    "pointsName": "string",
    "balance": 0,
    "tierName": "string",
    "expiringSoon": 0,
    "rewards": [
      {
        "id": "string",
        "name": "string",
        "cost": 0,
        "affordable": true
      }
    ]
  },
  "preferencesUrl": "string"
}
Schema
titlestringrequired
accentColorstringrequired
shopUrlstringrequired
sectionsobjectrequired
Show child parameters
ordersbooleanrequired
wishlistbooleanrequired
recommendationsbooleanrequired
loyaltybooleanrequired
preferencesbooleanrequired
profileobjectrequired
Show child parameters
firstNamestringrequired
emailstringrequired
ordersobject[]required
Show child parameters
idstringrequired
numberstringrequired
placedAtstringrequired
statusstringrequired
fulfillmentStatusstringrequired
totalobjectrequired
Show child parameters
minorintegerrequired
currencystringrequired
trackingUrlstringrequired
shippedAtstringrequired
linesobject[]required
Show child parameters
titlestringrequired
quantityintegerrequired
wishlistobject[]required
Show child parameters
productIdstringrequired
titlestringrequired
urlstringrequired
imageUrlstringrequired
recommendationsobject[]required
Show child parameters
productIdstringrequired
titlestringrequired
urlstringrequired
imageUrlstringrequired
loyaltyobjectrequired
Show child parameters
programNamestringrequired
pointsNamestringrequired
balanceintegerrequired
tierNamestringrequired
expiringSoonintegerrequired
rewardsobject[]required
Show child parameters
idstringrequired
namestringrequired
costintegerrequired
affordablebooleanrequired
preferencesUrlstringrequired
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 /hub/{ws}/api/me

POSThttps://hermeticor.com/hub/{ws}/api/wishlist

Parameters

wsstringpathrequired

Request body

application/json
productIdstringrequired
{
  "productId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/hub/{ws}/api/wishlist" \
  -H "Content-Type: application/json" \
  -d '{"productId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /hub/{ws}/api/me

5XX Default Response

Same as 4XX · GET /hub/{ws}/api/me

DELETEhttps://hermeticor.com/hub/{ws}/api/wishlist/{productId}

Parameters

wsstringpathrequired
productIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/hub/{ws}/api/wishlist/{productId}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /hub/{ws}/api/wishlist

4XX Default Response

Same as 4XX · GET /hub/{ws}/api/me

5XX Default Response

Same as 4XX · GET /hub/{ws}/api/me

POSThttps://hermeticor.com/hub/{ws}/api/redeem

Spend the shopper's points on a reward. Send your own `key` (8-64 of A-Z a-z 0-9 _ -) per redemption: a retry with the same key spends once

Parameters

wsstringpathrequired

Request body

application/json
rewardIdstringrequired
keystring
{
  "rewardId": "string",
  "key": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/hub/{ws}/api/redeem" \
  -H "Content-Type: application/json" \
  -d '{"rewardId":"string","key":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "code": "string",
  "rewardId": "string"
}
Schema
codestringrequired
rewardIdstringrequired
4XX Default Response

Same as 4XX · GET /hub/{ws}/api/me

5XX Default Response

Same as 4XX · GET /hub/{ws}/api/me

Updated