Skip to main content

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

Headers

HeaderRequiredDescription
AcceptYesMust be application/json

Response

A 200 response returns the order details including status, totals, part count, and supplier breakdown.

Response Fields

FieldTypeDescription
idintegerOrder ID.
numberintegerOrder number.
namestringOrder name.
createdDatestring (ISO 8601)When the order was created.
modifiedDatestring (ISO 8601)When the order was last modified.
statusstringCurrent order status (see order statuses).
totalnumberTotal order amount (sum of all supplier amounts).
partCountnumberTotal part count across all suppliers.
orderSuppliersarraySupplier line items (see supplier fields).

Order Statuses

ValueDescription
UndefinedUnset/default status.
DraftOrder is being prepared.
SubmittedOrder has been submitted to the supplier.
ViewedBySupplierSupplier has viewed the order.
AcceptedSupplier has accepted the order.
ReceivedOrder has been received.
EmailFailedDelivery email to supplier failed.

Supplier Fields

FieldTypeDescription
idintegerOrder supplier ID.
supplierNamestringName of the supplier.
sumnumberTotal amount for this supplier.
partCountnumberPart count for this supplier.
statusstringSupplier-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.