Skip to content

product.archived

A product was archived: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends product.archived to the webhook endpoints that receive it. This page says when it is sent and what data holds, with an example of the body.

When it is sent

The product was archived. When the product was removed from BIRP for good, data holds only its id and "status": "archived".

Data

data holds a product, with the fields of Products.

Example

Body of product.archivedJSON
{
  "api_version": "v1",
  "data": {
    "archived_at": "2026-09-28T14:05:12.417Z",
    "barcode": "2000000000015",
    "category_id": "00000000-0000-4000-8000-000000000021",
    "created_at": "2026-09-01T07:30:00.000Z",
    "currency": "MDL",
    "external_ids": [
      {
        "external_id": "1042",
        "source": "woocommerce"
      }
    ],
    "id": "00000000-0000-4000-8000-000000000011",
    "image_url": null,
    "kind": "goods",
    "name": "Wheat flour 25 kg",
    "price": "12.50",
    "sku": "SP-FLOUR-25",
    "status": "archived",
    "unit": "kg",
    "updated_at": "2026-09-28T14:05:12.417Z"
  },
  "id": "00000000-0000-4000-8000-000000000102",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "product.archived"
}

Related

  • webhook-events
  • products
  • verify-webhook-signatures