API Reference

This webhook payload is designed for notifying newly published product data. It provides comprehensive information about the product, including descriptions, pricing, and multimedia content, to ensure that all relevant systems and platforms are updated with the latest product offerings.

Event Sent

{
  "type": "new_product",
  "action_date": "2024-06-19 02:12:57",
  "payload": [
    {
      "product_id": 107335,
      "sku": "SKU9999",
      "link": "https://www.testingproductimage.com",
      "upc": null,
      "color": "Stainless Steel",
      "name": "60 1/4\" Stainless Steel Undercounter - SKU9999",
      "basic_description": "60 1/4\" Stainless Steel Undercounter - SKU9999",
      "long_description": null,
      "product_type": "Example Product",
      "image": null,
      "brand": {
        "brand_id": 1,
        "brand_name": "AGA",
        "brand_slug": "aga",
        "brand_image": "/assets/brands/test.webp",
        "raw_brand_image": "/assets/brands/test.webp",
        "aws_background": "https://api-data.reusably.io/assets/brands/test.jpg",
        "raw_aws_background": "/assets/brands/test.jpg"
      },
      "status": "Discontinued",
      "price": {
        "map": null,
        "map_last_updated": null,
        "msrp": null,
        "msrp_last_updated": null,
        "umrp": null,
        "umrp_last_updated": null,
        "in_stock_status": 1,
        "lap": {
          "lowes_price": null,
          "lowes_last_updated": null,
          "homedepot_price": null,
          "homedepot_last_updated": null,
          "bestbuy_price": null,
          "bestbuy_last_updated": null,
          "lowest_price": null
        },
        "lcp": {
          "lowest_price": null,
          "lowes_price": null,
          "lowes_last_updated": null,
          "homedepot_price": null,
          "homedepot_last_updated": null,
          "bestbuy_price": null,
          "bestbuy_last_updated": null
        }
      },
      "category": {
        "category_id": 12,
        "category_name": "Other",
        "category_slug": "other",
        "category_image": "/assets/detail-category/test.jpg",
        "raw_category_image": "assets/detail-category/test.jpg"
      },
      "subcategory": {
        "subcategory_id": 1,
        "subcategory_name": "Air Conditioners",
        "subcategory_slug": "air-conditioners",
        "subcategory_image": null,
        "raw_subcategory_image": null
      },
      "detail_category": {
        "detail_category_id": 1,
        "detail_category_name": "Window Mount Air Conditioners",
        "detail_category_slug": "window-mount-air-conditioners",
        "detail_category_image": "/assets/detail-category/test.jpg",
        "raw_detail_category_image": "assets/detail-category/test.jpg"
      },
      "product_images": [
        {
          "id": 63412828,
          "url": "/assets/images/SKU99999-63412828.webp",
          "raw_url": "/assets/images/SKU99999-63412828.webp",
          "priority": 0,
          "content_length": "0 kb"
        }
      ],
      "product_documents": [
        {
          "id": 61456962,
          "url": "/assets/docs/SKU99999-61456962.pdf",
          "raw_url": "/assets/docs/SKU99999-61456962.pdf",
          "role": "Specification Sheet",
          "priority": 0,
          "content_length": "0 kb"
        }
      ],
      "product_video": [],
      "product_feature": [],
      "product_spec": [
        {
          "section": null,
          "category": "Shelves",
          "spec": "2"
        },
        {
          "section": null,
          "category": "Doors",
          "spec": "1"
        },
        {
          "section": null,
          "category": "Height (in.)",
          "spec": "29–3/4"
        },
        {
          "section": null,
          "category": "Voltage",
          "spec": "115/60/1"
        },
        {
          "section": null,
          "category": "Width (in.)",
          "spec": "60–1/4"
        },
        {
          "section": null,
          "category": "Depth (in.)",
          "spec": "32–1/4"
        },
        {
          "section": null,
          "category": "Horse Power",
          "spec": "1/10"
        },
        {
          "section": null,
          "category": "Amps",
          "spec": "1.7"
        },
        {
          "section": null,
          "category": "Weight (lbs.)",
          "spec": "345"
        }
      ],
      "product_asset_360": [],
      "color_relation": [],
      "type_relation": [],
      "filter": [{
        [
          {
            "field": "Color",
            "value": "Stainless Steel"
            },
            {
              "field": "Type",
              "value": "Rangetop"
              }
              ]
              }
              ],
        "sort": {
          "Color": {
            "Stainless Steel": {
              "Field": "Color",
              "Value": "Stainless Steel"
            }
          },
          "Installation": {
            "Undercounter": {
              "Field": "Installation",
              "Value": "Undercounter"
            }
          }
        }
      "rebates": []
      }
    }
  ]
}

Payload Details

  • type: Indicates the type of event, here new_product.
  • action_date: The timestamp of when the product data was published, formatted as YYYY-MM-DD HH:MM:SS.
  • payload: An array that includes detailed information about the new product.
NameTypeDefinition
product_idnumberThe unique identifier of the product.
skustringThe stock keeping unit of the product.
linkstringThe link of the product’s data.
upcnumberThe barcode of the product.
colorstringThe color of the product.
namestringThe name of the product.
basic_descriptionstringThe basic description of the product.
long_descriptionstringThe longer description of the product.
product_typestringThe type of the product.
imagestringThe image of the product, it is optional.
brandarray of objectsThe array of objects, containing brand details.
brand_idstringThe id of the brand.
brand_namestringThe name of the brand.
brand_slugstringThe slug of the brand.
brand_imagestringThe image of the brand.
raw_brand_imagestringThe raw source of the brand's image.
aws_backgroundstringThe link of background’s image.
raw_aws_backgroundstringThe raw source of the background's image.
statusarray of objectsThe status of the product.
pricearray of objectsThe pricing standard objects.
mapstringThe minimum advertised price of the product.
map_last_updatedstringThe most recent update to the product's minimum advertised price.
msrpstringThe manufacturer’s suggested retail price of the product.
msrp_last_updatedstringThe most recent update to the product's manufacturer's suggested retail price.
umrpstringThe unilateral minimum resale price of the product.
umrp_last_updatedstringThe most recent update to the product's unilateral minimum resale price.
in_stock_statusbooleanThe active product status of lowest price product.
laparray of objectsThe lowest advertised price.
lowes_pricestringThe price from lowes.
lowes_last_updatedstringThe timestamp of the price update from lowes.
homedepot_pricestringThe price source; homedepot.
homedepot_last_updatedstringThe timestamp of the last updated homedepot price.
bestbuy_pricestringThe price source; bestbuy.
bestbuy_last_updatedstringThe timestamp of the last updated bestbuy price.
lowest_pricestringThe lowest price of the LAP.
lcparray of objectsThe updated lowest cart price.
lowest_pricestringThe lowest price of the LAP.
lowes_pricestringThe price from lowes.
lowes_last_updatedstringThe timestamp of the price update from lowes.
homedepot_pricestringThe price source; homedepot.
homedepot_last_updatedstringThe timestamp of the last updated homedepot price.
bestbuy_pricestringThe price source; bestbuy.
bestbuy_last_updatedstringThe timestamp of the last updated bestbuy price.
categoryarray of objectsThe category details of the product.
category_idnumberThe id of the product category.
category_namestringThe name of the product category.
category_slugstringThe slug of the product category.
category_imagestringThe image of the product category.
raw_category_imagestringThe raw source of the product's category image.
subcategoryarray of objectsThe subcategory details of the product.
subcategory_idnumberThe id of the product subcategory.
subcategory_namestringThe name of the product subcategory.
subcategory_slugstringThe slug of the product subcategory.
subcategory_imagestringThe image of the product subcategory.
raw_subcategory_imagestringThe raw source of the product's subcategory image.
detail_categoryarray of objectsThe detail category of the product.
detail_category_idnumberThe id of product detail category.
detail_category_namestringThe name of the product detail category.
detail_category_slugstringThe slug of the product detail category.
detail_category_imagestringThe image of the product detail category.
raw_detail_category_imagestringThe raw source of the product's detail category image.
product_imagesarray of objectsThe array of product images.
idnumberThe unique identifier of product images.
urlstringThe url of product images.
raw_urlstringThe raw url of product images.
prioritystringThe data indexing.
content_lengthstringThe length or size of content.
product_documentsarray of objectsThe array of product documents.
idnumberThe unique identifier of product documents.
urlstringThe url of product documents.
raw_urlstringThe raw url of product documents.
rolestringThe role of content type.
prioritystringThe data indexing.
content_lengthstringThe length or size of content.
product_videoarray of objectsThe array of product video.
product_featurearray of objectsThe array of product features.
product_specarray of objectsThe array of product specifications.
sectionstringThe section of product specification, it is optional.
categorystringThe category of the product specification.
specstringThe value of the category.
product_asset_360array of objectsThe array of product assets.
color_relationstringThe array of color relation.
type_relationstringThe type of relation.
filterstringThe filter for new products.
fieldarray of objectsThe field of the filter type.
valuestringThe value of the filter type field.
sortarray of objectsThe sorting option of the products.
colorarray of objectsThe color sorting type.
stainless steelstringOne of the colors.
fieldstringThe field of the previous object.
valuestringThe value of the field.
installationarray of objectsThe installation sorting type.
undercounterstringOne of the installation types.
fieldstringThe field of the previous object.
valuestringThe value of the field.
rebatesstringThe discounted price.