Skip to main content

Custom Integration

The clients must have an API (usually a GET request with a JSON response) that allows us to get information for a list of products via ID/SKU. Smartzer prefers a single endpoint that contains information for all requested products.

This enables a direct real-time connection between the client’s product catalog and the Smartzer video tagging platform where full product details can be pulled in simply using the product IDs.

The API response should contain as many of the below fields as possible/relevant:

  • Brand name (if applicable)
  • Product name
  • Product image(s)
  • Product variants (size/colour) (if supported)
    • Variant name
    • Variant image (if supported)
    • Variant SKU/ID
    • Variant availability (if supported)
    • Variant price (if supported)
  • Product availability/stock information (if supported)
  • Product price
  • Product SKU/ID
  • Product Description
  • Either a direct URL to the product or a way to derive the URL from the fields returned.

If the integration requires coverage for additional market variations (language/currency):

  • Access to currency endpoint
  • Access to attribute sets
  • Store codes (for different languages)

For the direct Add to Basket functionality, please see the Add to Basket API.