> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get the reseller overview > What the workspace's Overview shows: the panel (`panel`: whether it is on, its currency and smallest top-up), its address, the last 30 days' figures (`figures`: sales, orders and top-ups, and `balanceHeld`, every reseller's balance added up), what waits on the store (`waiting`, most pressing first: the panel off, nothing for sale, no invite link on, a product running out of keys) and the five resellers who spent most in 30 days (`top`). None of it is in the store's own figures: a reseller's purchases and top-ups are never its orders or revenue. Needs the `resellers.read` permission (Read Resellers). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/resellers/overview openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Teams - name: Resellers - name: Blacklist - name: Allowlist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/resellers/overview: get: tags: - Resellers summary: Get the reseller overview description: >- What the workspace's Overview shows: the panel (`panel`: whether it is on, its currency and smallest top-up), its address, the last 30 days' figures (`figures`: sales, orders and top-ups, and `balanceHeld`, every reseller's balance added up), what waits on the store (`waiting`, most pressing first: the panel off, nothing for sale, no invite link on, a product running out of keys) and the five resellers who spent most in 30 days (`top`). None of it is in the store's own figures: a reseller's purchases and top-ups are never its orders or revenue. Needs the `resellers.read` permission (Read Resellers). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. operationId: resellers.overview parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: panel: type: object properties: enabled: type: boolean currency: type: string minTopup: type: integer address: type: string figures: type: object properties: resellers: type: integer paused: type: integer sales30: type: integer orders30: type: integer topups30: type: integer topupCount30: type: integer balanceHeld: type: integer waiting: type: array items: type: object properties: kind: type: string line: type: string hint: type: string productId: type: string top: type: array items: type: object properties: id: type: string name: type: string website: type: string email: type: string tierId: type: string tierName: type: string tierDiscount: type: number discount: nullable: true paysOff: type: number balance: type: integer status: type: string members: type: integer spent30: type: integer lastOrderAt: type: string joinedAt: type: string removedAt: nullable: true example: success: true message: null code: null data: panel: enabled: true currency: USD minTopup: 25 address: https://northwind.myshoply.gg/resellers figures: resellers: 1 paused: 0 sales30: 13 orders30: 1 topups30: 130 topupCount30: 2 balanceHeld: 167 waiting: - kind: stock line: Northwind Pro ยท 1 month has 2 keys left hint: Resellers buy from the same keys as your store. productId: 7626c760-c6cd-4b38-8344-cfbba0148a80 top: - id: 5802fdf5-5c97-40bb-b505-29a900c278e4 name: keydepot.example.com website: keydepot.example.com email: team@keydepot.example.com tierId: 53272267-b8de-4f7f-9c0e-00f69122b91e tierName: Gold tierDiscount: 12.5 discount: null paysOff: 12.5 balance: 167 status: active members: 2 spent30: 13 lastOrderAt: '2026-11-09 11:32:36.280' joinedAt: '2026-11-09 11:32:36.157' removedAt: null '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.resellers.overview(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->resellers->overview(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.resellers.overview() components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.