Endpoints 15
- 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