Complete public examples - Batch Relay API

Every example below is one complete HTTP request body. Each request contains one direct CloudEvents 1.0 structured JSON event; no fields need to be prepended or reconstructed. Values are fictional but production-shaped. Monetary components use USD integer minor units and always include subtotal, discount, shipping, tax, and total—even when a component is zero.

`order.created.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_order_created_01JQ8Y5Q8K6H9W2M4R7T1V3X5Z",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.created.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:42:31.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.created/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 1,
  "origin": "storefront",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "created",
    "currency": "USD",
    "subtotal_minor_units": 5000,
    "discount_minor_units": 0,
    "shipping_minor_units": 499,
    "tax_minor_units": 350,
    "total_minor_units": 5849,
    "lines": [
      {
        "line_id": "lin_demo_01JQ8Y6R7S8T9U0V1W2X3Y4Z5",
        "package_id": "pkg_demo_01JQ908M0N1P2Q3R4S5T6U7V8",
        "display_name": "Varsity Portrait Package",
        "quantity": 1,
        "unit_price_minor_units": 5000
      }
    ]
  }
}

`order.paid.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_order_paid_01JQ8Z0A1B2C3D4E5F6G7H8J9",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.paid.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:42:34.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.paid/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 2,
  "origin": "storefront",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "paid",
    "currency": "USD",
    "subtotal_minor_units": 5000,
    "discount_minor_units": 0,
    "shipping_minor_units": 499,
    "tax_minor_units": 350,
    "total_minor_units": 5849,
    "lines": [
      {
        "line_id": "lin_demo_01JQ8Y6R7S8T9U0V1W2X3Y4Z5",
        "package_id": "pkg_demo_01JQ908M0N1P2Q3R4S5T6U7V8",
        "display_name": "Varsity Portrait Package",
        "quantity": 1,
        "unit_price_minor_units": 5000
      }
    ]
  }
}

`order.payment_failed.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_payment_failed_01JQ901B2C3D4E5F6G7H8J9K",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.payment_failed.v1",
  "subject": "orders/ord_demo_01JQ901C2D3E4F5G6H7J8K9M0",
  "time": "2026-08-16T18:42:41.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.payment_failed/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 2,
  "origin": "storefront",
  "correlationid": "cor_demo_payment_01JQ901D3E4F5G6H7J8K9M0N1",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ901C2D3E4F5G6H7J8K9M0",
    "status": "payment_failed",
    "reason_code": "payment_declined"
  }
}

`order.canceled.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_order_canceled_01JQ902B3C4D5E6F7G8H9J0K",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.canceled.v1",
  "subject": "orders/ord_demo_01JQ902C3D4E5F6G7H8J9K0M1",
  "time": "2026-08-16T18:42:51.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.canceled/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 3,
  "origin": "system",
  "correlationid": "cor_demo_cancel_01JQ902D4E5F6G7H8J9K0M1N2",
  "actorkind": "staff",
  "data": {
    "order_id": "ord_demo_01JQ902C3D4E5F6G7H8J9K0M1",
    "status": "canceled"
  }
}

`order.fulfillment_queued.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_fulfillment_queued_01JQ903C4D5E6F7G8H9J0K1M2",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.fulfillment_queued.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:43:01.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.fulfillment_queued/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 3,
  "origin": "system",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "fulfillment_queued"
  }
}

`order.fulfillment_submitted.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_fulfillment_submitted_01JQ903E5F6G7H8J9K0M1N2P3",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.fulfillment_submitted.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:43:11.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.fulfillment_submitted/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 4,
  "origin": "system",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "fulfillment_submitted"
  }
}

`order.fulfillment_accepted.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_fulfillment_accepted_01JQ903F6G7H8J9K0M1N2P3Q4",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.fulfillment_accepted.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:43:21.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.fulfillment_accepted/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 5,
  "origin": "system",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "provider",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "fulfillment_accepted"
  }
}

`order.fulfillment_rejected.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_fulfillment_rejected_01JQ904D4E5F6G7H8J9K0M1N2",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.fulfillment_rejected.v1",
  "subject": "orders/ord_demo_01JQ904E5F6G7H8J9K0M1N2P3",
  "time": "2026-08-16T18:43:31.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.fulfillment_rejected/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 5,
  "origin": "system",
  "correlationid": "cor_demo_rejected_01JQ904F5G6H7J8K9M0N1P2Q3",
  "actorkind": "provider",
  "data": {
    "order_id": "ord_demo_01JQ904E5F6G7H8J9K0M1N2P3",
    "status": "fulfillment_rejected",
    "reason_code": "provider_rejected"
  }
}

`order.shipped.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_order_shipped_01JQ905F6G7H8J9K0M1N2P3Q4",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.shipped.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:43:41.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.shipped/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 6,
  "origin": "system",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "provider",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "shipped",
    "carrier_code": "ups",
    "carrier_name": "UPS",
    "service_level": "Ground",
    "tracking_number": "1ZDEMO123",
    "tracking_url": "https://www.ups.com/track?tracknum=1ZDEMO123"
  }
}

`order.fulfilled.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_order_fulfilled_01JQ906G7H8J9K0M1N2P3Q4R5",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.fulfilled.v1",
  "subject": "orders/ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
  "time": "2026-08-16T18:43:51.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.fulfilled/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 7,
  "origin": "system",
  "correlationid": "cor_demo_order_01JQ8Y2Z3A4B5C6D7E8F9G0H1",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ8Y4K5M6N7P8Q9R0S1T2U3",
    "status": "fulfilled"
  }
}

`order.fulfillment_failed.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_fulfillment_failed_01JQ906H7J8K9M0N1P2Q3R4S5",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "order.fulfillment_failed.v1",
  "subject": "orders/ord_demo_01JQ906J8K9M0N1P2Q3R4S5T6",
  "time": "2026-08-16T18:44:01.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/order.fulfillment_failed/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 6,
  "origin": "system",
  "correlationid": "cor_demo_failed_01JQ906K9M0N1P2Q3R4S5T6U7",
  "actorkind": "system",
  "data": {
    "order_id": "ord_demo_01JQ906J8K9M0N1P2Q3R4S5T6",
    "status": "fulfillment_failed",
    "reason_code": "dispatch_retry_exhausted"
  }
}

Bulk catalog operation

These three events share the same correlationid and batch_id. The item and package events remain independently useful, while the batch event summarizes the whole operation.

`catalog_item.changed.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_catalog_changed_01JQ907J8K9M0N1P2Q3R4S5T6",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "catalog_item.changed.v1",
  "subject": "catalog-items/cat_demo_01JQ907K9M0N1P2Q3R4S5T6U7",
  "time": "2026-08-16T18:44:11.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/catalog_item.changed/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 4,
  "origin": "developer_api",
  "correlationid": "cor_demo_batch_01JQ909P2Q3R4S5T6U7V8W9X0",
  "actorkind": "api",
  "data": {
    "catalog_item_id": "cat_demo_01JQ907K9M0N1P2Q3R4S5T6U7",
    "batch_id": "bat_demo_01JQ909N1P2Q3R4S5T6U7V8W9",
    "action": "published",
    "state": {
      "status": "published",
      "availability": "active",
      "display_name": "8x10 Team Print",
      "currency": "USD",
      "price_minor_units": 2500
    },
    "changes": [
      {
        "field": "status",
        "previous": "draft",
        "current": "published"
      }
    ]
  }
}

`package.changed.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_package_changed_01JQ908K9M0N1P2Q3R4S5T6U7",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "package.changed.v1",
  "subject": "packages/pkg_demo_01JQ908M0N1P2Q3R4S5T6U7V8",
  "time": "2026-08-16T18:44:12.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/package.changed/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 3,
  "origin": "developer_api",
  "correlationid": "cor_demo_batch_01JQ909P2Q3R4S5T6U7V8W9X0",
  "actorkind": "api",
  "data": {
    "package_id": "pkg_demo_01JQ908M0N1P2Q3R4S5T6U7V8",
    "batch_id": "bat_demo_01JQ909N1P2Q3R4S5T6U7V8W9",
    "action": "updated",
    "state": {
      "status": "published",
      "availability": "active",
      "display_name": "Varsity Portrait Package",
      "currency": "USD",
      "price_minor_units": 5000,
      "included_item_count": 3
    },
    "changes": [
      {
        "field": "included_items"
      }
    ]
  }
}

`catalog_batch.completed.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_catalog_batch_01JQ909M0N1P2Q3R4S5T6U7V8",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "catalog_batch.completed.v1",
  "subject": "catalog-batches/bat_demo_01JQ909N1P2Q3R4S5T6U7V8W9",
  "time": "2026-08-16T18:44:13.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/catalog_batch.completed/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 1,
  "origin": "developer_api",
  "correlationid": "cor_demo_batch_01JQ909P2Q3R4S5T6U7V8W9X0",
  "actorkind": "api",
  "data": {
    "batch_id": "bat_demo_01JQ909N1P2Q3R4S5T6U7V8W9",
    "operation": "bulk_edit",
    "counts": {
      "created": 0,
      "updated": 1,
      "published": 1,
      "archived": 0,
      "restored": 0,
      "deleted": 0
    },
    "changed_resources": [
      {
        "id": "cat_demo_01JQ907K9M0N1P2Q3R4S5T6U7",
        "resource_type": "catalog_item",
        "resource_version": 4,
        "action": "published"
      },
      {
        "id": "pkg_demo_01JQ908M0N1P2Q3R4S5T6U7V8",
        "resource_type": "package",
        "resource_version": 3,
        "action": "updated"
      }
    ]
  }
}

`storefront.changed.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_storefront_changed_01JQ90AP2Q3R4S5T6U7V8W9X0",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "storefront.changed.v1",
  "subject": "storefronts/sfr_demo_01JQ90AQ3R4S5T6U7V8W9X0Y1",
  "time": "2026-08-16T18:44:31.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/storefront.changed/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 5,
  "origin": "developer_api",
  "correlationid": "cor_demo_storefront_01JQ90AR4S5T6U7V8W9X0Y1Z2",
  "actorkind": "staff",
  "data": {
    "storefront_id": "sfr_demo_01JQ90AQ3R4S5T6U7V8W9X0Y1",
    "action": "published",
    "state": {
      "status": "published",
      "availability": "available",
      "hostname": "demo-studio.batchrelay.com",
      "checkout_mode": "public_live",
      "audience": "public",
      "guardian_join_mode": "invite_link",
      "provider_submission_enabled": true
    },
    "changes": [
      {
        "field": "availability",
        "previous": "unavailable",
        "current": "available"
      }
    ]
  }
}

`destination.test.v1`

{
  "specversion": "1.0",
  "id": "evt_demo_destination_test_01JQ90BR4S5T6U7V8W9X0Y1Z2",
  "source": "https://api.batchrelay.com/event-sources/studios/stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "type": "destination.test.v1",
  "subject": "destinations/dst_demo_01JQ90BS5T6U7V8W9X0Y1Z2A3",
  "time": "2026-08-16T18:44:41.123Z",
  "datacontenttype": "application/json",
  "dataschema": "https://api.batchrelay.com/schemas/events/destination.test/v1",
  "tenanttype": "studio",
  "tenantid": "stu_demo_01JQ8Y3A2B4C6D8E0F1G2H3J4",
  "environment": "sandbox",
  "resourceversion": 1,
  "origin": "system",
  "correlationid": "cor_demo_destination_01JQ90BT6U7V8W9X0Y1Z2A3B4",
  "actorkind": "system",
  "data": {
    "test_id": "tst_demo_01JQ90BU7V8W9X0Y1Z2A3B4C5",
    "message": "Batch Relay event destination verification."
  }
}

​order.created.v1

​order.paid.v1

​order.payment_failed.v1

​order.canceled.v1

​order.fulfillment_queued.v1

​order.fulfillment_submitted.v1

​order.fulfillment_accepted.v1

​order.fulfillment_rejected.v1

​order.shipped.v1

​order.fulfilled.v1

​order.fulfillment_failed.v1

​Bulk catalog operation

​catalog_item.changed.v1

​package.changed.v1

​catalog_batch.completed.v1

​storefront.changed.v1

​destination.test.v1