Change Inventory

This documentation outlines the Inventory webhook's capabilities, its triggers, payload structure, and provides a sample request for the EditVariant action.

Overview

The Inventory webhook is triggered whenever there is a significant change to a product's inventory in the shop. This webhook provides real-time updates when a product is added, cloned, edited, or deleted, or when variants are modified or deleted. It helps ensure that your inventory system remains synchronized with the shop’s product catalog.

Triggers

The following events can trigger the Inventory webhook:

• AddProduct: Triggered when a new product is added to the shop’s inventory.

• CloneProduct: Triggered when an existing product is cloned to create a new one.

• EditProduct: Triggered when a product’s details are edited.

• AddVariant: Triggered when a new variant is added to a product.

• EditVariant: Triggered when a product variant is edited.

• DeleteProduct: Triggered when a product is deleted from the inventory.

• DeleteVariant: Triggered when a variant is removed from a product.

Payload Format

When a trigger is activated, a POST request is sent to your configured endpoint with the following structure:

Payload Parameters:

• event: "Inventory" — Identifies the event type as related to inventory changes.

• action: Specifies the specific action that triggered the webhook (e.g., AddProduct, EditVariant, DeleteProduct, etc.).

• shop: Contains details about the shop where the inventory event occurred:

  • id: The unique ID of the shop.

  • name: The name of the shop.

  • title: The title or brand of the shop.

  • domain: The shop's domain or URL.

• product: Contains detailed information about the product, including:

  • id: The unique ID of the product.

  • title: The title of the product.

  • price: The current price of the product.

  • currency: The currency used for the product's price.

  • Additional product details such as specifications, features, and inventory.

• variant: Contains detailed information about the product variant (if applicable), including:

  • id: The unique ID of the variant.

  • price: The variant’s price.

  • quantity: The available quantity of the variant.

Sample Request: EditVariant

This sample demonstrates a webhook payload when the EditVariant action is triggered:

{
  "event": "Inventory",
  "action": "EditVariant",
  "shop": {
    "id": 1,
    "name": "pajuhaan",
    "title": "Rocketiox",
    "domain": "http://localhost:9000/@pajuhaan"
  },
  "product": {
    "id": 9361,
    "shop_id": 1,
    "title": "GEN-V Wireless (Silver Metal / Navy Coated)",
    "price": 287,
    "currency": "USD",
    "spec": {
      "Design": "group",
      "Color": ["Silver Metal / Navy Coated"],
      "Headphone Type": ["Over-Ear"],
      "Connectivity": "group",
      "Wireless Type": ["Bluetooth 5.0"]
    },
    "quantity": 398
  },
  "variant": {
    "id": 2987,
    "shop_id": 1,
    "product_id": 9361,
    "color": "#F57C00/#000000",
    "price": 0,
    "quantity": 90,
    "image": "shops_1_products_6b964dfaa683f92a5c9f82fe746762ef--transparent.png",
    "enable": true
  }
}

In this case, the product "GEN-V Wireless" has a variant that was edited, with updated details about its color, price, and available quantity.

Benefits

• Real-time updates: Ensure your inventory system is always up to date when changes are made.

• Comprehensive data: Get detailed information on both products and their variants, helping you keep track of individual item updates.

• Multiple triggers: Cover a wide range of inventory actions from adding products to editing or deleting variants.