Endpoint
Headers
| Header | Required | Description |
|---|---|---|
Accept | Yes | Must be application/json |
Response
A200 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. |
This endpoint is designed for the Portal.io Zapier integration. If you are building a direct integration, consider using the webhook subscription endpoints instead.