> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel Product Order

Cancel a pending product order placed with order-product. Only orders that have not started processing can be cancelled; once the retailer begins fulfilling the order, cancellation is no longer possible. Ideal for: undoing accidental orders, cancellation workflows, order management.

Catalog action Integrations

Cancel a pending product order placed with order-product. Only orders that have not started processing can be cancelled; once the retailer begins fulfilling the order, cancellation is no longer possible. Ideal for: undoing accidental orders, cancellation workflows, order management.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `cancel-product-order` |
| Category | Integrations |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `shopping`, `order`, `cancel`, `ecommerce`, `write` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `orderId` | `string` | Yes | Order identifier returned by order-product. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `orderId` | `string` | Yes | Order identifier that was cancelled. |
| `cancelled` | `boolean` | Yes | True when the cancellation was accepted. |

## Examples

**Workflow node**

```json
{
  "type": "cancel-product-order",
  "payload": {
    "orderId": "example-orderId"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/cancel-product-order/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "orderId": "example-orderId"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.