Documentation Index
Fetch the complete documentation index at: https://docs.portal.io/llms.txt
Use this file to discover all available pages before exploring further.
This endpoint is used by the Portal.io Zapier integration. It fires when an order’s status changes in your Portal.io account — for example, when an order moves from Draft to Submitted, or from Submitted to Accepted.
Endpoint
GET /zapier/trigger/order
| Header | Required | Description |
|---|
Accept | Yes | Must be application/json |
Response
A 200 response returns the order details including status, totals, part count, and supplier breakdown.
Response Fields
| Field | Type | Description |
|---|
id | integer | Order ID. |
number | integer | Order number. |
name | string | Order name. |
createdDate | string (ISO 8601) | When the order was created. |
modifiedDate | string (ISO 8601) | When the order was last modified. |
status | string | Current order status (see order statuses). |
total | number | Total order amount (sum of all supplier amounts). |
partCount | number | Total part count across all suppliers. |
orderSuppliers | array | Supplier line items (see supplier fields). |
Order Statuses
| Value | Description |
|---|
Undefined | Unset/default status. |
Draft | Order is being prepared. |
Submitted | Order has been submitted to the supplier. |
ViewedBySupplier | Supplier has viewed the order. |
Accepted | Supplier has accepted the order. |
Received | Order has been received. |
EmailFailed | Delivery email to supplier failed. |
Supplier Fields
| Field | Type | Description |
|---|
id | integer | Order supplier ID. |
supplierName | string | Name of the supplier. |
sum | number | Total amount for this supplier. |
partCount | number | Part count for this supplier. |
status | string | Supplier-level order status. |
{
"id": 7001,
"number": 301,
"name": "Smith AV Equipment Order",
"createdDate": "2026-04-08T09:00:00Z",
"modifiedDate": "2026-04-09T11:00:00Z",
"status": "Submitted",
"total": 4800.00,
"partCount": 12,
"orderSuppliers": [
{
"id": 1,
"supplierName": "Acme Audio Distributors",
"sum": 3200.00,
"partCount": 8,
"status": "Submitted"
},
{
"id": 2,
"supplierName": "ProMount Supply Co",
"sum": 1600.00,
"partCount": 4,
"status": "Submitted"
}
]
}
This endpoint is designed for the Portal.io Zapier integration. If you are building a direct integration, consider using the webhook subscription endpoints instead.