Benefits

This endpoint will return all benefits for a merchant under a given tier. It will return an array of benefits. Each benefit will have a type field that will identify the type of benefit.

GET/v2.0/admin/tiers/{id}/benefits

Path parameters

id*string

The tier segment ID.

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

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/tiers/{id}/benefits', {
    method: 'GET',
    headers: {
      "X-Inveterate-Api-Key": "text"
    },
});
const data = await response.json();

Response

200400500

{
  "message": "text"
}

This endpoint will return one specific benefit given a benefit type and segment ID. Note that the benefit type is a string character. For a list of all benefit types, look at the default type value in each schema.

GET/v2.0/admin/tiers/{id}/benefits/{type}

Path parameters

id*string

The tier segment ID.

type*string

The benefit 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

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/tiers/{id}/benefits/{type}', {
    method: 'GET',
    headers: {
      "X-Inveterate-Api-Key": "text"
    },
});
const data = await response.json();

Response

200400500

{
  "message": "text"
}

This endpoint will take a benefit type, segment ID, and any other values in the relevant schema and send a request to our backend to update the benefit with the new information. Keep in mind that, like with the POST method, this is a request against our backend. Thus, the effect will not be immediate.

PATCH/v2.0/admin/tiers/{id}/benefits/{type}

Path parameters

id*string

The tier segment ID.

type*string

The benefit identification name/type.

Header parameters

Body

application/json

one of

SignupStoreCreditsDto (object)RecurringStoreCreditsDto (object)CreditsforOrdersDto (object)AnniversaryCreditsDto (object)StoreCreditsforReferralDto (object)FreeShippingDto (object)MemberOnlyDiscountDto (object)SignupDiscountDto (object)MemberPricingDto (object)EarlyAccessCampaignDto (object)

Response

201400500

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

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

JavaScriptCurlPython

const response = await fetch('/v2.0/admin/tiers/{id}/benefits/{type}', {
    method: 'PATCH',
    headers: {
      "X-Inveterate-Api-Key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "creditAmount": 0,
      "name": "text",
      "days": 0,
      "description": "text"
    }),
});
const data = await response.json();

Response

201400500

{
  "message": "text"
}