📒Products

Creating, reading, updating and deleting products

Get all products

Gets all the products in a store, does not use pagination but in turn only returns a reference which redacts a lot of data from the product. Requires the Scopes.ViewProducts permissions

GEThttps://api.sellsn.io/stores/{storeId}/products

Path parameters

storeId*string (uuid)

The ID of the store to get all the products for

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

datanullable array of PublicProductReference (object)

The optional return data from the operation

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-16T23:10:56.934Z",
      "name": "text",
      "description": "text",
      "tags": [
        "text"
      ],
      "imageNames": [
        "text"
      ],
      "cost": 0,
      "ignoreOutOfStock": false,
      "isPinned": false,
      "isDynamic": false,
      "rating": 0,
      "visibility": 0,
      "customValueKeys": [
        "text"
      ],
      "store": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "name": "text",
        "description": "text",
        "url": "text",
        "customDomain": "text",
        "termsOfService": "text",
        "copyright": "text",
        "privacyPolicy": "text",
        "preferredCurrency": "text",
        "isVerified": false,
        "rating": 0,
        "theme": {},
        "socialMediaAccounts": {
          "tikTok": "text",
          "youTube": "text",
          "twitter": "text",
          "facebook": "text",
          "discord": "text",
          "telegram": "text",
          "instagram": "text"
        },
        "profileImage": "text"
      }
    }
  ]
}

Create product

Creates a new product in the given store, requires the Scopes.CreateProducts permission

POSThttps://api.sellsn.io/stores/{storeId}/products

Path parameters

storeId*string (uuid)

The ID of the store to create the product in

Body

The form containing the new product details

name*string

The name of the product, this is displayed publicly on the store page and marketplace

cost*number (double)

The cost of the product

ignoreOutOfStockboolean

Whether the system should ignore if the product is "Out of stock" and allow purchasing the product anyway, mandatory for dynamic products

isDynamicboolean

Whether the product is a dynamic product type, in this case the response from the webhook will dictate the item

tagsnullable array of string

The tags on the product, very helpful for boosting the products SEO on the marketplace

webhookUrlnullable string

The webhook URL to send dynamic product requests and just delivery notifications to

descriptionnullable string

The description of the product, supports markdown and images from Imgur only

visibility*Privacy (enum)

List of product visibility (or privacy) levels

0123

deliveryMessagenullable string

The message to put on the completed delivery email when the product has been delivered

customValueKeysnullable array of string

The custom field names to prompt the user with when buying the product

minimumQuantityinteger (int32)

The minimum quantity required to buy the product, defaults to 1

maximumQuantityinteger (int32)

The maximum quantity the user is allowed to buy for the product, -1 = no limit

shouldBlockVirtualPrivateNetworksboolean

Whether VPNs and proxies are blocked from purchasing the product, very good for Stripe

blacklistedPaymentGatewaysnullable array of string

The array of blacklisted payment methods for the specific product, must be a valid SellSN payment method ID

isBestSellerboolean

Whether the product should be marked as a best seller on the users store page, does nothing for the marketplace

Response

The object was successfully created.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataProduct (object)

Represents a product that is registered to a store

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cost": 0,
      "name": "text",
      "visibility": 0
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "cost": 0,
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "friendlyName": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "webhookUrl": "text",
    "visibility": 0,
    "isPinned": false,
    "isDynamic": false,
    "imageNames": [
      "text"
    ],
    "ignoreOutOfStock": false,
    "customValueKeys": [
      "text"
    ],
    "shouldBlockVirtualPrivateNetworks": false,
    "deliveryMessage": "text",
    "isBestSeller": false,
    "blacklistedPaymentGateways": [
      "text"
    ],
    "metadata": "text"
  }
}

Get products

Gets the products from a store and returns them as a paginated response, requires the Scopes.ViewProducts permission

GEThttps://api.sellsn.io/stores/{storeId}/products/{page}

Path parameters

storeId*string (uuid)

The ID of the store to get the products for

page*integer (int32)

The page to select when viewing the products

Query parameters

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

pagesinteger (int32)

The amount of pages there are

datanullable array of Product (object)

The data for the page

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{page}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-16T23:10:56.934Z",
      "name": "text",
      "description": "text",
      "cost": 0,
      "files": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "dateCreated": "2024-09-16T23:10:56.934Z",
          "friendlyName": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "webhookUrl": "text",
      "visibility": 0,
      "isPinned": false,
      "isDynamic": false,
      "imageNames": [
        "text"
      ],
      "ignoreOutOfStock": false,
      "customValueKeys": [
        "text"
      ],
      "shouldBlockVirtualPrivateNetworks": false,
      "deliveryMessage": "text",
      "isBestSeller": false,
      "blacklistedPaymentGateways": [
        "text"
      ],
      "metadata": "text"
    }
  ]
}

Get product by ID

Finds and returns a product by it's ID, requires the Scopes.ViewProducts permission

GEThttps://api.sellsn.io/stores/{storeId}/products/{productId}

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product to get

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataProduct (object)

Represents a product that is registered to a store

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "cost": 0,
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "friendlyName": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "webhookUrl": "text",
    "visibility": 0,
    "isPinned": false,
    "isDynamic": false,
    "imageNames": [
      "text"
    ],
    "ignoreOutOfStock": false,
    "customValueKeys": [
      "text"
    ],
    "shouldBlockVirtualPrivateNetworks": false,
    "deliveryMessage": "text",
    "isBestSeller": false,
    "blacklistedPaymentGateways": [
      "text"
    ],
    "metadata": "text"
  }
}

Update product

Updates a product in a store, requires the Scopes.UpdateProducts permission

PUThttps://api.sellsn.io/stores/{storeId}/products/{productId}

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product to update

Body

The form containing the new product details to update

name*string

The name of the product, this is displayed publicly on the store page and marketplace

cost*number (double)

The cost of the product

ignoreOutOfStockboolean

Whether the system should ignore if the product is "Out of stock" and allow purchasing the product anyway, mandatory for dynamic products

isDynamicboolean

Whether the product is a dynamic product type, in this case the response from the webhook will dictate the item

tagsnullable array of string

The tags on the product, very helpful for boosting the products SEO on the marketplace

webhookUrlnullable string

The webhook URL to send dynamic product requests and just delivery notifications to

descriptionnullable string

The description of the product, supports markdown and images from Imgur only

visibility*Privacy (enum)

List of product visibility (or privacy) levels

0123

deliveryMessagenullable string

The message to put on the completed delivery email when the product has been delivered

customValueKeysnullable array of string

The custom field names to prompt the user with when buying the product

minimumQuantityinteger (int32)

The minimum quantity required to buy the product, defaults to 1

maximumQuantityinteger (int32)

The maximum quantity the user is allowed to buy for the product, -1 = no limit

shouldBlockVirtualPrivateNetworksboolean

Whether VPNs and proxies are blocked from purchasing the product, very good for Stripe

blacklistedPaymentGatewaysnullable array of string

The array of blacklisted payment methods for the specific product, must be a valid SellSN payment method ID

isBestSellerboolean

Whether the product should be marked as a best seller on the users store page, does nothing for the marketplace

Response

Success

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cost": 0,
      "name": "text",
      "visibility": 0
    }),
});
const data = await response.json();

Set custom fee

Sets a custom fee for a specific product in a store, requires the Scopes.UpdateProducts permission

PUThttps://api.sellsn.io/stores/{storeId}/products/{productId}/fees

Path parameters

storeId*string (uuid)

The ID of the store that the product belongs to

productId*string (uuid)

The ID of the product to set the fees for

Body

The form containing the custom additional fee data

paymentMethod*string

The payment method to set the fee percentage for, must be a valid SellSN payment method ID

feePercentagenullable number (double)

The fee percentage to apply for the specific payment method, leave as null to remove the existing fee

Response

The object was successfully updated.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

datanullable any

The optional return data from the operation

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/fees', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "paymentMethod": "text"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Add image to product

Adds a new image to the product, the image must be PNG, JPG, WebP or GIF and below 30 megabytes in size, requires the Scopes.UpdateProducts permission

PATCHhttps://api.sellsn.io/stores/{storeId}/products/{productId}/image

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product to add the image to

Body

imagestring (binary)

Response

The object was successfully created.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataProduct (object)

Represents a product that is registered to a store

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/image', {
    method: 'PATCH',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "cost": 0,
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "friendlyName": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "webhookUrl": "text",
    "visibility": 0,
    "isPinned": false,
    "isDynamic": false,
    "imageNames": [
      "text"
    ],
    "ignoreOutOfStock": false,
    "customValueKeys": [
      "text"
    ],
    "shouldBlockVirtualPrivateNetworks": false,
    "deliveryMessage": "text",
    "isBestSeller": false,
    "blacklistedPaymentGateways": [
      "text"
    ],
    "metadata": "text"
  }
}

Add file to product

Adds a file to the product, there can only be one file uploaded to a product at a time for delivery and this will replace any existing file, requires the Scopes.UpdateProducts permission

PATCHhttps://api.sellsn.io/stores/{storeId}/products/{productId}/file

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product the file should be uploaded to

Body

filestring (binary)

Response

The object was successfully created.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataProduct (object)

Represents a product that is registered to a store

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/file', {
    method: 'PATCH',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "cost": 0,
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "friendlyName": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "webhookUrl": "text",
    "visibility": 0,
    "isPinned": false,
    "isDynamic": false,
    "imageNames": [
      "text"
    ],
    "ignoreOutOfStock": false,
    "customValueKeys": [
      "text"
    ],
    "shouldBlockVirtualPrivateNetworks": false,
    "deliveryMessage": "text",
    "isBestSeller": false,
    "blacklistedPaymentGateways": [
      "text"
    ],
    "metadata": "text"
  }
}

Remove image from product

Removes an image from a product, uses the file name of the image used to access it from S3, requires the Scopes.UpdateProducts permission

DELETEhttps://api.sellsn.io/stores/{storeId}/products/{productId}/image/{fileName}

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product the image belongs to

fileName*string

The file name of the image to remove

Response

The object was successfully deleted.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicProduct (object)

Represents a product that is public facing, like on the marketplace

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/image/{fileName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "imageNames": [
      "text"
    ],
    "imageLinks": [
      "text"
    ],
    "cost": 0,
    "ignoreOutOfStock": false,
    "isPinned": false,
    "isDynamic": false,
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-16T23:10:56.934Z",
      "name": "text",
      "description": "text",
      "url": "text",
      "customDomain": "text",
      "termsOfService": "text",
      "copyright": "text",
      "privacyPolicy": "text",
      "preferredCurrency": "text",
      "isVerified": false,
      "featuredProduct": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ]
      },
      "rating": 0,
      "theme": {},
      "socialMediaAccounts": {
        "tikTok": "text",
        "youTube": "text",
        "twitter": "text",
        "facebook": "text",
        "discord": "text",
        "telegram": "text",
        "instagram": "text"
      },
      "profileImage": "text"
    },
    "reviews": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "reason": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "reply": "text"
      }
    ],
    "category": "text",
    "deliveryMessage": "text",
    "blacklistedPaymentGateways": [
      "text"
    ],
    "rating": 0,
    "shouldBlockVirtualPrivateNetworks": false,
    "customValueKeys": [
      "text"
    ],
    "visibility": 0,
    "isBestSeller": false
  }
}

Remove file from product

Removes a file from the product and deletes it's link on S3, this means that users who have already been delivered a link to the file will lose it. Requires the Scopes.UpdateProducts permission

DELETEhttps://api.sellsn.io/stores/{storeId}/products/{productId}/file/{fileId}

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product the file belongs to

fileId*string (uuid)

The ID of the file to remove

Response

The object was successfully deleted.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataProduct (object)

Represents a product that is registered to a store

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/file/{fileId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "cost": 0,
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "friendlyName": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "webhookUrl": "text",
    "visibility": 0,
    "isPinned": false,
    "isDynamic": false,
    "imageNames": [
      "text"
    ],
    "ignoreOutOfStock": false,
    "customValueKeys": [
      "text"
    ],
    "shouldBlockVirtualPrivateNetworks": false,
    "deliveryMessage": "text",
    "isBestSeller": false,
    "blacklistedPaymentGateways": [
      "text"
    ],
    "metadata": "text"
  }
}

Get product by ID

Gets and returns a product by it's ID, does not require authorization nor a store ID but will return a public product instead which redacts sensitive information

GEThttps://api.sellsn.io/products/{productId}/view

Path parameters

productId*string (uuid)

The ID of the product to get

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

dataPublicProduct (object)

Represents a product that is public facing, like on the marketplace

Request

const response = await fetch('https://api.sellsn.io/products/{productId}/view', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "dateCreated": "2024-09-16T23:10:56.934Z",
    "name": "text",
    "description": "text",
    "tags": [
      "text"
    ],
    "imageNames": [
      "text"
    ],
    "imageLinks": [
      "text"
    ],
    "cost": 0,
    "ignoreOutOfStock": false,
    "isPinned": false,
    "isDynamic": false,
    "store": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-16T23:10:56.934Z",
      "name": "text",
      "description": "text",
      "url": "text",
      "customDomain": "text",
      "termsOfService": "text",
      "copyright": "text",
      "privacyPolicy": "text",
      "preferredCurrency": "text",
      "isVerified": false,
      "featuredProduct": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "name": "text",
        "description": "text",
        "tags": [
          "text"
        ],
        "imageNames": [
          "text"
        ],
        "cost": 0,
        "ignoreOutOfStock": false,
        "isPinned": false,
        "isDynamic": false,
        "rating": 0,
        "visibility": 0,
        "customValueKeys": [
          "text"
        ]
      },
      "rating": 0,
      "theme": {},
      "socialMediaAccounts": {
        "tikTok": "text",
        "youTube": "text",
        "twitter": "text",
        "facebook": "text",
        "discord": "text",
        "telegram": "text",
        "instagram": "text"
      },
      "profileImage": "text"
    },
    "reviews": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "dateCreated": "2024-09-16T23:10:56.934Z",
        "reason": "text",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "reply": "text"
      }
    ],
    "category": "text",
    "deliveryMessage": "text",
    "blacklistedPaymentGateways": [
      "text"
    ],
    "rating": 0,
    "shouldBlockVirtualPrivateNetworks": false,
    "customValueKeys": [
      "text"
    ],
    "visibility": 0,
    "isBestSeller": false
  }
}

Get product reviews

Gets and returns the paginated and public reviews for a product, does not require authorization

GEThttps://api.sellsn.io/product/{productId}/view/reviews/{page}

Path parameters

productId*string (uuid)

The ID of the product to get the reviews for

page*integer (int32)

The page to select when viewing the reviews

Query parameters

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

pagesinteger (int32)

The amount of pages there are

datanullable array of PublicReview (object)

The data for the page

Request

const response = await fetch('https://api.sellsn.io/product/{productId}/view/reviews/{page}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "dateCreated": "2024-09-16T23:10:56.934Z",
      "reason": "text",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "reply": "text"
    }
  ]
}

Get product items

Gets the items associated with a product which will be given on delivery, requires the Scopes.ViewProducts permission

GEThttps://api.sellsn.io/stores/{storeId}/products/{productId}/items/{page}

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product to get the items from

page*integer (int32)

The page to select when viewing the items

Query parameters

Response

The object was successfully returned.

Body

successboolean

Whether the operation was successful

pagesinteger (int32)

The amount of pages there are

datanullable array of string

The data for the page

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/items/{page}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "data": [
    "text"
  ]
}

Add items to product

Adds a list of items to the given product, requires the Scopes.UpdateProducts permission

PUThttps://api.sellsn.io/stores/{storeId}/products/{productId}/items

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product the items should be added to

Body

The form containing the new items to add to the product

itemsnullable array of string

The array of items to add to the product, this will append the items to the end of the existing items

Response

The object was successfully created.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

datanullable any

The optional return data from the operation

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/items', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Remove items from product

Removes all the items in the given form from the product, requires the Scopes.UpdateProducts permission

DELETEhttps://api.sellsn.io/stores/{storeId}/products/{productId}/items

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product to remove the items from

Body

The form containing all the items to remove from the product

itemsnullable array of string

The array of items to add to the product, this will append the items to the end of the existing items

Response

The object was successfully deleted.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

datanullable any

The optional return data from the operation

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/items', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Clear product items

Clears and completely resets the items associated with a product, requires the Scopes.UpdateProducts permission

DELETEhttps://api.sellsn.io/stores/{storeId}/products/{productId}/items/clear

Path parameters

storeId*string (uuid)

The ID of the store the product belongs to

productId*string (uuid)

The ID of the product whose items should be cleared

Response

The operation was successfully completed.

Body

successboolean

Whether the operation was successful

messagenullable string

The optional message given by the operation

datanullable any

The optional return data from the operation

Request

const response = await fetch('https://api.sellsn.io/stores/{storeId}/products/{productId}/items/clear', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

PreviousStores NextProduct groups

Last updated 5 months ago