Reference
Deliveries API
Every deliveries endpoint, its fields and an example.
Generated from FOM's OpenAPI document. Every request needs an API key; see Authentication.
The delivery object
| Field | Type | Description |
|---|---|---|
id | string | |
status | scheduled, out_for_delivery, delivered | |
scheduled_at | string | Can be null. |
delivered_at | string | Can be null. |
order_id | string | |
order_no | string | e.g. ORD-0319 |
address | string | |
delivery_fee | number | Can be null. |
created_at | string | |
updated_at | string |
List deliveries, newest first, or changes since a time
GET /public/v1/deliveriesScope: deliveries:read
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
limit | number | Default 50. 1–100. | |
cursor | string | The next_cursor from the previous page. | |
updated_since | string | Only records changed at or after this time, oldest change first. Keep the last updated_at you saw and ask from there to sync. e.g. 2026-11-25T08:00:00.000Z | |
status | scheduled, out_for_delivery, delivered |
Returns
A page of delivery objects (The delivery object).
Example
curl "https://api.getfom.com/public/v1/deliveries?limit=50&updated_since=2026-11-25T08%3A00%3A00.000Z" \
-H "Authorization: Bearer $FOM_API_KEY"One delivery
GET /public/v1/deliveries/{deliveryId}Scope: deliveries:read
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
deliveryId | string | Yes |
Returns
The delivery (The delivery object).
Example
curl "https://api.getfom.com/public/v1/deliveries/DELIVERY_ID" \
-H "Authorization: Bearer $FOM_API_KEY"Change a delivery's status or time
PATCH /public/v1/deliveries/{deliveryId}Scope: deliveries:write
Marking it delivered also moves the order, as in FOM.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
deliveryId | string | Yes |
Body
| Field | Type | Required | Description |
|---|---|---|---|
status | scheduled, out_for_delivery, delivered | ||
scheduled_at | string | Can be null. |
Returns
The delivery (The delivery object).
Example
curl -X PATCH "https://api.getfom.com/public/v1/deliveries/DELIVERY_ID" \
-H "Authorization: Bearer $FOM_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"status": "out_for_delivery"
}'