LogoLogo
  • Inveterate Dev Docs
  • API Reference Docs
    • Public API 2.0 Reference
      • Admin
        • Benefits
        • Members
          • Credits
        • Merchant
        • Tiers
          • Benefits
          • Campaigns
        • Webhooks
      • Storefront
        • Members
          • Credits
            • Redemption
          • Cancellation
        • Benefits
        • Tiers
          • Benefits
          • Campaigns
        • Specification
      • Schemas
    • [LEGACY] Public API Reference
      • Benefits API
      • Campaigns API
      • Customers API
      • Merchant API
      • Credits API
      • Free tiers API
      • Webhooks
  • Stack Reference Docs
    • Landing Page
    • Storefront
      • Properties
      • Customizations
        • Add To Cart Button
    • Customer Metafields
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Reference Docs
  2. Public API 2.0 Reference
  3. Admin

Tiers

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

PreviousMerchantNextBenefits

Last updated 1 year ago

Was this helpful?

get

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

Query parameters
includeBenefitsbooleanOptional

Whether or not to include benefits in the response.

Header parameters
X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Responses
get
GET /v2.0/admin/tiers HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*

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

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

Path parameters
idstringRequired

The tier segment 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
get
GET /v2.0/admin/tiers/{id} HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*

{
  "message": "text",
  "data": {}
}
  • GET/v2.0/admin/tiers
  • GET/v2.0/admin/tiers/{id}