Open API

Appearance

Stock Notification ​

This webhook provides notifications for changes in stock information. It triggers under the following conditions:

  1. When a new order is placed and it changes the allocation stock and sellable stock values.
  2. When an order is canceled, resulting in changes to allocation stock and sellable stock.
  3. When an inbound is received.
  4. When reserved stock for a catalogue is edited.
  5. When on-hand stock is edited through the PCA Dashboard.

Example ​

json
{
  "event": "stock_notification",
  "payload": {
    "product_id": 123456789,
    "sku": "SKU-SINGLE-ITEM",
    "name": "Double Setting Spray",
    "sellable_stock": 900,
    "associated_items": [
      {
        "sku": "SKU-SINGLE-ITEM",
        "qty": 1,
        "stock": {
          "onhand": 1000,
          "reserved": 0,
          "allocated": 100,
          "sellable": 900
        }
      }
    ]
  }
}
{
  "event": "stock_notification",
  "payload": {
    "product_id": 123456789,
    "sku": "SKU-SINGLE-ITEM",
    "name": "Double Setting Spray",
    "sellable_stock": 900,
    "associated_items": [
      {
        "sku": "SKU-SINGLE-ITEM",
        "qty": 1,
        "stock": {
          "onhand": 1000,
          "reserved": 0,
          "allocated": 100,
          "sellable": 900
        }
      }
    ]
  }
}
json
{
  "event": "stock_notification",
  "payload": {
    "product_id": 123456789,
    "sku": "SKU-BUNDLE-3ITEMS",
    "name": "[FREE LIP STAIN + POUCH] Luxcrime Perfecting Cover Cushion - Velvet Matte SPF 50 PA +++",
    "sellable_stock": 733,
    "associated_items": [
      {
        "sku": "SKUSINGLE1",
        "qty": 1,
        "stock": {
          "onhand": 1157,
          "reserved": 200,
          "allocated": 224,
          "sellable": 733
        }
      },
      {
        "sku": "SKUSINGLE2",
        "qty": 1,
        "stock": {
          "onhand": 6511,
          "reserved": 5500,
          "allocated": 76,
          "sellable": 935
        }
      },
      {
        "sku": "SKUSINGLE3",
        "qty": 1,
        "stock": {
          "onhand": 3042,
          "reserved": 2200,
          "allocated": 70,
          "sellable": 772
        }
      }
    ]
  }
}
{
  "event": "stock_notification",
  "payload": {
    "product_id": 123456789,
    "sku": "SKU-BUNDLE-3ITEMS",
    "name": "[FREE LIP STAIN + POUCH] Luxcrime Perfecting Cover Cushion - Velvet Matte SPF 50 PA +++",
    "sellable_stock": 733,
    "associated_items": [
      {
        "sku": "SKUSINGLE1",
        "qty": 1,
        "stock": {
          "onhand": 1157,
          "reserved": 200,
          "allocated": 224,
          "sellable": 733
        }
      },
      {
        "sku": "SKUSINGLE2",
        "qty": 1,
        "stock": {
          "onhand": 6511,
          "reserved": 5500,
          "allocated": 76,
          "sellable": 935
        }
      },
      {
        "sku": "SKUSINGLE3",
        "qty": 1,
        "stock": {
          "onhand": 3042,
          "reserved": 2200,
          "allocated": 70,
          "sellable": 772
        }
      }
    ]
  }
}