1. Dashboard API
Shanta API
  • Get Started
  • Authorization
  • Responses
  • Pagination
  • Rate Limiting
  • Languages
  • Support
  • APIs
    • Account balance
      • List balances
      • List transactions
      • List charges
      • Create charge
      • Create transfer
    • Affiliate marketers
      • Update affiliator status
    • Attachments
      • Delete attachment
    • Blog
      • Update blog topic image
      • Detach blog topic attachment
      • Update blog topic status
      • Update blog taxonomy status
    • Branches
      • Update branch
    • Brands
      • List brands
      • Update brand
    • Categories
      • List categories
      • Get category
    • Countries
      • List countries
      • List cities
    • Coupons
      • Update coupon status
    • Customer groups
      • List customer groups
      • Update customer group
    • Customers
      • List customers
      • Create customer
      • Get customer
      • Update customer
    • Marketing campaigns
      • Create campaign condition
      • Update campaign condition
      • Delete campaign condition
    • Notifications
      • List notifications
      • Mark all notifications as read
      • Read notification
      • Update notification setting status
    • Offers
      • Update cross selling offer status
      • Update up selling offer status
      • Update quantity discount status
    • Orders
      • Get orders stats
      • List orders
      • Create order
      • Get order
      • Update order
      • Delete order
      • List order items
      • Update order status
      • Update allow to open package
      • Print order AWB
      • Cancel order
    • Page blocks
      • Get block catalog
    • Page templates
      • List templates
      • Get template
    • Pages
      • Update page status
      • Open draft
      • Update draft
      • Discard draft
      • Publish draft
      • List versions
      • Get version
      • Get version preview
      • Restore version
      • Apply template
      • Get block html
    • Payment methods
      • Bank accounts
        • Update bank account
      • Mobile wallet payments
        • Update digital wallet
      • Payment gateways
        • Update payment gateway
    • Product options
      • Update option value
      • Delete option value
      • List options
    • Products
      • List products
      • Create product
      • Get product
      • Update product
      • Delete product
      • Create product bulk action
      • Create write description draft
      • Create option
      • Update option
      • Delete option
      • Generate variants
      • Update variants
      • Detach product attachment
    • Referral program
      • Get my referral
      • Get my referral stats
      • List my referral commissions
      • List my referred users
      • Get my balance
      • List my withdrawals
      • Create my withdrawal
      • Cancel my withdrawal
    • Settings
      • List settings
      • Update settings
    • Shipments
      • List shipments
      • Create shipment
      • Update shipment
      • Cancel shipment
    • Shipping companies
      • List shipping companies
      • List delivery prices
      • Create delivery price
      • Update shipping company
    • Store features
      • Toggle website feature
      • Update feature data status
      • Verify facebook pixel
    • Support chat
      • List team
      • List conversations
      • Create conversation
      • Get conversation
      • List messages
      • Create message
      • Read mark conversation
      • List assistant messages
      • List setup steps
      • Create ask assistant
      • Create ask assistant
      • Create hand off conversation
      • Create rate assistant answer
    • Tags
      • List tags
    • Theme sections
      • List theme sections
      • Create theme section
      • Sort theme sections
      • Get theme section
      • Update theme section
    • Uploads
      • Upload
    • WhatsApp
      • List numbers
      • Create number
      • Get number status
      • List templates
      • Delete number
      • Create number pairing code
      • Set primary number
      • Update template
      • Update template status
  • Schemas
    • AddCartItemRequest
    • AddCrossSellRequest
    • AddWebsiteThemeSectionRequest
    • AdminNotificationResource
    • AiDraftResource
    • AppConfigResource
    • ApplyCouponRequest
    • ApplyQuantityDiscountRequest
    • AskAssistant
    • AuthCustomerResource
    • AuthUserResource
    • BalanceResource
    • BankAccountResource
    • BlockCatalogResource
    • BlockDefinitionResource
    • BlockResource
    • BookmarkResource
    • BranchResource
    • BrandResource
    • BulkActionProductsRequest
    • CartItemResource
    • CartResource
    • CartShippingOptionsResource
    • CategoryResource
    • ChargeInvoiceResource
    • CheckoutResultResource
    • CityResource
    • CodeSentResource
    • CompleteCheckoutRequest
    • ConversationResource
    • CountryResource
    • CustomerAddressResource
    • CustomerGroupResource
    • CustomerResource
    • CustomerSignInResource
    • DeliveryPriceResource
    • DigitalWalletResource
    • ForgotPasswordRequest
    • GuestTokenResource
    • HandOffConversation
    • InfoPageResource
    • LoginRequest
    • IssueResource
    • JoinedWebsiteResource
    • LandingPageResource
    • MessageResource
    • Modules.Core.Http.Requests.Website.Api.V1.SubscribePushNotificationsRequest
    • Modules.Customers.Http.Requests.Website.Api.V1.Auth.LoginRequest
    • NotifyAvailabilityRequest
    • OpenDraftRequest
    • OpenWebsiteRequest
    • OpenedWebsiteResource
    • OptionResource
    • OptionValueResource
    • OrderItemOptionResource
    • OrderItemResource
    • OrderResource
    • OrderShippingCompanyResource
    • OtpResultResource
    • PageResource
    • PatchDraftRequest
    • PaymentGatewayResource
    • PaymentMethodResource
    • PlatformCommissionResource
    • PlatformReferredUserResource
    • PlatformReferrerResource
    • PlatformUserBalanceResource
    • PlatformWithdrawalRequestResource
    • PreviewResource
    • PrintAwbRequest
    • ProductResource
    • QuickOrderRequest
    • RateAssistantAnswer
    • RegisterRequest
    • ResendOtpRequest
    • ReviewResource
    • SaveCartCustomerRequest
    • ServicePriceResource
    • SetupStepsResource
    • ShipmentResource
    • ShippingCompanyResource
    • ShippingOptionResource
    • SocialAuthRequest
    • SortWebsiteThemeSectionsRequest
    • StoreAddressRequest
    • StoreCampaignConditionRequest
    • StoreChargeRequest
    • StoreContactMessageRequest
    • StoreConversation
    • StoreCustomerRequest
    • StoreDeliveryPricesRequest
    • StoreFacebookEventRequest
    • StoreGoogleEventRequest
    • StoreIssueRequest
    • StoreMailList
    • StoreMessage
    • StoreOptionRequest
    • StoreOrderRequest
    • StoreProductRequest
    • StoreReviewRequest
    • StoreShipmentRequest
    • StoreThemeSectionRequest
    • StoreTiktokEventRequest
    • StoreTransferRequest
    • StoreWithdrawalRequest
    • SubscribePushNotificationsRequest
    • TagResource
    • TemplateResource
    • ThemeResource
    • ToggleWebsiteFeatureRequest
    • TopicResource
    • TrackingResource
    • TransactionResource
    • UpdateAddressRequest
    • UpdateAllowToOpenPackageRequest
    • UpdateShipmentRequest
    • UpdateBankAccountRequest
    • UpdateBranchRequest
    • UpdateBrandRequest
    • UpdateCampaignConditionRequest
    • UpdateCheckoutRequest
    • UpdateCustomerGroupRequest
    • UpdateCustomerRequest
    • UpdateDigitalWalletRequest
    • UpdateOptionRequest
    • UpdateOptionValueRequest
    • UpdateOrderRequest
    • UpdateOrderStatusRequest
    • UpdatePaymentGatewayRequest
    • UpdateProductRequest
    • UpdateProfileRequest
    • UpdateSettingsRequest
    • UpdateShippingCompanyRequest
    • UpdateStatusRequest
    • UpdateTopicSettingsRequest
    • UpdateUserRequest
    • UpdateVariantsRequest
    • UploadRequest
    • UserResource
    • UserSignInResource
    • VariantResource
    • VerifyFacebookPixelRequest
    • VerifyLoginCodeRequest
    • VerifyOtpRequest
    • WebsiteProductResource
    • WebsiteVariantResource
    • WhatsappConnectionResource
    • WhatsappPairingCodeRequest
    • WriteDescriptionDraftRequest
HomeWebsite APIDashboard API
HomeWebsite APIDashboard API
  1. Dashboard API

Get Started

The Dashboard API lets an outside app work on a Shanta store the way its owner does from the dashboard: read and update orders, add products, manage customers, shipping, settings and more. Connect an AI assistant such as Claude, a shipping or warehouse system, an accounting tool, or an automation flow.
Base URL: https://dashboard.shantaweb.com/admin/v1

Quick start#

1.
Create a key. In your dashboard open Settings → API keys and create a key. Give it a name ("Claude", "Shipping system"), pick what it may do, and copy it — it is shown once.
2.
Send it on every request.
3.
Pick the endpoint from APIs on the left. Each one names the ability it needs.

Use it with AI#

Give your assistant the key and the link of this page, and ask it to send the key in the Authorization header with every request. These docs are also served as plain text for AI tools at https://docs.shantaweb.com/llms.txt, and each page has a Copy page button.

Building the shopper's side?#

A mobile app or a custom storefront uses the Website API instead — switch from the top menu. The home page compares the two.
Modified at 2026-10-25 03:08:00
Next
Authorization
Built with