Store Overview - HoopAI Help Center

The HoopAI Platform Store API lets you configure every aspect of your e-commerce store infrastructure. Use it to manage shipping zones and rates, set up shipping carriers, update store-wide settings, track onboarding setup progress, expose store details to customer-facing portals, manage customer wishlists, and control Shopify import and sync — all through a single authenticated REST API.

Base URL

https://services.leadconnectorhq.com

Authentication

Every request must include a Bearer token and the API version header.

Authorization: Bearer <access_token>
Version: 2021-07-28

See OAuth 2.0 for details on obtaining an access token.

OAuth scopes

All Store API endpoints use the Location-Access scheme.

Scope	Access
`store/setting.readonly`	Read store settings
`store/setting.write`	Create and update store settings
`store/shipping.readonly`	Read shipping zones, rates, and carriers
`store/shipping.write`	Create, update, and delete shipping zones, rates, and carriers

Quick start

Retrieve the current store settings for a location:

curl -X GET "https://services.leadconnectorhq.com/store/store-setting?altId=<locationId>&altType=location" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"

Endpoints

Method	Path	Description
`GET`	`/store/setup/progress`	Endpoint to get the progress of store setup
`PUT`	`/store/setup/progress`	Endpoint to update the store setup progress
`POST`	`/store/store-setting`	Create/Update Store Settings
`GET`	`/store/store-setting`	Get Store Settings
`POST`	`/store/shipping-zone`	Create Shipping Zone
`GET`	`/store/shipping-zone`	List Shipping Zones
`GET`	`/store/shipping-zone/{shippingZoneId}`	Get Shipping Zone
`PUT`	`/store/shipping-zone/{shippingZoneId}`	Update Shipping Zone
`DELETE`	`/store/shipping-zone/{shippingZoneId}`	Delete shipping zone
`POST`	`/store/shipping-zone/shipping-rates`	Get available shipping rates
`POST`	`/store/shipping-zone/{shippingZoneId}/shipping-rate`	Create Shipping Rate
`GET`	`/store/shipping-zone/{shippingZoneId}/shipping-rate`	List Shipping Rates
`GET`	`/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}`	Get Shipping Rate
`PUT`	`/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}`	Update Shipping Rate
`DELETE`	`/store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}`	Delete shipping rate
`POST`	`/store/shipping-carrier`	Create Shipping Carrier
`GET`	`/store/shipping-carrier`	List Shipping Carriers
`GET`	`/store/shipping-carrier/{shippingCarrierId}`	Get Shipping Carrier
`PUT`	`/store/shipping-carrier/{shippingCarrierId}`	Update Shipping Carrier
`DELETE`	`/store/shipping-carrier/{shippingCarrierId}`	Delete shipping carrier
`GET`	`/store/customer-access-center/store/{funnelId}`	Get Store Details
`GET`	`/store/customer-access-center/wishlist`	Get all the wishlisted products
`POST`	`/store/customer-access-center/wishlist/status`	Get Wishlist Status
`POST`	`/store/customer-access-center/wishlist/{productId}`	Add product from wishlist
`DELETE`	`/store/customer-access-center/wishlist/{productId}`	Delete product from wishlist
`POST`	`/store/shopify/{altId}`	Toggle Shopify Import and Sync
`GET`	`/store/shopify/health/{altId}`	Get Shopify Integration Health

Products API — Create and manage the products available in your store
Payments API — Process orders and handle payment integrations
Invoices API — Generate and send invoices for store transactions

​Base URL

​Authentication

​OAuth scopes

​Quick start

​Endpoints

​Related

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

Related