Tiers

These endpoints only work for merchants with tiers enabled. Access benefits via this set of endpoints.

get

Returns a single tier/segment for a given merchant and customer. Merchant is pulled from the public API key for security reasons.

Path parameters

idstringRequired

The customer ID.

Query parameters

includeBenefitsbooleanOptional

Whether or not to include benefits in the response.

Header parameters

X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Responses

200

Returned upon successful direct action to our database. Action is immediate.

application/json

messagestringRequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectRequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

400

Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.

application/json

500

Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.

application/json

get

/v2.0/storefront/tiers/{id}

HTTPcURLJavaScriptPython

GET /v2.0/storefront/tiers/{id} HTTP/1.1
X-Inveterate-Api-Key: text
Accept: */*

{
  "message": "text",
  "data": {}
}