๐ชStores
Creating, reading, updating and deleting stores
Last updated
Creating, reading, updating and deleting stores
Last updated
Gets the publicly viewable representation of the store by the URL, does not require authorization
The URL of the store, accepts either be the SellSN subdomain (ex. demo) or the fully qualified domain name (FQDN) for their custom domain
The object was successfully returned.
Whether the operation was successful
The optional message given by the operation
A store owned by a merchant that can be used as a front for selling products to customers
Re-orders the products in a store based on a numeric value that is used to sort in ascending order, requires the
Scopes.UpdateStores
permission
The ID of the store to re-order the products for
The order of items to update with
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Delivers the given order manually as if the customer purchased it through regular means, requires the
Scopes.DeliverOrders
permission. This will not do anything if the order has already been delivered
The ID of the store the order belongs to
The ID of the order to deliver
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Deletes and deactivates the current custom domain associated with the given store, requires the
Scopes.UpdateStores
permission
The ID of the store to delete and deactivate the custom domain for
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Deletes a frequently asked question in the store by the ID, requires the
Scopes.UpdateStores
permission
The ID of the store to create the FAQ in
The ID of the frequently asked question to delete
The object was successfully deleted.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Gets the status of the custom domain associated with the given store, requires the Scopes.ViewStores
permission
The ID of the store to get the custom domain status for
The object was successfully returned.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Gets all the orders associated with a store and returns them as a paginated response, there is no way to get all
orders in one response. Requires the Scopes.ViewOrders
permission
The ID of the store to get the orders for
The page to select when viewing the orders
The object was successfully returned.
Whether the operation was successful
The amount of pages there are
The data for the page
Gets a list of reviews for a store along with the average review rating and the total amount of reviews left, does not require authorization.
The ID of the store to get the reviews for
The page to select when viewing the reviews
The object was successfully returned.
Whether the operation was successful
The amount of pages there are
The data for the page
The total all-time reviews there are
The average review score
Removes and replaces the current store logo for the given store, requires the Scopes.UpdateStores
permission
The ID of the store to upload the logo to
The object was successfully updated.
Whether the operation was successful
The optional message given by the operation
Represents a storefront that contains products that will be sold under it's name
The ID of the store that the review belongs to
The ID of the review to make the reply on
The form containing the reply to the review
The reply to give the user on the review, this is displayed publicly
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Flags the given review for removal at discretion of the SellSN staff, requires the Scopes.FlagReviews
permission
The ID of the store the review belongs to
The ID of the review to flag
The form containing the details as to why the review is invalid
The reason the review is invalid and needs to be removed from the store
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Begins the setup process for a custom domain, requires the Scopes.UpdateStores
permission
The ID of the store to create the custom domain for
The form containing the details of the new custom domain
The new fully qualified domain name (FQDN) to setup as a custom domain, no protocols just a DNS name
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
A DNS record including the name, type and value to apply to a DNS server
Gets the current and previous flagged reviews for a store, requires the Scopes.ViewFlaggedReviews
permission
The ID of the store to get the flagged reviews for
The object was successfully returned.
Whether the operation was successful
The optional message given by the operation
The optional return data from the operation
Creates a frequently asked question in the store to be displayed on the store page, requires the
Scopes.UpdateStores
permission
The ID of the store to create the FAQ in
The form containing the details of the new FAQ
The title for the question, or just the question
The description or answer to the question
The object was successfully created.
Whether the operation was successful
The optional message given by the operation
Represents a key-value database entity
Creates a new store for the current user, requires the Scopes.CreateStores
permission
The form containing the details of the new store
The name of the store as shown on the users store page
The subdomain part of the store URL, just one word and will qualify to x.sellsn.io
The HEX accent color used on the store to color buttons, inputs, etc.
The store description, shown on the store home page underneath the title
The name of the theme that is currently active on the store
The text to show above the description on the store page where it would say 'Welcome to my store'
The title to display on the users browser when accessing the store page
The terms of service for the store
The privacy policy for the store
The copyright data to show at the bottom of the store page
Whether to hide the amount of views a store has on the store page
Whether to hide every statistic for a store on the store page
Whether dark mode is forced on the sellers store page
The ISO-compliant fiat currency code that is preferred for the store, defaults to USD
The announcement to display on the sellers home page
The message from the seller to display when the sellers profile is shown
The HEX background color to display on the store page
The HEX background color to use for cards on the store page
The HEX button color to use on all buttons regardless of type, if you only want to change primary color buttons use the AccentColor instead.
The background color for the navigation bar on the store page
A list of social media accounts for a store
The ID of the featured product to display on the store home page
The extra theme properties to customize the theme with, you can find all available theme properties in the 'Miscellaneous objects' page
The object was successfully created.
Whether the operation was successful
The optional message given by the operation
Represents a storefront that contains products that will be sold under it's name
Replaces the given store with the information in the form, requires the Scopes.UpdateStores
permission
The ID of the store to update
The form containing the new data to update the store with
The name of the store as shown on the users store page
The subdomain part of the store URL, just one word and will qualify to x.sellsn.io
The HEX accent color used on the store to color buttons, inputs, etc.
The store description, shown on the store home page underneath the title
The name of the theme that is currently active on the store
The text to show above the description on the store page where it would say 'Welcome to my store'
The title to display on the users browser when accessing the store page
The terms of service for the store
The privacy policy for the store
The copyright data to show at the bottom of the store page
Whether to hide the amount of views a store has on the store page
Whether to hide every statistic for a store on the store page
Whether dark mode is forced on the sellers store page
The ISO-compliant fiat currency code that is preferred for the store, defaults to USD
The announcement to display on the sellers home page
The message from the seller to display when the sellers profile is shown
The HEX background color to display on the store page
The HEX background color to use for cards on the store page
The HEX button color to use on all buttons regardless of type, if you only want to change primary color buttons use the AccentColor instead.
The background color for the navigation bar on the store page
A list of social media accounts for a store
The ID of the featured product to display on the store home page
The extra theme properties to customize the theme with, you can find all available theme properties in the 'Miscellaneous objects' page
The object was successfully updated.
Whether the operation was successful
The optional message given by the operation
Represents a storefront that contains products that will be sold under it's name
Gets the publicly viewable representation of the store by the ID, does not require authorization
The ID of the store
The object was successfully returned.
Whether the operation was successful
The optional message given by the operation
A store owned by a merchant that can be used as a front for selling products to customers
The ID of the store to search for orders in
The page to select when viewing the orders
The query to search when looking for orders, you can use an exact ID and get the first element to find an order by the ID and search by customer email address
The object was successfully returned.
Whether the operation was successful
The amount of pages there are
The data for the page
The ID of the store to get analytics for
The timespan to get the analytics for, can be anything from 1d to 365d, must be in days only. For
example 1d would equal 1 day. Requires the Scopes.ViewStores
permission
The operation was successfully completed.
Whether the operation was successful
The optional message given by the operation
Statistics based on a store's orders, customers, etc.
Gets an order by the given ID in the store
The ID of the store to get the order in
The ID of the store to get
The object was successfully returned.
The unique identifier of the entity
The date the entity was created in the database
The products that were purchased
The item that was delivered when the order was delivered
The current payment status
The gateway used to facilitate the purchase
The transaction ID from the payment gateway, this can be null if a first-party gateway was used
The country code for the order, from the CF-IPCountry header
The IP address of the user creating the order, this should be stored for fraud prevention reasons
The user agent string of the browser creating the order, this is also stored for fraud prevention reasons
Represents a customer for SellSN on the marketplace and for a seller
The cost of the order
The amount that the customer has paid for the invoice
The fee amount in USD taken by the payment gateway of choice
The fee amount in USD taken by the platform
The amount of crypto that is equal to the price at the time of making the order
Custom values set by the user/seller for this order
The optional cryptocurrency address the user was asked to send the funds to
The optional link to the invoice page on BTCPayServer
Whether the order has the SellSN warranty enabled on it
Whether the order was created on the SellSN marketplace or not
A coupon code can be used to reduce the cost of an order with a store for a specified percentage
Gets and returns a store by the ID - this is a privileged endpoint and will return the un-redacted store,
requires the Scopes.ViewStores
permission
The ID of the store to get
The object was successfully returned.
Whether the operation was successful
The optional message given by the operation
Represents a storefront that contains products that will be sold under it's name