Platform API v1 Reference

Complete endpoint reference for the Huntrecht Platform API v1.

Base URL: /api/v1. See Authentication for the OAuth2 client-credentials flow.

Scopes

Request scopes at token time; tokens carry only granted scopes (subset of the client's configured scopes).

• read
• write
• orders:read
• orders:write
• payments:read
• payments:write
• subscriptions:read
• subscriptions:write
• users:read
• users:write
• credit:read
• kyc:read
• kyc:write
• quotes:read
• quotes:write
• storefront:read
• storefront:write
• price_drops:read

Endpoints

app-proxy

Method	Path	Scopes	Description
GET	/app-proxy/collections	—	Proxy endpoint for fetching collections via App Proxy.
GET	/app-proxy/collections/{handle}	—	Proxy endpoint for fetching a single collection with products. HMAC verified.
GET	/app-proxy/payment-methods	—	Get available payment methods based on customer role and product eligibility.
GET	/app-proxy/price-drops	—	Proxy endpoint for fetching price drops for theme display.

auth

Method	Path	Scopes	Description
POST	/auth/revoke	—	Revoke an access or refresh token
POST	/auth/token	—	Obtain an access token using client credentials.

clients

Method	Path	Scopes	Description
GET	/clients	—	List all API clients for the authenticated user.
POST	/clients	—	Create a new API client and return credentials.
DELETE	/clients/{client_id}	—	Delete an API client. This action is irreversible.
PATCH	/clients/{client_id}	—	Update API client settings
POST	/clients/{client_id}/rotate	—	Rotate the client secret. Invalidates the old secret immediately.

credit

Method	Path	Scopes	Description
POST	/credit/assess	credit:read, read	Assess Credit Risk
GET	/credit/score/{customer_email}	credit:read, read	Get Credit Score

greencloud

Method	Path	Scopes	Description
GET	/greencloud/pricing	—	Public GreenCloud pricing feed

kyc

Method	Path	Scopes	Description
GET	/kyc	kyc:read, read	List KYC Submissions
POST	/kyc	kyc:write, write	Submit KYC
GET	/kyc/{submission_id}	kyc:read, read	Get KYC Submission

linked-payments

Method	Path	Scopes	Description
GET	/linked-payments/check-eligibility	—	Check Payment Eligibility
POST	/linked-payments/link-bank	payments:write, write	Link Bank Account
POST	/linked-payments/link-wallet	payments:write, write	Link Crypto Wallet
GET	/linked-payments/linked-accounts/{customer_id}	payments:read, read	Get Linked Accounts

orders

Method	Path	Scopes	Description
GET	/orders	orders:read, read	List Orders
POST	/orders	orders:write, write	Create Order
GET	/orders/{order_id}	orders:read, read	Get Order

payments

Method	Path	Scopes	Description
GET	/payments	payments:read, read	List Payments
POST	/payments	payments:write, write	Create Payment
GET	/payments/{payment_id}	payments:read, read	Get Payment

price-drops

Method	Path	Scopes	Description
GET	/price-drops	—	List Price Drops
GET	/price-drops/featured	—	Featured Price Drops

quotes

Method	Path	Scopes	Description
GET	/quotes	quotes:read, read	List Quotes
POST	/quotes	quotes:write, write	Create Quote
GET	/quotes/{quote_id}	quotes:read, read	Get Quote

storefront

Method	Path	Scopes	Description
GET	/storefront/collections	read, storefront:read	List Collections
GET	/storefront/collections/{handle}	read, storefront:read	Get Collection
GET	/storefront/products	read, storefront:read	List Products
GET	/storefront/products/{handle}	read, storefront:read	Get Product
GET	/storefront/search	read, storefront:read	Search Products

subscriptions

Method	Path	Scopes	Description
GET	/subscriptions	read, subscriptions:read	List Subscriptions
GET	/subscriptions/{subscription_id}	read, subscriptions:read	Get Subscription

users

Method	Path	Scopes	Description
GET	/users/me	read, users:read	Get Current User
GET	/users/{user_id}	read, users:read	Get User Profile

Versioning

URL versioning (/api/v1/). New versions ship with advance deprecation notice; previous versions keep serving until the announced sunset.