Sherpo merchant API: endpoints 133-281
customer
- Reads the store's customer stats over a period.GET
/v1/stores/{store}/customers/stats - Pages the grants of access to customers.GET
/v1/stores/{store}/grants - Grants a customer access to a product or tier.POST
/v1/stores/{store}/grants - Revokes a grant of access.POST
/v1/stores/{store}/grants/{grant}/revoke - Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.GET
/v1/stores/{store}/feeds - Pages customers' private feeds of blogs, podcasts and events, with the readers each served lately and its limit.GET
/v1/stores/{store}/products/{product}/feeds - Sets how many readers a customer's private feed serves in 30 days before it moves to a new URL.PATCH
/v1/stores/{store}/products/{product}/feeds/{feed} - Stops a customer's private feed of a blog, a podcast or an event.POST
/v1/stores/{store}/products/{product}/feeds/{feed}/revoke - Lets a customer hold a private feed of a blog, a podcast or an event again after repeated sharing turned it off, counting sharing afresh.POST
/v1/stores/{store}/products/{product}/feeds/unblock - Pages a software product's licenses, their keys shortened to their last characters.GET
/v1/stores/{store}/products/{product}/licenses - Records a key a customer holds from another platform as their license to a software product, so software in the field keeps checking; it may land disabled, or take the place of the customer's license.POST
/v1/stores/{store}/products/{product}/licenses - Gets a license with its key, its status and the subscription behind it.GET
/v1/stores/{store}/products/{product}/licenses/{license} - Sets a license's activation limit, its uses or its metadata.PATCH
/v1/stores/{store}/products/{product}/licenses/{license} - Stops a license from checking as valid, whatever its holder's access.POST
/v1/stores/{store}/products/{product}/licenses/{license}/disable - Lets a disabled license check as its holder's access says again.POST
/v1/stores/{store}/products/{product}/licenses/{license}/enable - Reads a software product's license activity over a period: licenses issued and imported, verifies and uses, active licenses a day, and devices activated, freed and refused at the limit.GET
/v1/stores/{store}/products/{product}/licenses/stats - Pages the devices a license counts, latest activated first, with those freed or gone inactive, never their instance ids.GET
/v1/stores/{store}/products/{product}/licenses/{license}/activations - Frees one of a license's devices, so it stops counting toward the activation limit, whatever the license's status.POST
/v1/stores/{store}/products/{product}/licenses/{license}/activations/{activation}/deactivate - Gives a license a fresh key and emails it to the holder; the old key stops checking at once.POST
/v1/stores/{store}/products/{product}/licenses/{license}/rotate - Checks a software product's license key from the seller's server: its status, why it is not active, when it ends, its tier and features, its uses, its devices and the subscription behind it; with `count_use` an active one counts a use, and with `instance` it reads and stamps that device. An unknown key, or another product's, answers `not_found`.POST
/v1/stores/{store}/products/{product}/licenses/verify - Counts a device toward a software product's license from the seller's server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license's activation limit (10,000 when nothing limits it) it answers `conflict` on `items`, and a license that is not active `conflict` on `status`.POST
/v1/stores/{store}/products/{product}/licenses/activate - Answers a fresh signed token for a device a software product's active license counts, from the seller's server, stamping the device seen; a license that is not active answers `conflict` on `status`, and a device it does not count (never activated, freed or gone inactive) `not_found`.POST
/v1/stores/{store}/products/{product}/licenses/token - Frees a device of a software product's license from the seller's server, whatever the license's status, an inactive one too; a device never activated, or already freed, answers `not_found`.POST
/v1/stores/{store}/products/{product}/licenses/deactivate - Lists the store's published Ed25519 keys as JSON Web Keys, which software checks offline license tokens against: the one that signs, the next one, and those rotated out while a token they signed may live.GET
/v1/stores/{store}/license_signing_keys - Promotes the store's next license signing key to sign new tokens and publishes a fresh next one, keeping the old key published for 365 days; with `retire_previous` every key that no longer signs leaves the published set at once, though software that embeds it trusts it until updated. With `current`, a rotation since answers `conflict`. A store with no keys gets its first set.POST
/v1/stores/{store}/license_signing_keys/rotate - Pages what customers may reach, as their grants and subscriptions add up.GET
/v1/stores/{store}/entitlements - Pages the store's customers.GET
/v1/stores/{store}/customers - Pages customers' activity over a period.GET
/v1/stores/{store}/customer_activity - Pages a product's customers.GET
/v1/stores/{store}/products/{product}/customers - Counts a product's customers by status.GET
/v1/stores/{store}/products/{product}/customers/stats - Pages the store's checkouts.GET
/v1/stores/{store}/checkouts - Reads one customer.GET
/v1/stores/{store}/customers/{customer} - Erases a customer's personal data, keeping the records of what they bought.POST
/v1/stores/{store}/customers/{customer}/erase - Pages an event's guest list: one row per person, going or canceled, with their tier and how they got their ticket.GET
/v1/stores/{store}/products/{product}/attendees - Counts an event's attendees: going, canceled by reason, going by tier, and the spots its capacity leaves.GET
/v1/stores/{store}/products/{product}/attendees/stats - Reads a customer's answers to each product's registration questions, latest answered first.GET
/v1/stores/{store}/customers/{customer}/answers - Answers a product's registration questions for a customer who holds it, such as answers they gave elsewhere.PUT
/v1/stores/{store}/products/{product}/customers/{customer}/answers - Pages a product's requests: buyers waiting for approval, an event's waitlist, and those decided.GET
/v1/stores/{store}/products/{product}/requests - Approves a pending request: the buyer is granted what they asked for, on the seats their order holds.POST
/v1/stores/{store}/products/{product}/requests/{request}/approve - Declines a pending request or a waitlist place, giving back any seats it holds.POST
/v1/stores/{store}/products/{product}/requests/{request}/decline - Lets a waitlisted buyer in once the event has their seats: a free order takes them and the buyer is granted at once.POST
/v1/stores/{store}/products/{product}/requests/{request}/promote
subscription
- Reads the store's subscription stats over a period.GET
/v1/stores/{store}/subscriptions/stats - Pages the store's subscriptions.GET
/v1/stores/{store}/subscriptions - Pages the billing periods of subscriptions.GET
/v1/stores/{store}/subscription_periods - Pages the status changes of subscriptions.GET
/v1/stores/{store}/subscription_transitions - Reads one subscription.GET
/v1/stores/{store}/subscriptions/{subscription} - Cancels a subscription now or at the end of its period.POST
/v1/stores/{store}/subscriptions/{subscription}/cancel - Withdraws a subscription's scheduled cancellation.POST
/v1/stores/{store}/subscriptions/{subscription}/resume
affiliate
- Pages the payouts recorded to affiliates.GET
/v1/stores/{store}/affiliate_payouts - Records a payout made to an affiliate.POST
/v1/stores/{store}/affiliate_payouts - Pages the commissions affiliates earned.GET
/v1/stores/{store}/commissions - Reads commission totals over a period.GET
/v1/stores/{store}/commissions/stats - Pages the store's affiliates by discount.GET
/v1/stores/{store}/affiliates - Makes a user an affiliate of a discount, with their commission.PUT
/v1/stores/{store}/discounts/{discount}/affiliates - Removes an affiliate from a discount, or ends one that earned commissions, which stay.POST
/v1/stores/{store}/discounts/{discount}/affiliates/remove - Puts back the commission an affiliate had before an API token that did not make it changed it.POST
/v1/stores/{store}/discounts/{discount}/affiliates/revert
discount
- Pages the store's discounts.GET
/v1/stores/{store}/discounts - Creates a discount.POST
/v1/stores/{store}/discounts - Reads one discount.GET
/v1/stores/{store}/discounts/{discount} - Deletes a discount no payable checkout, unpaid commission or automation relies on.DEL
/v1/stores/{store}/discounts/{discount} - Updates a discount's fields.PATCH
/v1/stores/{store}/discounts/{discount} - Counts the store's discounts by status.GET
/v1/stores/{store}/discounts/stats - Stops a discount from applying while keeping it.POST
/v1/stores/{store}/discounts/{discount}/archive - Lets an archived discount apply again.POST
/v1/stores/{store}/discounts/{discount}/restore - Sets the products, tiers or prices a discount applies to.POST
/v1/stores/{store}/discounts/{discount}/restrict - Applies a discount to a product, tier or price.POST
/v1/stores/{store}/discounts/{discount}/attach - Stops a discount applying to a product, tier or price.POST
/v1/stores/{store}/discounts/{discount}/detach
review
- Pages the store's product reviews.GET
/v1/stores/{store}/reviews - Pages the store's product reviews.GET
/v1/stores/{store}/products/{product}/reviews - Reads review counts and ratings.GET
/v1/stores/{store}/reviews/stats - Reads review counts and ratings.GET
/v1/stores/{store}/products/{product}/reviews/stats - Hides a review from the store.POST
/v1/stores/{store}/products/{product}/reviews/{review}/hide - Shows a hidden review again.POST
/v1/stores/{store}/products/{product}/reviews/{review}/unhide - Sets or clears the store's reply to a review.POST
/v1/stores/{store}/products/{product}/reviews/{review}/reply
quiz
- Pages customers' quiz attempts.GET
/v1/stores/{store}/attempts - Pages customers' quiz attempts.GET
/v1/stores/{store}/products/{product}/attempts - Reads one quiz attempt with its answers.GET
/v1/stores/{store}/products/{product}/attempts/{attempt} - Deletes one quiz attempt.DEL
/v1/stores/{store}/products/{product}/attempts/{attempt} - Pages an entry's quizzes.GET
/v1/stores/{store}/products/{product}/entries/{entry}/quizzes - Creates a quiz on an entry.POST
/v1/stores/{store}/products/{product}/entries/{entry}/quizzes - Reads one quiz with its questions.GET
/v1/stores/{store}/products/{product}/entries/{entry}/quizzes/{quiz} - Deletes a quiz.DEL
/v1/stores/{store}/products/{product}/entries/{entry}/quizzes/{quiz} - Updates a quiz's settings and questions.PATCH
/v1/stores/{store}/products/{product}/entries/{entry}/quizzes/{quiz} - Reads a product's quiz results.GET
/v1/stores/{store}/products/{product}/quizzes/stats - Clears a customer's attempts at an entry's quizzes.POST
/v1/stores/{store}/products/{product}/entries/{entry}/attempts/clear
certificate
- Pages a product's certificates.GET
/v1/stores/{store}/products/{product}/certificates - Creates a certificate for a product.POST
/v1/stores/{store}/products/{product}/certificates - Pages the certificates issued to customers.GET
/v1/stores/{store}/certificates/issues - Pages the certificates issued to customers.GET
/v1/stores/{store}/products/{product}/certificates/issues - Reads a product's certificate issues over a period.GET
/v1/stores/{store}/products/{product}/certificates/stats - Issues a certificate to a customer.POST
/v1/stores/{store}/products/{product}/certificates/{certificate}/issue - Deletes a certificate never issued.DEL
/v1/stores/{store}/products/{product}/certificates/{certificate} - Updates a certificate's design and copy.PATCH
/v1/stores/{store}/products/{product}/certificates/{certificate} - Revokes an issued certificate.POST
/v1/stores/{store}/products/{product}/certificates/issues/{issue}/revoke
attendee
- Lets an attendee in at one of an event's sessions by their ticket's code or their guest list row, once a session; answers who they are, and whether they were let in now, earlier, or hold no ticket to it.POST
/v1/stores/{store}/products/{product}/attendees/check_in - Takes back an attendee's check-in at an event's session.DEL
/v1/stores/{store}/products/{product}/attendees/{attendee}/check_in - Counts an event's door: who is going, and each session with how many were let in.GET
/v1/stores/{store}/products/{product}/attendees/check_in/stats - Lists the events with a session held in person still to run or ended in the last 12 hours, soonest first, each with who is going and how many were let in.GET
/v1/stores/{store}/products/check_in
site
- Reads the store: its name, hostname, subdomain, branding and plan.GET
/v1/stores/{store} - Updates the store's name, description and branding.PATCH
/v1/stores/{store} - Reads the store's settings.GET
/v1/stores/{store}/settings - Updates the store's settings.PATCH
/v1/stores/{store}/settings - Reads the store's plan, with the day it ends when set to cancel and whether it can still be resumed, and the plan billed once its period ends (a scheduled change up or down, or the base plan a cancelled one lapses into), and every limit it sets each store, with what the store uses of it: storage, transcription minutes, customers (with where the countdown past the cap stands), pages, menu items and redirects (with how many are kept inactive past what the store applies), features, the add-on blocks of storage and AI media minutes the store holds, where the business stands against its plan, what keeps it from moving to Lite and the plan change last called off for it (over its limits, or a move to the plan it holds for good or under it), and the marketing emails it may send a month, whose use is not reported yet.GET
/v1/stores/{store}/plan_usage - Reads the store's own domain, if it has one: where it stands, the DNS records it needs, and whether the store's plan includes a domain.GET
/v1/stores/{store}/domain - Connects a domain the seller owns to the store, answering the DNS records to set; it becomes the store's main address once they check out, or at once when it already does. Needs a plan that includes a domain.POST
/v1/stores/{store}/domain/connect - Checks the store's own domain at Cloudflare now, making it the store's main address once its records check out while the plan includes a domain; a check moments after another answers the domain as last read.POST
/v1/stores/{store}/domain/check - Stops serving the store on its own domain, or dismisses one that was let go; its Sherpo address becomes its main address again. Answers not found when the store has no domain, as after a removal that already landed.POST
/v1/stores/{store}/domain/remove - Sets or clears the store's icon from a file.PUT
/v1/stores/{store}/icon - Pages the store's redirects.GET
/v1/stores/{store}/redirects - Creates a redirect from a path.POST
/v1/stores/{store}/redirects - Deletes a redirect.DEL
/v1/stores/{store}/redirects/{redirect} - Updates a redirect's source or destination.PATCH
/v1/stores/{store}/redirects/{redirect} - Says whether a path is free for a page or redirect.GET
/v1/stores/{store}/paths/check
organization
- Reads the store's business.GET
/v1/stores/{store}/organization - Updates the business's name and details.PATCH
/v1/stores/{store}/organization - Sets or clears the business's logo from a file.PUT
/v1/stores/{store}/organization/logo - Reads the business's payout balance.GET
/v1/stores/{store}/balance - Lists the business's payouts.GET
/v1/stores/{store}/payouts - Previews what one more store on the business's plan charges now and bills from its next renewal.POST
/v1/stores/{store}/plan_store/preview/query - Previews switching the business's plan to another tier or billing period: when it takes effect, what it charges now and what it renews at, with a quote that holds the amount for 5 minutes. It takes effect now, prorated, when the tier doesn't drop and the period doesn't shorten; any other switch from the period's end.GET
/v1/stores/{store}/organization/plan/change/preview - Switches the business's plan to the one a preview quoted: now, charged at once at the quoted amount and applied only once paid, or from the period's end. A charge the card holder must confirm answers what to confirm it with. Not past a plan held for good, nor to Lite over its limits. Only a member with full access switches.POST
/v1/stores/{store}/organization/plan/change - Cancels a plan switch scheduled for the period's end, so the plan renews as it is. A store slot's removal is cancelled on its own. Only a member with full access cancels it.DEL
/v1/stores/{store}/organization/plan/change - Finishes a plan switch whose charge waited on its card holder, charging nothing more: the plan once paid, or the charge voided when it was not confirmed. Only a member with full access finishes it.POST
/v1/stores/{store}/organization/plan/change/confirm - Turns on or off upgrading automatically when the business goes over a limit: a Lite plan over its customers, storage or members moves to Pro 7 days after it crosses unless it gets back under, with Pro's price prorated to the card on file. Off by default; never for a cancelled plan, a free trial or a failed payment.PUT
/v1/stores/{store}/organization/auto_upgrade - Turns on or off adding Pro's add-on blocks on their own: when a store's storage or AI media minutes would pass what the plan and the blocks held cover, a block of 100 GB or 600 minutes a month is added, $10 a month, charged at once prorated on the card on file. Only ever adds; never during a free trial. Off, uploads and transcriptions stop at what's covered. On by default for new businesses.PUT
/v1/stores/{store}/organization/auto_add_ons - Pages the store's customer notifications.GET
/v1/stores/{store}/notifications - Creates a customer notification for an event.POST
/v1/stores/{store}/notifications - Deletes a notification; the store's defaults are turned off instead.DEL
/v1/stores/{store}/notifications/{notification} - Updates whether a notification is enabled.PATCH
/v1/stores/{store}/notifications/{notification} - Pages the store's webhook endpoints.GET
/v1/stores/{store}/webhooks - Creates a webhook endpoint and answers its signing secret, which no read answers again. Its events need the read scopes their payloads carry.POST
/v1/stores/{store}/webhooks - Reads one webhook endpoint, never its secret.GET
/v1/stores/{store}/webhooks/{webhook} - Deletes a webhook endpoint and its delivery history.DEL
/v1/stores/{store}/webhooks/{webhook} - Updates a webhook endpoint: its URL, events, description or whether it is sent anything. A new URL or added events need the read scopes the events' payloads carry.PATCH
/v1/stores/{store}/webhooks/{webhook} - Replaces a webhook endpoint's signing secret and answers the new one once; the old one signs nothing more. Needs the read scopes of its events and of every event it still owes.POST
/v1/stores/{store}/webhooks/{webhook}/secret/roll - Pages a webhook endpoint's recent deliveries: status, attempts and last response code.GET
/v1/stores/{store}/webhook_deliveries - Sends a delivery's event to its endpoint again, with the same event id; needs the read scopes its payload carries.POST
/v1/stores/{store}/webhook_deliveries/{delivery}/resend - Lists the businesses the token may act for, with their stores; an account token lists them whatever its access.GET
/v1/merchants - Reads one business with its stores.GET
/v1/merchants/{merchant}
integration
automation
- Pages the store's automations.GET
/v1/stores/{store}/automations - Creates an automation; an unlock needs customer:write too, a price adjustment discount:write, and each needs the read scope of what it names.POST
/v1/stores/{store}/automations - Pages the runs of automations.GET
/v1/stores/{store}/automation_runs - Reads one automation.GET
/v1/stores/{store}/automations/{automation} - Deletes an automation.DEL
/v1/stores/{store}/automations/{automation} - Updates an automation's trigger and action; a new trigger or action needs the scopes creating the rule would.PATCH
/v1/stores/{store}/automations/{automation} - Pauses an automation.POST
/v1/stores/{store}/automations/{automation}/pause - Resumes a paused automation; an unlock needs customer:write too, a price adjustment discount:write.POST
/v1/stores/{store}/automations/{automation}/resume