> ## 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 profit > What the store kept in a period and how that is made up, beside the period before: net sales, the cost of goods, payment fees, affiliate commission, expenses and net profit, twelve months of sales and profit, and every product with what each variant sold and cost. A sale is what the buyer paid: at its sale price, after its coupon and any affiliate link's discount, without tax. Payment fees are worked out from the rates the store typed, never read from a provider, so they can be slightly off. A store makes at most 20 reports every 10 minutes, counting this one, the other report, their files and the dashboard's Generate Report together: after that the answer is 429. Refused with `business_details_required` until the store has its business details. Needs the `finance.read` permission (Read Finance). 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}/finance/profit 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: Blacklist - 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}/finance/profit: get: tags: - Finance summary: Get profit description: >- What the store kept in a period and how that is made up, beside the period before: net sales, the cost of goods, payment fees, affiliate commission, expenses and net profit, twelve months of sales and profit, and every product with what each variant sold and cost. A sale is what the buyer paid: at its sale price, after its coupon and any affiliate link's discount, without tax. Payment fees are worked out from the rates the store typed, never read from a provider, so they can be slightly off. A store makes at most 20 reports every 10 minutes, counting this one, the other report, their files and the dashboard's Generate Report together: after that the answer is 429. Refused with `business_details_required` until the store has its business details. Needs the `finance.read` permission (Read Finance). It is one of the heavier reads, and is counted against a smaller budget of its own: 60 a minute for each key. operationId: finance.profit 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 - name: range in: query required: false description: The period. schema: type: string enum: - today - yesterday - 7d - 30d - this_week - last_week - this_month - last_month - this_year default: this_month - name: from in: query required: false description: >- The first day of a period of your own, as `YYYY-MM-DD`. With `to`, in place of `range`. schema: type: string - name: to in: query required: false description: Its last day, as `YYYY-MM-DD`. schema: type: string - name: tz in: query required: false description: The time zone those days are in, as an IANA name. Left out, UTC. schema: type: string example: Europe/Berlin 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: period: type: object properties: from: type: string to: type: string label: type: string previousFrom: type: string previousTo: type: string previousLabel: type: string currency: type: string now: type: object properties: netSales: type: number orders: type: integer costOfGoods: type: integer fees: type: number commission: type: integer expenses: type: integer profit: type: number margin: type: number units: type: integer uncosted: type: integer previous: type: object properties: netSales: type: integer orders: type: integer costOfGoods: type: integer fees: type: integer commission: type: integer expenses: type: integer profit: type: integer margin: nullable: true units: type: integer uncosted: type: integer perOrder: type: number average: type: number breakEven: type: object properties: orders: type: integer reachedOn: nullable: true each: type: number fees: type: object properties: rated: type: boolean unrated: type: array items: type: string months: type: array items: type: object properties: month: type: string sales: type: integer profit: type: integer products: type: array items: type: object properties: id: type: string name: type: string image: nullable: true expenses: type: integer variants: type: array items: type: object properties: id: type: string label: type: string price: type: number costAmount: type: number costPercent: nullable: true sold: type: integer sales: type: number cost: type: integer uncosted: type: integer profit: nullable: true sold: type: integer sales: type: number cost: type: integer uncosted: type: integer profit: nullable: true costSet: type: string example: success: true message: null code: null data: period: from: '2026-10-01' to: '2026-10-22' label: 1 to 22 October 2026 previousFrom: '2026-09-01' previousTo: '2026-09-22' previousLabel: 1 to 22 September 2026 currency: USD now: netSales: 78.98 orders: 4 costOfGoods: 0 fees: 1.72 commission: 0 expenses: 0 profit: 77.26 margin: 97.8 units: 4 uncosted: 4 previous: netSales: 0 orders: 0 costOfGoods: 0 fees: 0 commission: 0 expenses: 0 profit: 0 margin: null units: 0 uncosted: 0 perOrder: 19.32 average: 19.75 breakEven: orders: 0 reachedOn: null each: 19.32 fees: rated: true unrated: - Custom c009621ccc3e9d74 - PayPal months: - month: 2025-11 sales: 0 profit: 0 - month: 2025-12 sales: 0 profit: 0 products: - id: f463e265-097a-4235-bc2f-5239b19a9874 name: Northwind Pro image: null expenses: 0 variants: - id: 00e1d395-9ba2-4db3-900a-cb5e2811a2a9 label: 1 month price: 9.99 costAmount: 2.5 costPercent: null sold: 4 sales: 78.99 cost: 0 uncosted: 4 profit: null - id: defa3f9e-8aaf-423d-a0a6-fe65ab8043d4 label: 1 year price: 79 costAmount: null costPercent: null sold: 0 sales: 0 cost: 0 uncosted: 0 profit: 0 sold: 4 sales: 78.99 cost: 0 uncosted: 4 profit: null costSet: some '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.finance.profit(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->finance->profit(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.finance.profit() 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.