• Products
• Product Categories
• Team
• Employees
• Orders
• Discount Codes
• Purchase Order Management
• Reports
• Channel - Website
  • Articles
  • Data Object: Article
  • Data Object: Brand
  • Data Object: Cities
  • Data Object: Countries
  • Data Object: Customer
  • Data Object: Order
  • Data Object: Payment Method
  • Data Object: Predefined Objects
  • Data Object: Product
  • Data Object: Product Categories
  • Data Object: Product Set
  • Data Object: Promo Banners
  • Data Object: Property
  • Data Object: Property Group
  • Data Object: Shipping Rates
  • Data Object: Shopping Cart
  • Data Object: Slider
  • Data Object: States
  • Data Object: Wish List
  • End Point: Account
  • End Point: Order
  • End Point: Send Email
  • End Point: Shopping Cart
  • End Point: Subscribe
  • End Point: Wish List
  • Promo Banners
  • Sliders
  • Twig - Template Engine
• Channel - POS

1. Home
2. Help
3. Channel - Website
4. Data Object: Product

Data Object: Product

{{ data.product.get(:id) }}

HHTP/1.1 200 OK
{
     id: 5,
     alias: 'lego-batman',
     categoryId: 10,
     categoryName: Baby Toys,
     brandId: 2,
     title: "Lego BatMan",
     description: "Celebrate THE LEGO® BATMAN MOVIE with a LEGO BrickHeadz Batman!",
     seoTitle: "Lego BatMan - Store",
     seoKeywords: "lego, batman, sale",
     seoDescription: "Celebrate The Lego Batman Movie",
     schemaJson: "{}",
     quantity: 5,
     price: 9.99,
     salePrice: 7.5
     saleStartDate: "", 
     saleEndDate: "",
     propertyGroups: [
         {
              id: 0,
              title: "Default",
              properties: [
                  {
                      id: 1,
                      type: 1,
                      title: "Technology",
                      valueId: null,
                      value: "GSM HSPA LTE/4G 3G CDMA EVDO"  
                  }
              ]
         },
         {
              id: 1,
              title: "Platform",
              properties: [
                  {
                      id: 1,
                      type: 1,
                      title: "Operation System",
                      valueId: 2,
                      value: "Android 11"  
                  }
              ]
         }
     ],
     thumbnail: "https://test.com/middle-image.png",
     photos: [
         800: "https://test.com/large-image.png",
         300: "https://test.com/middle-image.png",
         100: "https://test.com/small-image.png"
     ],
     facebookImageUrl: "https://test.com/fb.png",
     created: {
         date: "2017-08-13 04:47:28.000000", 
         timezone: "America/Los_Angeles"
     },
     updated: {
         date: "2017-08-13 04:47:28.000000", 
         timezone: "America/Los_Angeles"
     }
}

or

false

{{ data.product.list({}) }}

HTTP/1.1 200 OK
{
    {
         id: 5,
         alias: 'lego-batman',
         categoryId: 10,
         categoryName: Baby Toys,
         brandId: 2,
         title: "Lego BatMan",
         description: "Celebrate THE LEGO® BATMAN MOVIE with a LEGO BrickHeadz Batman!",
         seoTitle: "Lego BatMan - Store",
         seoKeywords: "lego, batman, sale",
         seoDescription: "Celebrate The Lego Batman Movie",
         schemaJson: "{}",
         quantity: 5,
         price: 9.99,
         salePrice: 7.5
         saleStartDate: "", 
         saleEndDate: "",
         thumbnail: "https://test.com/middle-image.png",
         photos: [
              800: "https://test.com/large-image.png",
              300: "https://test.com/middle-image.png",
              100: "https://test.com/small-image.png"
         ],
         facebookImageUrl: "https://test.com/fb.png",
         created: "",
         updated: ""
    }
    ...
}

or

[]

HTTP/1.1 200 OK
{
    count: 10,
    data: [
       {
            id: 5,
            categoryId: 10,
            categoryName: Baby Toys,
            brandId: 2,
            title: "Lego BatMan",
            description: "Celebrate THE LEGO® BATMAN MOVIE with a LEGO BrickHeadz Batman!",
            quantity: 5,
            price: 9.99,
            salePrice: 7.5
            saleStartDate: "", 
            saleEndDate: "",
            thumbnail: "https://test.com/middle-image.png",
            photos: [
                 800: "https://test.com/large-image.png",
                 300: "https://test.com/middle-image.png",
                 100: "https://test.com/small-image.png"
            ],
            facebookImageUrl: "https://test.com/fb.png"
            created: "",
            updated: ""
       }
       ...
    ]
}

or

{
    count: 0,
    data: []
}

{{ data.product.compare([productId1, productId2]) }}

HTTP/1.1 200 OK
{
    properties: [
        {
            id: 1,
            type: 1,
            title: "Screen Size",
            values: [
                productId1: {
                    id: 5,
                    title: "14 inch"
                }
                productId2: {
                    id: 5,
                    title: "16 inch"
                },      
            ]
        },
        {
            id: 2,
            type: 2,
            title: "Wireless",
            values: [
                productId1: null,
                productId2: {
                    id: null,
                    title: "Yes"
                },      
            ]
        } 
    ]    
}

or

{
    properties: []
}