Stores

Creating, reading, updating and deleting stores

Last updated 2 months ago

Was this helpful?

Get store by ID

get

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

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get

Responses

200

The object was successfully returned.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "name": "text",
    "description": "text",
    "url": "text",
    "isVerified": true,
    "gross": 1,
    "theme": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "cost": 1,
        "amountSold": 1,
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "friendlyName": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "webhookUrl": "text",
        "visibility": 0,
        "isPinned": true,
        "isDynamic": true,
        "imageNames": [
          "text"
        ],
        "ignoreOutOfStock": true,
        "customValueKeys": [
          "text"
        ],
        "shouldBlockVirtualPrivateNetworks": true,
        "deliveryMessage": "text",
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "likes": 1,
        "isBestSeller": true,
        "blacklistedPaymentGateways": [
          "text"
        ],
        "additionalFees": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "metadata": "text"
      }
    ],
    "groupedProducts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "order": 1,
        "products": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "cost": 1,
            "amountSold": 1,
            "files": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "dateCreated": "2025-05-21T13:09:43.266Z",
                "friendlyName": "text"
              }
            ],
            "tags": [
              "text"
            ],
            "webhookUrl": "text",
            "visibility": 0,
            "isPinned": true,
            "isDynamic": true,
            "imageNames": [
              "text"
            ],
            "ignoreOutOfStock": true,
            "customValueKeys": [
              "text"
            ],
            "shouldBlockVirtualPrivateNetworks": true,
            "deliveryMessage": "text",
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "likes": 1,
            "isBestSeller": true,
            "blacklistedPaymentGateways": [
              "text"
            ],
            "additionalFees": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "metadata": "text"
          }
        ]
      }
    ],
    "termsOfService": "text",
    "copyright": "text",
    "privacyPolicy": "text",
    "visits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "visits": 1
      }
    ],
    "featuredProductId": "123e4567-e89b-12d3-a456-426614174000",
    "customDomain": "text",
    "lastCustomDomainUpdate": "2025-05-21T13:09:43.266Z",
    "socialMediaAccounts": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "tikTok": "text",
      "youTube": "text",
      "twitter": "text",
      "facebook": "text",
      "discord": "text",
      "telegram": "text",
      "instagram": "text"
    },
    "coupons": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "uses": 1,
        "maximumUses": 1,
        "percentageDecrease": 1,
        "isEnabled": true
      }
    ],
    "productsSoldOverride": 1,
    "reviewsOverride": 1,
    "resolvedTicketsOverride": 1,
    "viewsOverride": 1,
    "webhookSecret": "text",
    "preferredCurrency": "text"
  }
}

Get custom domain status

get

Gets the status of the custom domain associated with the given store, requires the Scopes.ViewStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get the custom domain status for

Responses

200

The object was successfully returned.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/custom-domain HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": "text"
}

Delete custom domain

delete

Deletes and deactivates the current custom domain associated with the given store, requires the Scopes.UpdateStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to delete and deactivate the custom domain for

Responses

200

The operation was successfully completed.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

delete

DELETE /stores/{storeId}/custom-domain HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": null
}

Get flagged reviews

get

Gets the current and previous flagged reviews for a store, requires the Scopes.ViewFlaggedReviews permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get the flagged reviews for

Responses

200

The object was successfully returned.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/flagged-reviews HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": [
    {
      "review": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "rating": 1,
        "reason": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "reply": "text"
      },
      "reason": "text",
      "approved": true,
      "administratorNote": "text"
    }
  ]
}

Get store analytics

get

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get analytics for

timeStrstringRequired

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

Default: 14d

Responses

200

The operation was successfully completed.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/analytics/{timeStr} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "orderAnalytics": [
      {
        "date": "2025-05-21T13:09:43.266Z",
        "orders": 1
      }
    ],
    "revenue": 1,
    "overallOrders": 1,
    "customers": 1,
    "visitors": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "visits": 1
      }
    ],
    "popularProducts": [
      {
        "product": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "name": "text",
          "description": "text",
          "tags": [
            "text"
          ],
          "imageNames": [
            "text"
          ],
          "cost": 1,
          "stock": 1,
          "amountSold": 1,
          "ignoreOutOfStock": true,
          "isPinned": true,
          "isDynamic": true,
          "rating": 1,
          "minimumQuantity": 1,
          "maximumQuantity": 1,
          "order": 1,
          "visibility": 0,
          "likes": 1,
          "customValueKeys": [
            "text"
          ],
          "store": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "url": "text",
            "customDomain": "text",
            "termsOfService": "text",
            "copyright": "text",
            "privacyPolicy": "text",
            "preferredCurrency": "text",
            "isVerified": true,
            "featuredProduct": "[Circular Reference]",
            "visits": 1,
            "reviews": 1,
            "rating": 1,
            "resolvedTickets": 1,
            "productsSold": 1,
            "theme": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            },
            "socialMediaAccounts": {
              "tikTok": "text",
              "youTube": "text",
              "twitter": "text",
              "facebook": "text",
              "discord": "text",
              "telegram": "text",
              "instagram": "text"
            },
            "profileImage": "text"
          }
        },
        "cost": 1
      }
    ],
    "orders": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "products": [
          {
            "product": "[Circular Reference]",
            "quantity": 1
          }
        ],
        "quantity": 1,
        "gateway": "text",
        "transactionId": "text",
        "cryptoAddress": "text",
        "customer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "emailAddress": "text",
          "linkedIntegrations": [
            "text"
          ]
        },
        "status": "text",
        "amountPaid": 1,
        "gatewayFee": 1,
        "hasWarranty": true,
        "isMarketplace": true,
        "customValues": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "cost": 1,
        "coupon": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "name": "text",
          "percentageDecrease": 1
        }
      }
    ],
    "overallVisitors": 1,
    "tickets": 1,
    "visitorsChange": 1,
    "customersChange": 1,
    "revenueChange": 1,
    "ordersChange": 1
  }
}

Delete frequently asked question

delete

Deletes a frequently asked question in the store by the ID, requires the Scopes.UpdateStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to create the FAQ in

faqIdstring · uuidRequired

The ID of the frequently asked question to delete

Responses

200

The object was successfully deleted.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

delete

DELETE /stores/{storeId}/faq/{faqId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": null
}

Get store reviews

get

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.

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to get the reviews for

pageinteger · int32Required

The page to select when viewing the reviews

Query parameters

countinteger · int32Optional

The amount of reviews to display in one page

Responses

200

The object was successfully returned.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/reviews/{page} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "pages": 1,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "rating": 1,
      "reason": "text",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "reply": "text"
    }
  ],
  "totalReviews": 1,
  "average": 1
}

Get public store by URL

get

Gets the publicly viewable representation of the store by the URL, does not require authorization

Authorizations

Path parameters

storeUrlstringRequired

The URL of the store, accepts either be the SellSN subdomain (ex. demo) or the fully qualified domain name (FQDN) for their custom domain

Responses

200

The object was successfully returned.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeUrl}/view HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "name": "text",
    "description": "text",
    "url": "text",
    "customDomain": "text",
    "termsOfService": "text",
    "copyright": "text",
    "privacyPolicy": "text",
    "preferredCurrency": "text",
    "isVerified": true,
    "featuredProduct": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "name": "text",
      "description": "text",
      "tags": [
        "text"
      ],
      "imageNames": [
        "text"
      ],
      "cost": 1,
      "stock": 1,
      "amountSold": 1,
      "ignoreOutOfStock": true,
      "isPinned": true,
      "isDynamic": true,
      "rating": 1,
      "minimumQuantity": 1,
      "maximumQuantity": 1,
      "order": 1,
      "visibility": 0,
      "likes": 1,
      "customValueKeys": [
        "text"
      ],
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "url": "text",
        "customDomain": "text",
        "termsOfService": "text",
        "copyright": "text",
        "privacyPolicy": "text",
        "preferredCurrency": "text",
        "isVerified": true,
        "featuredProduct": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "name": "text",
          "description": "text",
          "tags": [
            "text"
          ],
          "imageNames": [
            "text"
          ],
          "cost": 1,
          "stock": 1,
          "amountSold": 1,
          "ignoreOutOfStock": true,
          "isPinned": true,
          "isDynamic": true,
          "rating": 1,
          "minimumQuantity": 1,
          "maximumQuantity": 1,
          "order": 1,
          "visibility": 0,
          "likes": 1,
          "customValueKeys": [
            "text"
          ],
          "store": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "url": "text",
            "customDomain": "text",
            "termsOfService": "text",
            "copyright": "text",
            "privacyPolicy": "text",
            "preferredCurrency": "text",
            "isVerified": true,
            "featuredProduct": "[Circular Reference]",
            "visits": 1,
            "reviews": 1,
            "rating": 1,
            "resolvedTickets": 1,
            "productsSold": 1,
            "theme": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            },
            "socialMediaAccounts": {
              "tikTok": "text",
              "youTube": "text",
              "twitter": "text",
              "facebook": "text",
              "discord": "text",
              "telegram": "text",
              "instagram": "text"
            },
            "profileImage": "text"
          }
        },
        "visits": 1,
        "reviews": 1,
        "rating": 1,
        "resolvedTickets": 1,
        "productsSold": 1,
        "theme": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "socialMediaAccounts": {
          "tikTok": "text",
          "youTube": "text",
          "twitter": "text",
          "facebook": "text",
          "discord": "text",
          "telegram": "text",
          "instagram": "text"
        },
        "profileImage": "text"
      }
    },
    "visits": 1,
    "reviews": 1,
    "rating": 1,
    "resolvedTickets": 1,
    "productsSold": 1,
    "theme": {
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "username": "text",
      "allowMarketplace": true
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 1,
        "stock": 1,
        "amountSold": 1,
        "ignoreOutOfStock": true,
        "isPinned": true,
        "isDynamic": true,
        "rating": 1,
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "visibility": 0,
        "likes": 1,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": true,
          "featuredProduct": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "stock": 1,
            "amountSold": 1,
            "ignoreOutOfStock": true,
            "isPinned": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "dateCreated": "2025-05-21T13:09:43.266Z",
              "name": "text",
              "description": "text",
              "url": "text",
              "customDomain": "text",
              "termsOfService": "text",
              "copyright": "text",
              "privacyPolicy": "text",
              "preferredCurrency": "text",
              "isVerified": true,
              "featuredProduct": "[Circular Reference]",
              "visits": 1,
              "reviews": 1,
              "rating": 1,
              "resolvedTickets": 1,
              "productsSold": 1,
              "theme": {
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              },
              "socialMediaAccounts": {
                "tikTok": "text",
                "youTube": "text",
                "twitter": "text",
                "facebook": "text",
                "discord": "text",
                "telegram": "text",
                "instagram": "text"
              },
              "profileImage": "text"
            }
          },
          "visits": 1,
          "reviews": 1,
          "rating": 1,
          "resolvedTickets": 1,
          "productsSold": 1,
          "theme": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ],
    "groupedProducts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "products": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "stock": 1,
            "amountSold": 1,
            "ignoreOutOfStock": true,
            "isPinned": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "dateCreated": "2025-05-21T13:09:43.266Z",
              "name": "text",
              "description": "text",
              "url": "text",
              "customDomain": "text",
              "termsOfService": "text",
              "copyright": "text",
              "privacyPolicy": "text",
              "preferredCurrency": "text",
              "isVerified": true,
              "featuredProduct": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "dateCreated": "2025-05-21T13:09:43.266Z",
                "name": "text",
                "description": "text",
                "tags": [
                  "text"
                ],
                "imageNames": [
                  "text"
                ],
                "cost": 1,
                "stock": 1,
                "amountSold": 1,
                "ignoreOutOfStock": true,
                "isPinned": true,
                "isDynamic": true,
                "rating": 1,
                "minimumQuantity": 1,
                "maximumQuantity": 1,
                "order": 1,
                "visibility": 0,
                "likes": 1,
                "customValueKeys": [
                  "text"
                ],
                "store": {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "dateCreated": "2025-05-21T13:09:43.266Z",
                  "name": "text",
                  "description": "text",
                  "url": "text",
                  "customDomain": "text",
                  "termsOfService": "text",
                  "copyright": "text",
                  "privacyPolicy": "text",
                  "preferredCurrency": "text",
                  "isVerified": true,
                  "featuredProduct": "[Circular Reference]",
                  "visits": 1,
                  "reviews": 1,
                  "rating": 1,
                  "resolvedTickets": 1,
                  "productsSold": 1,
                  "theme": {
                    "properties": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  },
                  "socialMediaAccounts": {
                    "tikTok": "text",
                    "youTube": "text",
                    "twitter": "text",
                    "facebook": "text",
                    "discord": "text",
                    "telegram": "text",
                    "instagram": "text"
                  },
                  "profileImage": "text"
                }
              },
              "visits": 1,
              "reviews": 1,
              "rating": 1,
              "resolvedTickets": 1,
              "productsSold": 1,
              "theme": {
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              },
              "socialMediaAccounts": {
                "tikTok": "text",
                "youTube": "text",
                "twitter": "text",
                "facebook": "text",
                "discord": "text",
                "telegram": "text",
                "instagram": "text"
              },
              "profileImage": "text"
            }
          }
        ],
        "order": 1
      }
    ],
    "socialMediaAccounts": {
      "tikTok": "text",
      "youTube": "text",
      "twitter": "text",
      "facebook": "text",
      "discord": "text",
      "telegram": "text",
      "instagram": "text"
    }
  }
}

Get public store

get

Gets the publicly viewable representation of the store by the ID, does not require authorization

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store

Responses

200

The object was successfully returned.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

get

GET /stores/{storeId}/view_id HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "name": "text",
    "description": "text",
    "url": "text",
    "customDomain": "text",
    "termsOfService": "text",
    "copyright": "text",
    "privacyPolicy": "text",
    "preferredCurrency": "text",
    "isVerified": true,
    "featuredProduct": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "name": "text",
      "description": "text",
      "tags": [
        "text"
      ],
      "imageNames": [
        "text"
      ],
      "cost": 1,
      "stock": 1,
      "amountSold": 1,
      "ignoreOutOfStock": true,
      "isPinned": true,
      "isDynamic": true,
      "rating": 1,
      "minimumQuantity": 1,
      "maximumQuantity": 1,
      "order": 1,
      "visibility": 0,
      "likes": 1,
      "customValueKeys": [
        "text"
      ],
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "url": "text",
        "customDomain": "text",
        "termsOfService": "text",
        "copyright": "text",
        "privacyPolicy": "text",
        "preferredCurrency": "text",
        "isVerified": true,
        "featuredProduct": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "name": "text",
          "description": "text",
          "tags": [
            "text"
          ],
          "imageNames": [
            "text"
          ],
          "cost": 1,
          "stock": 1,
          "amountSold": 1,
          "ignoreOutOfStock": true,
          "isPinned": true,
          "isDynamic": true,
          "rating": 1,
          "minimumQuantity": 1,
          "maximumQuantity": 1,
          "order": 1,
          "visibility": 0,
          "likes": 1,
          "customValueKeys": [
            "text"
          ],
          "store": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "url": "text",
            "customDomain": "text",
            "termsOfService": "text",
            "copyright": "text",
            "privacyPolicy": "text",
            "preferredCurrency": "text",
            "isVerified": true,
            "featuredProduct": "[Circular Reference]",
            "visits": 1,
            "reviews": 1,
            "rating": 1,
            "resolvedTickets": 1,
            "productsSold": 1,
            "theme": {
              "properties": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            },
            "socialMediaAccounts": {
              "tikTok": "text",
              "youTube": "text",
              "twitter": "text",
              "facebook": "text",
              "discord": "text",
              "telegram": "text",
              "instagram": "text"
            },
            "profileImage": "text"
          }
        },
        "visits": 1,
        "reviews": 1,
        "rating": 1,
        "resolvedTickets": 1,
        "productsSold": 1,
        "theme": {
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "socialMediaAccounts": {
          "tikTok": "text",
          "youTube": "text",
          "twitter": "text",
          "facebook": "text",
          "discord": "text",
          "telegram": "text",
          "instagram": "text"
        },
        "profileImage": "text"
      }
    },
    "visits": 1,
    "reviews": 1,
    "rating": 1,
    "resolvedTickets": 1,
    "productsSold": 1,
    "theme": {
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "username": "text",
      "allowMarketplace": true
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 1,
        "stock": 1,
        "amountSold": 1,
        "ignoreOutOfStock": true,
        "isPinned": true,
        "isDynamic": true,
        "rating": 1,
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "visibility": 0,
        "likes": 1,
        "customValueKeys": [
          "text"
        ],
        "store": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2025-05-21T13:09:43.266Z",
          "name": "text",
          "description": "text",
          "url": "text",
          "customDomain": "text",
          "termsOfService": "text",
          "copyright": "text",
          "privacyPolicy": "text",
          "preferredCurrency": "text",
          "isVerified": true,
          "featuredProduct": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "stock": 1,
            "amountSold": 1,
            "ignoreOutOfStock": true,
            "isPinned": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "dateCreated": "2025-05-21T13:09:43.266Z",
              "name": "text",
              "description": "text",
              "url": "text",
              "customDomain": "text",
              "termsOfService": "text",
              "copyright": "text",
              "privacyPolicy": "text",
              "preferredCurrency": "text",
              "isVerified": true,
              "featuredProduct": "[Circular Reference]",
              "visits": 1,
              "reviews": 1,
              "rating": 1,
              "resolvedTickets": 1,
              "productsSold": 1,
              "theme": {
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              },
              "socialMediaAccounts": {
                "tikTok": "text",
                "youTube": "text",
                "twitter": "text",
                "facebook": "text",
                "discord": "text",
                "telegram": "text",
                "instagram": "text"
              },
              "profileImage": "text"
            }
          },
          "visits": 1,
          "reviews": 1,
          "rating": 1,
          "resolvedTickets": 1,
          "productsSold": 1,
          "theme": {
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "socialMediaAccounts": {
            "tikTok": "text",
            "youTube": "text",
            "twitter": "text",
            "facebook": "text",
            "discord": "text",
            "telegram": "text",
            "instagram": "text"
          },
          "profileImage": "text"
        }
      }
    ],
    "groupedProducts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "products": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "tags": [
              "text"
            ],
            "imageNames": [
              "text"
            ],
            "cost": 1,
            "stock": 1,
            "amountSold": 1,
            "ignoreOutOfStock": true,
            "isPinned": true,
            "isDynamic": true,
            "rating": 1,
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "visibility": 0,
            "likes": 1,
            "customValueKeys": [
              "text"
            ],
            "store": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "dateCreated": "2025-05-21T13:09:43.266Z",
              "name": "text",
              "description": "text",
              "url": "text",
              "customDomain": "text",
              "termsOfService": "text",
              "copyright": "text",
              "privacyPolicy": "text",
              "preferredCurrency": "text",
              "isVerified": true,
              "featuredProduct": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "dateCreated": "2025-05-21T13:09:43.266Z",
                "name": "text",
                "description": "text",
                "tags": [
                  "text"
                ],
                "imageNames": [
                  "text"
                ],
                "cost": 1,
                "stock": 1,
                "amountSold": 1,
                "ignoreOutOfStock": true,
                "isPinned": true,
                "isDynamic": true,
                "rating": 1,
                "minimumQuantity": 1,
                "maximumQuantity": 1,
                "order": 1,
                "visibility": 0,
                "likes": 1,
                "customValueKeys": [
                  "text"
                ],
                "store": {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "dateCreated": "2025-05-21T13:09:43.266Z",
                  "name": "text",
                  "description": "text",
                  "url": "text",
                  "customDomain": "text",
                  "termsOfService": "text",
                  "copyright": "text",
                  "privacyPolicy": "text",
                  "preferredCurrency": "text",
                  "isVerified": true,
                  "featuredProduct": "[Circular Reference]",
                  "visits": 1,
                  "reviews": 1,
                  "rating": 1,
                  "resolvedTickets": 1,
                  "productsSold": 1,
                  "theme": {
                    "properties": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  },
                  "socialMediaAccounts": {
                    "tikTok": "text",
                    "youTube": "text",
                    "twitter": "text",
                    "facebook": "text",
                    "discord": "text",
                    "telegram": "text",
                    "instagram": "text"
                  },
                  "profileImage": "text"
                }
              },
              "visits": 1,
              "reviews": 1,
              "rating": 1,
              "resolvedTickets": 1,
              "productsSold": 1,
              "theme": {
                "properties": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              },
              "socialMediaAccounts": {
                "tikTok": "text",
                "youTube": "text",
                "twitter": "text",
                "facebook": "text",
                "discord": "text",
                "telegram": "text",
                "instagram": "text"
              },
              "profileImage": "text"
            }
          }
        ],
        "order": 1
      }
    ],
    "socialMediaAccounts": {
      "tikTok": "text",
      "youTube": "text",
      "twitter": "text",
      "facebook": "text",
      "discord": "text",
      "telegram": "text",
      "instagram": "text"
    }
  }
}

Re-order products

patch

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

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to re-order the products for

Body

idstring · uuidOptional

isGroupbooleanOptional

orderinteger · int32Optional

Responses

200

The operation was successfully completed.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

patch

PATCH /stores/{storeId}/ordering HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 72

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isGroup": true,
    "order": 1
  }
]

{
  "success": true,
  "message": "text",
  "data": null
}

Create a new store

post

Creates a new store for the current user, requires the Scopes.CreateStores permission

Authorizations

Body

Form for updating or creating a store. This version is returned for authenticated API endpoints, any public endpoint will use a PublicStore or PublicStoreReference

namestring · min: 3 · max: 32Required

The name of the store as shown on the users store page

urlstring · min: 3 · max: 32Required

The subdomain part of the store URL, just one word and will qualify to x.sellsn.io

Pattern: ^[a-zA-Z0-9]*$

accentColorstring | nullableOptional

The HEX accent color used on the store to color buttons, inputs, etc.

descriptionstring | nullableOptional

The store description, shown on the store home page underneath the title

themeNamestring · min: 3 · max: 32Required

The name of the theme that is currently active on the store

leadingTextstring | nullableOptional

The text to show above the description on the store page where it would say 'Welcome to my store'

titlestring | nullableOptional

The title to display on the users browser when accessing the store page

termsOfServicestring | nullableOptional

The terms of service for the store

privacyPolicystring | nullableOptional

The privacy policy for the store

copyrightstring | nullableOptional

The copyright data to show at the bottom of the store page

hideViewCountbooleanOptional

Whether to hide the amount of views a store has on the store page

hideStatisticsbooleanOptional

Whether to hide every statistic for a store on the store page

isForcingDarkModebooleanOptional

Whether dark mode is forced on the sellers store page

preferredCurrencystring | nullableOptional

The ISO-compliant fiat currency code that is preferred for the store, defaults to USD

announcementstring | nullableOptional

The announcement to display on the sellers home page

sellerMessagestring | nullableOptional

The message from the seller to display when the sellers profile is shown

backgroundColorstring | nullableOptional

The HEX background color to display on the store page

cardBackgroundColorstring | nullableOptional

The HEX background color to use for cards on the store page

buttonColorstring | nullableOptional

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.

navigationColorstring | nullableOptional

The background color for the navigation bar on the store page

featuredProductIdstring · uuid | nullableOptional

The ID of the featured product to display on the store home page

Responses

200

The object was successfully created.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

post

POST /stores HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 689

{
  "name": "text",
  "url": "text",
  "accentColor": "text",
  "description": "text",
  "themeName": "text",
  "leadingText": "text",
  "title": "text",
  "termsOfService": "text",
  "privacyPolicy": "text",
  "copyright": "text",
  "hideViewCount": true,
  "hideStatistics": true,
  "isForcingDarkMode": true,
  "preferredCurrency": "text",
  "announcement": "text",
  "sellerMessage": "text",
  "backgroundColor": "text",
  "cardBackgroundColor": "text",
  "buttonColor": "text",
  "navigationColor": "text",
  "socialMediaAccounts": {
    "tikTok": "text",
    "youTube": "text",
    "twitter": "text",
    "facebook": "text",
    "discord": "text",
    "telegram": "text",
    "instagram": "text"
  },
  "featuredProductId": "123e4567-e89b-12d3-a456-426614174000",
  "themeProperties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "name": "text",
    "description": "text",
    "url": "text",
    "isVerified": true,
    "gross": 1,
    "theme": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "cost": 1,
        "amountSold": 1,
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "friendlyName": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "webhookUrl": "text",
        "visibility": 0,
        "isPinned": true,
        "isDynamic": true,
        "imageNames": [
          "text"
        ],
        "ignoreOutOfStock": true,
        "customValueKeys": [
          "text"
        ],
        "shouldBlockVirtualPrivateNetworks": true,
        "deliveryMessage": "text",
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "likes": 1,
        "isBestSeller": true,
        "blacklistedPaymentGateways": [
          "text"
        ],
        "additionalFees": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "metadata": "text"
      }
    ],
    "groupedProducts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "order": 1,
        "products": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "cost": 1,
            "amountSold": 1,
            "files": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "dateCreated": "2025-05-21T13:09:43.266Z",
                "friendlyName": "text"
              }
            ],
            "tags": [
              "text"
            ],
            "webhookUrl": "text",
            "visibility": 0,
            "isPinned": true,
            "isDynamic": true,
            "imageNames": [
              "text"
            ],
            "ignoreOutOfStock": true,
            "customValueKeys": [
              "text"
            ],
            "shouldBlockVirtualPrivateNetworks": true,
            "deliveryMessage": "text",
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "likes": 1,
            "isBestSeller": true,
            "blacklistedPaymentGateways": [
              "text"
            ],
            "additionalFees": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "metadata": "text"
          }
        ]
      }
    ],
    "termsOfService": "text",
    "copyright": "text",
    "privacyPolicy": "text",
    "visits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "visits": 1
      }
    ],
    "featuredProductId": "123e4567-e89b-12d3-a456-426614174000",
    "customDomain": "text",
    "lastCustomDomainUpdate": "2025-05-21T13:09:43.266Z",
    "socialMediaAccounts": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "tikTok": "text",
      "youTube": "text",
      "twitter": "text",
      "facebook": "text",
      "discord": "text",
      "telegram": "text",
      "instagram": "text"
    },
    "coupons": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "uses": 1,
        "maximumUses": 1,
        "percentageDecrease": 1,
        "isEnabled": true
      }
    ],
    "productsSoldOverride": 1,
    "reviewsOverride": 1,
    "resolvedTicketsOverride": 1,
    "viewsOverride": 1,
    "webhookSecret": "text",
    "preferredCurrency": "text"
  }
}

Upload a store logo

post

Removes and replaces the current store logo for the given store, requires the Scopes.UpdateStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to upload the logo to

Body

imagestring · binaryOptional

Responses

200

The object was successfully updated.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

post

POST /stores/{storeId}/image HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "name": "text",
    "description": "text",
    "url": "text",
    "isVerified": true,
    "gross": 1,
    "theme": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "cost": 1,
        "amountSold": 1,
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "friendlyName": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "webhookUrl": "text",
        "visibility": 0,
        "isPinned": true,
        "isDynamic": true,
        "imageNames": [
          "text"
        ],
        "ignoreOutOfStock": true,
        "customValueKeys": [
          "text"
        ],
        "shouldBlockVirtualPrivateNetworks": true,
        "deliveryMessage": "text",
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "likes": 1,
        "isBestSeller": true,
        "blacklistedPaymentGateways": [
          "text"
        ],
        "additionalFees": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "metadata": "text"
      }
    ],
    "groupedProducts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "order": 1,
        "products": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "cost": 1,
            "amountSold": 1,
            "files": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "dateCreated": "2025-05-21T13:09:43.266Z",
                "friendlyName": "text"
              }
            ],
            "tags": [
              "text"
            ],
            "webhookUrl": "text",
            "visibility": 0,
            "isPinned": true,
            "isDynamic": true,
            "imageNames": [
              "text"
            ],
            "ignoreOutOfStock": true,
            "customValueKeys": [
              "text"
            ],
            "shouldBlockVirtualPrivateNetworks": true,
            "deliveryMessage": "text",
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "likes": 1,
            "isBestSeller": true,
            "blacklistedPaymentGateways": [
              "text"
            ],
            "additionalFees": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "metadata": "text"
          }
        ]
      }
    ],
    "termsOfService": "text",
    "copyright": "text",
    "privacyPolicy": "text",
    "visits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "visits": 1
      }
    ],
    "featuredProductId": "123e4567-e89b-12d3-a456-426614174000",
    "customDomain": "text",
    "lastCustomDomainUpdate": "2025-05-21T13:09:43.266Z",
    "socialMediaAccounts": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "tikTok": "text",
      "youTube": "text",
      "twitter": "text",
      "facebook": "text",
      "discord": "text",
      "telegram": "text",
      "instagram": "text"
    },
    "coupons": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "uses": 1,
        "maximumUses": 1,
        "percentageDecrease": 1,
        "isEnabled": true
      }
    ],
    "productsSoldOverride": 1,
    "reviewsOverride": 1,
    "resolvedTicketsOverride": 1,
    "viewsOverride": 1,
    "webhookSecret": "text",
    "preferredCurrency": "text"
  }
}

Update a store

put

Replaces the given store with the information in the form, requires the Scopes.UpdateStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to update

Body

Form for updating or creating a store. This version is returned for authenticated API endpoints, any public endpoint will use a PublicStore or PublicStoreReference

namestring · min: 3 · max: 32Required

The name of the store as shown on the users store page

urlstring · min: 3 · max: 32Required

The subdomain part of the store URL, just one word and will qualify to x.sellsn.io

Pattern: ^[a-zA-Z0-9]*$

accentColorstring | nullableOptional

The HEX accent color used on the store to color buttons, inputs, etc.

descriptionstring | nullableOptional

The store description, shown on the store home page underneath the title

themeNamestring · min: 3 · max: 32Required

The name of the theme that is currently active on the store

leadingTextstring | nullableOptional

The text to show above the description on the store page where it would say 'Welcome to my store'

titlestring | nullableOptional

The title to display on the users browser when accessing the store page

termsOfServicestring | nullableOptional

The terms of service for the store

privacyPolicystring | nullableOptional

The privacy policy for the store

copyrightstring | nullableOptional

The copyright data to show at the bottom of the store page

hideViewCountbooleanOptional

Whether to hide the amount of views a store has on the store page

hideStatisticsbooleanOptional

Whether to hide every statistic for a store on the store page

isForcingDarkModebooleanOptional

Whether dark mode is forced on the sellers store page

preferredCurrencystring | nullableOptional

The ISO-compliant fiat currency code that is preferred for the store, defaults to USD

announcementstring | nullableOptional

The announcement to display on the sellers home page

sellerMessagestring | nullableOptional

The message from the seller to display when the sellers profile is shown

backgroundColorstring | nullableOptional

The HEX background color to display on the store page

cardBackgroundColorstring | nullableOptional

The HEX background color to use for cards on the store page

buttonColorstring | nullableOptional

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.

navigationColorstring | nullableOptional

The background color for the navigation bar on the store page

featuredProductIdstring · uuid | nullableOptional

The ID of the featured product to display on the store home page

Responses

200

The object was successfully updated.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

put

PUT /stores/{storeId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 689

{
  "name": "text",
  "url": "text",
  "accentColor": "text",
  "description": "text",
  "themeName": "text",
  "leadingText": "text",
  "title": "text",
  "termsOfService": "text",
  "privacyPolicy": "text",
  "copyright": "text",
  "hideViewCount": true,
  "hideStatistics": true,
  "isForcingDarkMode": true,
  "preferredCurrency": "text",
  "announcement": "text",
  "sellerMessage": "text",
  "backgroundColor": "text",
  "cardBackgroundColor": "text",
  "buttonColor": "text",
  "navigationColor": "text",
  "socialMediaAccounts": {
    "tikTok": "text",
    "youTube": "text",
    "twitter": "text",
    "facebook": "text",
    "discord": "text",
    "telegram": "text",
    "instagram": "text"
  },
  "featuredProductId": "123e4567-e89b-12d3-a456-426614174000",
  "themeProperties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "name": "text",
    "description": "text",
    "url": "text",
    "isVerified": true,
    "gross": 1,
    "theme": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "description": "text",
        "cost": 1,
        "amountSold": 1,
        "files": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "friendlyName": "text"
          }
        ],
        "tags": [
          "text"
        ],
        "webhookUrl": "text",
        "visibility": 0,
        "isPinned": true,
        "isDynamic": true,
        "imageNames": [
          "text"
        ],
        "ignoreOutOfStock": true,
        "customValueKeys": [
          "text"
        ],
        "shouldBlockVirtualPrivateNetworks": true,
        "deliveryMessage": "text",
        "minimumQuantity": 1,
        "maximumQuantity": 1,
        "order": 1,
        "likes": 1,
        "isBestSeller": true,
        "blacklistedPaymentGateways": [
          "text"
        ],
        "additionalFees": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "metadata": "text"
      }
    ],
    "groupedProducts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "order": 1,
        "products": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "dateCreated": "2025-05-21T13:09:43.266Z",
            "name": "text",
            "description": "text",
            "cost": 1,
            "amountSold": 1,
            "files": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "dateCreated": "2025-05-21T13:09:43.266Z",
                "friendlyName": "text"
              }
            ],
            "tags": [
              "text"
            ],
            "webhookUrl": "text",
            "visibility": 0,
            "isPinned": true,
            "isDynamic": true,
            "imageNames": [
              "text"
            ],
            "ignoreOutOfStock": true,
            "customValueKeys": [
              "text"
            ],
            "shouldBlockVirtualPrivateNetworks": true,
            "deliveryMessage": "text",
            "minimumQuantity": 1,
            "maximumQuantity": 1,
            "order": 1,
            "likes": 1,
            "isBestSeller": true,
            "blacklistedPaymentGateways": [
              "text"
            ],
            "additionalFees": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "metadata": "text"
          }
        ]
      }
    ],
    "termsOfService": "text",
    "copyright": "text",
    "privacyPolicy": "text",
    "visits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "visits": 1
      }
    ],
    "featuredProductId": "123e4567-e89b-12d3-a456-426614174000",
    "customDomain": "text",
    "lastCustomDomainUpdate": "2025-05-21T13:09:43.266Z",
    "socialMediaAccounts": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2025-05-21T13:09:43.266Z",
      "tikTok": "text",
      "youTube": "text",
      "twitter": "text",
      "facebook": "text",
      "discord": "text",
      "telegram": "text",
      "instagram": "text"
    },
    "coupons": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2025-05-21T13:09:43.266Z",
        "name": "text",
        "uses": 1,
        "maximumUses": 1,
        "percentageDecrease": 1,
        "isEnabled": true
      }
    ],
    "productsSoldOverride": 1,
    "reviewsOverride": 1,
    "resolvedTicketsOverride": 1,
    "viewsOverride": 1,
    "webhookSecret": "text",
    "preferredCurrency": "text"
  }
}

Setup custom domain

post

Begins the setup process for a custom domain, requires the Scopes.UpdateStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to create the custom domain for

Body

Form used to setup a new custom domain for a store

domainstring · min: 1Required

The new fully qualified domain name (FQDN) to setup as a custom domain, no protocols just a DNS name

Responses

200

The operation was successfully completed.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

post

POST /stores/{storeId}/custom-domain HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "domain": "text"
}

{
  "success": true,
  "message": "text",
  "data": {
    "name": "text",
    "value": "text",
    "type": "text"
  }
}

Reply to review

put

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store that the review belongs to

reviewIdstring · uuidRequired

The ID of the review to make the reply on

Body

Form for replying to a review

replystring · min: 8 · max: 4096Required

The reply to give the user on the review, this is displayed publicly

Responses

200

The operation was successfully completed.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

put

PUT /stores/{storeId}/reviews/{reviewId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "reply": "text"
}

{
  "success": true,
  "message": "text",
  "data": null
}

Flag a review

delete

Flags the given review for removal at discretion of the SellSN staff, requires the Scopes.FlagReviews permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store the review belongs to

reviewIdstring · uuidRequired

The ID of the review to flag

Body

Form used to flag a review for deletion

reasonstring · min: 1 · max: 2048Required

The reason the review is invalid and needs to be removed from the store

Responses

200

The operation was successfully completed.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

delete

DELETE /stores/{storeId}/reviews/{reviewId} HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "reason": "text"
}

{
  "success": true,
  "message": "text",
  "data": null
}

Create frequently asked question

put

Creates a frequently asked question in the store to be displayed on the store page, requires the Scopes.UpdateStores permission

Authorizations

Path parameters

storeIdstring · uuidRequired

The ID of the store to create the FAQ in

Body

A frequently asked question for a store, used for updating, creating and returning a frequently asked question

titlestring · min: 3 · max: 1024Required

The title for the question, or just the question

descriptionstring · min: 3 · max: 8192Required

The description or answer to the question

Responses

200

The object was successfully created.

400

The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.

401

You are not authorized, check your API key and try again.

403

You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.

404

One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

put

PUT /stores/{storeId}/faq HTTP/1.1
Host: api.sellsn.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "title": "text",
  "description": "text"
}

{
  "success": true,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2025-05-21T13:09:43.266Z",
    "key": "text",
    "value": "text"
  }
}