Skip to main content
Print

Endpoint directory

All paths are relative to /v1/account/api.

2.1 Auth & shops (account token unless noted)

Method Path Auth Notes
POST /auth/login — Email + password → account tokens
POST /auth/login/tfa — Complete login when TFA required
POST /auth/refresh — Body: { “refresh_token” }
POST /auth/logout Account Invalidates session
GET /auth/me Account Current account + stores
GET /shops Account List shops for the account
POST /shops Account Create a store
POST /shops/check-availability Account Check name / handle availability
POST /shops/{id}/access-token Account Shop tokens (one-step select store)
POST /shops/auth/refresh — Body: shop { “refresh_token” }

2.2 Catalog (shop token)

Method Path Notes
GET /products List
GET /products/count Count
POST /products Create
GET /products/{id} Read
PUT /products/{id} Update
DELETE /products/{id} Delete
GET /products/{pid}/variants List variants
POST /products/{pid}/variants Create variant
GET /products/{pid}/variants/{vid} Read variant
PUT /products/{pid}/variants/{vid} Update variant
DELETE /products/{pid}/variants/{vid} Delete variant
POST /products/{pid}/images Upload image
POST /products/{pid}/images/{id}/reorder Reorder image
POST /products/bulk-import Async bulk import
GET /products/bulk-import/jobs/{jobId} Import job status
GET /products/export Export
GET /products/generate-sku Suggest SKU
GET /inventory/levels/{lid} Inventory levels
PUT /inventory/levels/{id} Update levels
GET /inventory/stats Inventory stats
GET /collections List
GET /collections/count Count
POST /collections Create
GET /collections/{id} Read
PUT /collections/{id} Update
DELETE /collections/{id} Delete
POST /collections/{id}/images Collection image
POST /collections/{id}/reorder Reorder
POST /collections/{id}/products Add products
DELETE /collections/{id}/products/{pid} Remove product

2.3 Orders (shop token)

Method Path Notes
GET /orders List
GET /orders/stats Stats
GET /orders/{id} Detail
GET /orders/{id}/invoice Invoice
PUT /orders/{id} Update
POST /orders/{id}/fulfill Fulfill
POST /orders/{id}/send-tracking-email Tracking email
POST /orders/{id}/ship-with-shiprocket Shiprocket ship
GET /orders/{id}/shiprocket-couriers Couriers
GET /orders/{id}/shiprocket-pickup-details Pickup details
POST /orders/{id}/schedule-shiprocket-pickup Schedule pickup
PUT /orders/{id}/mark-as-paid Mark paid
PUT /orders/{id}/mark-as-delivered Mark delivered
PUT /orders/{id}/mark-as-ready-pickup Ready for pickup
PUT /orders/{id}/mark-as-picked-up Mark picked up

No cancel or refund endpoints.

2.4 Customers & groups (shop token)

Method Path Notes
GET /customers List
GET /customers/count Count
POST /customers Create
GET /customers/{id} Read
PUT /customers/{id} Update
PUT /customers/{id}/discount Customer discount
DELETE /customers/{id} Delete
GET /customers/{cid}/addresses List addresses
POST /customers/{cid}/addresses Create address
GET /customers/{cid}/addresses/{aid} Read address
PUT /customers/{cid}/addresses/{aid} Update address
DELETE /customers/{cid}/addresses/{aid} Delete address
GET /customers/{cid}/orders Customer orders
GET /customers/{cid}/orders/{oid} Customer order
GET /customers/{cid}/stats Customer stats
GET /customer-groups List groups
GET /customer-groups/count Count
POST /customer-groups Create
GET /customer-groups/{id} Read
PUT /customer-groups/{id} Update
DELETE /customer-groups/{id} Delete
POST /customer-groups/{id}/customers Add members
DELETE /customer-groups/{id}/customers/{cid} Remove member
DELETE /customer-groups/bulk Bulk delete

2.5 Discounts, pages, menus, themes (shop token)

Method Path Notes
POST /discounts/coupons-list List coupons
POST /discounts/coupons Create coupon
GET /discounts/coupons/{id} Read
PUT /discounts/coupons/{id} Update
DELETE /discounts/coupons/{id} Delete
POST /discounts/coupons/bulk Bulk action
GET/PUT dddd dddd
dddd /discounts/thresholds Thresholds
GET/PUT /discounts/settings Settings
POST /discounts/analytics Analytics
GET /navigations/pages List pages
GET /navigations/pages/count Count
GET /navigations/pages/by-handle/{handle} By handle
POST /navigations/pages Create page
GET/PUT/DELETE /navigations/pages/{id} Page CRUD
GET /navigations/menus List menus
GET /navigations/menus/count Count
GET/PUT /navigations/menus/{id} Read / update
GET/POST /themes List / create store theme
GET /themes/settings Theme settings
POST /themes/settings/save Save settings
POST /themes/settings/publish Publish settings
POST /themes/{name}/activate Activate by name
POST /themes/{id}/publish Publish by id
GET/POST /themes/{id} Read / update
GET /theme/file Theme file
POST /theme/file/save Save file
POST /theme/file/revert Revert file

2.6 Shop settings (shop token)

Method Path Notes
GET/PUT /shop General settings
PUT /shop/address Address
POST /uploads Media upload
POST /uploads/finisher Finish upload
POST /uploads/hugerte-file/delete Delete editor file
GET/POST /locations List / create
GET/PUT/DELETE /locations/{id} Location CRUD
PUT /locations/{id}/default Set default
GET/PUT /shipping/profiles/default Default profile
GET/POST /shipping/times Shipping times
GET/PUT/DELETE /shipping/times/{id} Time CRUD
GET /shipping/statuses Statuses
GET /shipping/providers Providers
GET/PUT/DELETE /shipping/providers/{shortname} Provider
GET/PUT /shipping/providers/thecourierguy TheCourierGuy
GET/POST /taxes Tax rates
GET/PUT/DELETE /taxes/{rid} Tax rate CRUD
GET/PUT /settings/payments Gateways list / active cards
DELETE /settings/payments/{shortname} Remove gateway
GET/PUT /settings/payments/{gateway} Per-gateway config (see §8)
GET /settings/integrations List integrations
GET/PUT /settings/integrations/… Pixels, Shiprocket, feeds, … (see §8)
GET/PUT /settings/integrations/webhooks Webhook master switch
GET /settings/integrations/webhooks/events Event catalog
GET/PUT/DELETE /settings/notifications/email-templates… Order emails
GET/POST /settings/staff Staff list / invite
GET/PUT/DELETE /settings/staff/{id} Staff CRUD
GET/POST /settings/domain Domains
GET/PUT/DELETE /settings/domain/{id} Domain CRUD
POST /settings/domain/{id}/refresh Refresh DNS check
POST /settings/domain/{id}/primary Make primary
GET/POST /settings/domain-check Domain availability checks
GET/PUT /checkout/settings Checkout settings
GET /data/countries Countries
GET /data/states/{code} States / provinces
GET /data/timezones Timezones
GET /data/currencies Currencies
GET /data/languages Languages
Scroll to Top