stock.low

Stock running low

A region reached the restock threshold you set (restock[].when_available_below, checked when an order draws units). data.region names the region.

Sent as a signed POST to every endpoint subscribed to stock.low. Signing, retries and deduplication work the same for every event; see how delivery works.

Payload

The event.

idstring
Unique identifier of the event, prefixed with evt_. Treat it as an opaque string: store it and compare it, never parse it.
objectstring
Names the type of this object. Always event.
typestring
Always stock.low
created_attimestamp
When it happened.
dataobject
The object as it is now, exactly as its GET endpoint returns it, and what changed.

Payload

{
  "id": "evt_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
  "object": "event",
  "type": "stock.low",
  "created_at": "2026-10-14T10:02:00Z",
  "data": {
    "object": {
      "id": "stk_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
      "object": "stock",
      "name": "Clicker 50 pack",
      "description": "Pre-assembled clickers, bagged.",
      "review": {
        "status": "approved",
        "reason": null,
        "reviewed_at": "2026-05-02T10:00:00Z"
      },
      "units_per_batch": 50,
      "batch_price": {
        "amount": 30000,
        "currency": "usd"
      },
      "unit_price": {
        "amount": 600,
        "currency": "usd"
      },
      "contents": [
        {
          "type": "design",
          "design": {
            "id": "dsg_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
            "object": "design",
            "name": "clicker.3mf"
          }
        },
        {
          "type": "extra",
          "extra": {
            "id": "xtr_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
            "object": "extra",
            "name": "M3 screw"
          }
        }
      ],
      "inventory": {
        "available": 32,
        "in_production": 18,
        "by_region": [
          {
            "region": {
              "id": "reg_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
              "object": "region",
              "name": "Western Europe"
            },
            "available": 32,
            "in_production": 18
          }
        ]
      },
      "restock": [
        {
          "region": {
            "id": "reg_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
            "object": "region",
            "name": "Western Europe"
          },
          "mode": "auto_buy",
          "when_available_below": 10,
          "reorder_units": 50
        }
      ],
      "images": [
        {
          "url": "https://cdn.example.com/clicker.png",
          "primary": true
        }
      ],
      "attachments": [
        {
          "id": "att_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
          "object": "attachment",
          "name": "packing-guide.pdf"
        }
      ],
      "created_at": "2026-04-30T12:00:00Z",
      "updated_at": "2026-05-02T10:00:00Z"
    },
    "previous": null,
    "region": {
      "id": "reg_bfP0GSqKoZFrD72H5Os0rc7HV9XP6eQJu",
      "object": "region",
      "name": "Western Europe"
    }
  }
}