Skip to content

Get a benefit

Request

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.

Security
api_key
Path
idstringrequired

The benefit ID name/type.

curl -i -X GET \
  'https://public.inveterateapi.com/v2.0/storefront/benefits/{id}' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE'

Responses

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

Bodyapplication/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.

Response
{
  "message": "Success",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}