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.

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

GET/v2.0/storefront/benefits

Header parameters

Response

200400500

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

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurl

const response = await fetch('/v2.0/storefront/benefits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

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.

GET/v2.0/storefront/benefits/{id}

Path parameters

id*string

The benefit ID name/type.

Header parameters

Response

200400500

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

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurl

const response = await fetch('/v2.0/storefront/benefits/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}