Gumroad tools
The 12 Gumroad operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List productsGETLists the products of the account, newest first, 10 per page, in a short form: Get product returns the whole product. When more follow, the response has next_page_key, which goes in page_key.
- Get productGETReturns a product with price, description, category, tags, variants, files and, with the view_sales scope, sales_count and sales_usd_cents.
- List categoriesGETLists the product categories of Gumroad. The path of a category, such as design/ui-and-web/figma, goes in category in Create product and Update product.
- Create productPOSTCreates a product and publishes it right away, unless draft is true. When publishing is blocked, for example by an unconfirmed email or a missing payout method, the product stays a draft and the response has a warning: publish it later with Publish product.
- Update productPUTChanges a product and returns it. Only the fields sent change, but tags replaces the whole list. A warning in the response reports offer codes that stopped being valid for the product.
- Publish productPUTPublishes a draft or unpublished product, so buyers can buy it. Refused while the account has no confirmed email or no payout method, or when an offer code of the product leaves the price invalid.
- Unpublish productPUTUnpublishes a product, which stops new sales. Publish product puts it back on sale.
- List salesGETLists the successful sales of the account, newest first, 10 per page, with buyer email, product, price, refund, subscription and license data. When more follow, the response has next_page_key, which goes in page_key.
- Get saleGETReturns a sale of the account: buyer, product, variants, price, refund and shipping status, subscription and license.
- List subscribersGETLists the subscribers of a membership product, with email, recurrence, status (alive, pending_cancellation, failed_payment, cancelled and others) and the ids of their sales. Without paginated, every subscriber comes in one response.
- List offer codesGETLists the offer codes of a product, with amount_cents for a fixed discount or percent_off for a percentage, uses, limit and validity. A universal code applies to every product.
- Create offer codePOSTCreates a discount code that buyers type at checkout. The discount is in cents of the product currency unless offer_type is percent. The amount and universal cannot be changed later.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
