Affiliate Tiers
List Tiers
Returns the shop's affiliate tiers with their product overrides and member counts.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
Create Tier
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringThe tier name.
percentageRequirednumberCommission percentage for the tier.
discount_percentageRequirednumberDiscount buyers get when using a code of this tier.
is_publicRequiredbooleanPublic tiers are shown on the storefront affiliate page.
sort_orderintegerMust be at least 0. Must not be greater than 1000.
Path Parameters
shopIdRequiredintegerThe shop ID.
Delete Tier
Deletes a tier. Its members fall back to the default tier. The default tier cannot be deleted.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
tierIdRequiredintegerThe tier ID.
Update Tier
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 100 characters.
percentageRequirednumberMust be at least 0. Must not be greater than 100.
discount_percentageRequirednumberMust be at least 0. Must not be greater than 100.
is_publicRequiredbooleansort_orderintegerMust be at least 0. Must not be greater than 1000.
Path Parameters
shopIdRequiredintegerThe shop ID.
tierIdRequiredintegerThe tier ID.
Set Tier Product Overrides
Replaces the tier's per-product percentage overrides. An override of 0 excludes the product for this tier.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredproductsRequiredarray<object>The overrides.
Path Parameters
shopIdRequiredintegerThe shop ID.
tierIdRequiredintegerThe tier ID.