Resellers
List Resellers
Returns the shop's resellers (customers with a reseller status) with their stats.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalstatusstring"applied" | "approved" | "rejected"searchstringMust not be greater than 255 characters.
tier_idintegerperPageintegerMust be at least 1. Must not be greater than 100.
orderColumnstring"email" | "reseller_total_spent_usd" | "reseller_total_completed" | "reseller_applied_at" | "reseller_approved_at" | "balance"orderDirectionstring"asc" | "desc"Path Parameters
shopIdRequiredintegerThe shop ID.
Query Parameters
statusstringFilter by status: applied, approved or rejected.
searchstringSearch by email.
Reseller Stats
Aggregate stats for the shop's reseller program, with 30-day deltas.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
Get Reseller
Detail view: reseller profile, recent reseller orders and balance ledger.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
customerIdRequiredintegerThe shop customer ID.
Remove Reseller
Removes reseller status from a customer. Their dynamic token and API keys stop working.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
customerIdRequiredintegerThe shop customer ID.
Invite Reseller
Creates (or reuses) a customer by email and approves them as a reseller immediately.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredemailRequiredstringThe reseller's email.
tier_idintegerOptional tier to place them in.
Path Parameters
shopIdRequiredintegerThe shop ID.
Approve Application
Approves a pending reseller application and notifies the customer.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionaltier_idintegerOptional tier to place them in.
Path Parameters
shopIdRequiredintegerThe shop ID.
customerIdRequiredintegerThe shop customer ID.
Reject Application
Rejects a pending reseller application and notifies the customer.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
customerIdRequiredintegerThe shop customer ID.
Assign Tier
Assigns a reseller to a tier. Pass a null tier_id to use the default tier.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionaltier_idintegerThe tier ID, or null for the default tier.
Path Parameters
shopIdRequiredintegerThe shop ID.
customerIdRequiredintegerThe shop customer ID.
Update Dynamic Delivery
Enables or disables the reseller's dynamic delivery endpoint (seller-side kill switch).
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredenabledRequiredbooleanWhether the reseller's dynamic delivery endpoint is active.
Path Parameters
shopIdRequiredintegerThe shop ID.
customerIdRequiredintegerThe shop customer ID.