Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.videowise.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

https://api.videowise.com

​
Bulk Product Import

​
POST /external/product/v1/bulk

Imports or modifies list of products into the system.

​
Headers

KeyTypeRequiredDescription
X-Videowise-Access-TokenStringYesAccess token to authorize the request.

​
Request Body

  • siteId (string, required): The site ID to associate with the products.
  • siteType (string, required): The type of site to associate with the products.
  • products (array of Product Object, required): List of products to be imported.
Product Object:
FieldTypeRequiredDescription
idStringYesThe unique identifier of the product.
skuStringYesThe SKU of the product.
titleStringYesThe name of the product.
descriptionStringNoThe description of the product.
priceNumberNoThe price of the product.
price_minNumberNoThe minimum price of the product.
price_maxNumberNoThe maximum price of the product.
availableBooleanYesWhether the product is available.
images[String]NoList of image URLs for the product.
featured_imageStringYesThe image URL of the product.
urlStringYesThe URL of the product.

​
Example Request

{
  "siteId": "YourSiteID",
  "siteType": "Salesforce",
  "products": [
    {
      "id": "008884303989",
      "sku": "008884303989",
      "title": "Platinum Blue Stripes Easy Care Fitted Shirt",
      "description": "An elegant fitted shirt with blue stripes.",
      "price": 35,
      "price_min": 35,
      "price_max": 35,
      "available": true,
      "images": ["https://example.com/image1.jpg"],
      "featured_image": "https://example.com/image1.jpg",
      "url": "https://example.com/product1"
    },
    {
      "id": "008884303990",
      "sku": "008884303990",
      "title": "Test Shirt",
      "description": "A test product.",
      "price": 60,
      "available": true,
      "featured_image": "https://example.com/image2.jpg",
      "url": "https://example.com/product2"
    }
  ]
}

​
Response

StatusDescription
200Products imported successfully.
400Bad request or site not found.
401Unauthorized access.

​
Bulk Product Import CSV

​
POST /external/product/v1/bulk/csv

Imports or modifies list of products into the system.

​
Headers

KeyTypeRequiredDescription
X-Videowise-Access-TokenStringYesAccess token to authorize the request.

​
Request Body

  • siteId (string, required): The site ID to associate with the products.
  • siteType (string, required): The type of site to associate with the products.
  • csvContent (string, required): CSV Content.
CSV Content: The CSV content should be formatted as follows:
  • First row: Headers containing the field names (id, sku, title, description, price, price_min, price_max, available, images, featured_image, url)
  • Following rows: Product data corresponding to each Product Object field
CSV Format: 
id,sku,title,description,price,price_min,price_max,available,images,featured_image,url
008884303989,008884303989,Platinum Blue Stripes Easy Care Fitted Shirt,An elegant fitted shirt with blue stripes,35,35,35,true,https://example.com/image1.jpg,https://example.com/image1.jpg,https://example.com/product1
008884303990,008884303990,Test Shirt,A test product.,60,60,60,true,["https://example.com/image1.jpg","https://example.com/image2.jpg"],https://example.com/image1.jpg,https://example.com/product2
Field Requirements: Same as the Product Object defined in the Bulk Product Import section. Notes:
  • For single images use string format
  • For multiple images, use JSON array format: [\"url1\",\"url2\"]
  • Boolean values should be true or false
  • Ensure proper CSV escaping for fields containing commas or quotes

​
Example Request

{
  "siteId": "YourSiteID",
  "siteType": "Salesforce",
  "csvContent": "id,sku,title,description,price,price_min,price_max,available,images,featured_image,url\n008884303989,008884303989,Platinum Blue Stripes Easy Care Fitted Shirt,An elegant fitted shirt with blue stripes,35,35,35,true,https://example.com/image1.jpg,https://example.com/image1.jpg,https://example.com/product1\n008884303990,008884303990,Test Shirt,A test product.,60,60,60,true,[\"https://example.com/image1.jpg\",\"https://example.com/image2.jpg\"],https://example.com/image1.jpg,https://example.com/product2"
}

​
Response

StatusDescription
200Products imported successfully.
400Bad request or site not found.
401Unauthorized access.

​
Single Product Import

​
POST /external/product/v1

Imports or modifies single product into the system.

​
Headers

KeyTypeRequiredDescription
X-Videowise-Access-TokenStringYesAccess token to authorize the request.

​
Request Body

  • siteId (string, required): The site ID to associate with the product.
  • siteType (string, required): The type of site to associate with the product.
  • product (Product Object, required): The product to be imported.
Product Object: Same as defined in the Bulk Product Import section.

​
Example Request

{
  "siteId": "YourSiteID",
  "siteType": "Magento",
  "product": {
    "id": "008884303989",
    "sku": "008884303989",
    "title": "Platinum Blue Stripes Easy Care Fitted Shirt",
    "description": "An elegant fitted shirt with blue stripes.",
    "price": 35,
    "price_min": 35,
    "price_max": 35,
    "available": true,
    "images": ["https://example.com/image1.jpg"],
    "featured_image": "https://example.com/image1.jpg",
    "url": "https://example.com/product1"
  }
}

​
Response

StatusDescription
200Product imported successfully.
400Bad request or site not found.
401Unauthorized access.

​
Retrieve Product

​
GET /external/product/v1/:productId

Retrieves a product by its reference ID or SKU.

​
Headers

KeyTypeRequiredDescription
X-Videowise-Access-TokenStringYesAccess token to authorize the request.

​
Query Parameters

ParameterTypeRequiredDescription
siteIdStringYesThe site ID to search for.
siteTypeStringYesThe site type to search for.

​
Example Request

GET /external/product/v1/008884303989?siteId=YourSiteID&siteType=Salesforce

​
Response

FieldTypeDescription
idStringThe unique identifier of the product.
skuStringThe SKU of the product.
titleStringThe name of the product.
featured_imageStringThe image URL of the product.
urlStringThe URL of the product.
{
  "id": "008884303989",
  "sku": "008884303989",
  "title": "Platinum Blue Stripes Easy Care Fitted Shirt",
  "featured_image": "https://example.com/image1.jpg",
  "url": "https://example.com/product1"
}
StatusDescription
200Product retrieved successfully.
400Bad request or product not found.
401Unauthorized access.

​
Delete Product

​
DELETE /external/product/v1/:productId

Deletes a product by its reference ID or SKU.

​
Headers

KeyTypeRequiredDescription
X-Videowise-Access-TokenStringYesAccess token to authorize the request.

​
Query Parameters

ParameterTypeRequiredDescription
siteIdStringYesThe site ID to search for.
siteTypeStringYesThe site type to search for.

​
Example Request

DELETE /external/product/v1/008884303989?siteId=YourSiteID&siteType=Salesforce

​
Response

FieldTypeDescription
messageStringConfirmation of product deletion.
{
  "message": "Product deleted successfully."
}
StatusDescription
200Product deleted successfully.
400Bad request or product could not be deleted.
401Unauthorized access.

​
Error Codes

StatusDescription
400Bad request. This occurs when required parameters or body fields are missing.
401Unauthorized. Access token is missing or invalid.
404Resource not found. Site or product does not exist.