Benefits

This set of benefit endpoints should only be used by merchant that have Tiers disabled. Benefit access for merchants that have enabled Tiers can be found in the Tiers tab in this API reference.

get

Returns all benefits for a given merchant. Merchant is pulled from the public API key for security reasons.

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
get
GET /v2.0/storefront/benefits HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*
{
  "message": "text",
  "data": {}
}
get

Returns a single benefit for a given merchant. Merchant is pulled from the public API key for security reasons. The benefit ID is the type of benefit. For a list of possible benefit types, see the default values in the schema list.

Path parameters
idstringRequired

The benefit ID name/type.

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
get
GET /v2.0/storefront/benefits/{id} HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*
{
  "message": "text",
  "data": {}
}

Was this helpful?