Public

Worked public samples

No X-API-Key required — and none accepted. Every route on this page is public by design: the API ignores the key entirely, so the samples below omit it. Signed links, tokens, or public query parameters authorize the caller where noted; do not add an API key to a browser embed.

The endpoint list below documents every public route’s parameters; this overlay walks the surfaces a signed-out visitor actually hits: callback links, the community and idea boards, shared recordings and embeds, sub-processor notices, then the survey link, the hosted consent form, and an agentic-commerce checkout. Success envelopes are { data, meta } and error envelopes { error, meta }, except where a route serves a raw protocol document or an HTML page; the four shapes together are documented in How to read a worked sample. Every response carries meta.request_id. Quote the request id when you report an out-of-window token or a misfired cancel so support can trace the request end-to-end.

1. Look up a callback token

GET /api/v1/public/callbacks/{token} returns the callback’s arrival state — ok: true with status set to pending, running, succeeded, failed, or canceled. It also reports whether a cancel and a reschedule request would still be accepted, so your confirmation page can hide an action that would 409. The route ignores X-API-Key; the sample sends nothing.

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a",
);
console.log(await res.json());

200

{
  "data": {
    "id": "cbk_01J8Q2WZP4Q3R8YW7T6S",
    "status": "pending",
    "attempts": 1,
    "max_attempts": 3,
    "next_attempt_at": "2026-08-26T12:30:00.000Z",
    "scheduled_for": "2026-08-26T12:30:00.000Z",
    "caller": "+1234***5678",
    "can_cancel": true,
    "can_reschedule": true
  },
  "meta": {
    "request_id": "req_pub_get",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

caller masks the calling number for screen readers and logs; the full E.164 number only resolves inside your tenant-scoped callback list.

2. Check a callback’s status

GET /api/v1/public/callbacks/{token}/status answers the same envelope without the embedded PII — use it for a barebones “still pending” check on the confirmation page before you offer the cancel button.

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a/status"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a/status",
);
console.log(await res.json());

200

{
  "data": {
    "status": "pending",
    "attempts": 1,
    "max_attempts": 3,
    "next_attempt_at": "2026-08-26T12:30:00.000Z",
    "can_cancel": true,
    "can_reschedule": true
  },
  "meta": {
    "request_id": "req_pub_status",
    "timestamp": "2026-08-26T12:00:04.000Z"
  }
}

3. Cancel the callback

POST /api/v1/public/callbacks/{token}/cancel stops the remaining retry attempts and flips the callback to canceled. It works even after an attempt already ran — already_canceled: true tells you a previous cancel won, and the request is idempotent.

cURL

curl -X POST \
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a/cancel" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a/cancel",
  { method: "POST" },
);
console.log(await res.json());

200

{
  "data": {
    "ok": true,
    "status": "canceled",
    "already_canceled": false
  },
  "meta": {
    "request_id": "req_pub_cancel",
    "timestamp": "2026-08-26T12:05:00.000Z"
  }
}

4. Reschedule the callback

POST /api/v1/public/callbacks/{token}/reschedule moves the callback to a new scheduled_for and resets the retry ladder. Rotate scheduled_for — send the new timestamp when you re-issue the token.

cURL

curl -X POST \
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a/reschedule" \
  -H "Content-Type: application/json" \
  -d '{ "scheduled_for": "2026-08-27T09:00:00.000Z" }'

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/callbacks/tkn_0c1d3e5f7a/reschedule",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      scheduled_for: "2026-08-27T09:00:00.000Z",
    }),
  },
);
console.log(await res.json());

200

{
  "data": {
    "ok": true,
    "status": "pending",
    "scheduled_for": "2026-08-27T09:00:00.000Z"
  },
  "meta": {
    "request_id": "req_pub_reschedule",
    "timestamp": "2026-08-26T12:06:00.000Z"
  }
}

5. Errors

Errors follow the { error, meta } envelope. Two failures every token holder hits: 404 — token not found or out of window. A guessed token was never issued or the callback window already closed. Do not retry.

404

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "No callback with that access token exists.",
    "status": 404
  },
  "meta": {
    "request_id": "req_pub_err",
    "timestamp": "2026-08-26T12:07:00.000Z"
  }
}

429 — token rate-limited. A public link that is hammered faster than one request per window returns a plain rate-limit so a runaway browser refresh is bounded:

429

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Public token refresh is bounded to one request per window.",
    "status": 429
  },
  "meta": {
    "request_id": "req_pub_err2",
    "timestamp": "2026-08-26T12:07:30.000Z"
  }
}

The community board, the idea board, the published roadmap, shared recordings and dashboard embeds, and the sub-processor subscription handshake are all reach-in surfaces for a signed-out visitor, so none of them accept a tenant API key — an X-API-Key header is simply ignored here and the samples below omit it. Scope the community and idea calls with ?org=<your-org-slug>; both boards are opt-in, and an unknown slug or a disabled board collapses to the same 404 so a probe cannot tell the two apart.

Consent envelopes stay tenant-owned: a subscription records only the channel (email or webhook), the endpoint, the subscriber locale, and the double-opt-in state. Confirm and unsubscribe links are signed, single-purpose tokens that expire after 30 days, and one click from the notice email flips state — no session, no password.

6. Browse and read community questions

GET /api/v1/public/community/questions lists published questions with vote, answer, and view counts — ?sort=recent|top|unanswered, an optional q full-text filter, and limit/offset pagination.

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/community/questions?org=acme&sort=top&limit=20"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/community/questions?org=acme&sort=top&limit=20",
);
console.log(await res.json());

200

{
  "data": {
    "questions": [
      {
        "id": "cq_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3f5",
        "title": "How do I rotate a callback token after it expires?",
        "excerpt": "Our confirmation page keeps the token in localStorage, and once the window closes the lookup 404s…",
        "author_name": "Priya",
        "vote_count": 14,
        "answer_count": 2,
        "view_count": 312,
        "created_at": "2026-08-20T09:14:00.000Z",
        "updated_at": "2026-08-21T11:40:00.000Z"
      }
    ],
    "total": 26,
    "limit": 20,
    "offset": 0
  },
  "meta": {
    "request_id": "req_pub_qlist",
    "timestamp": "2026-08-26T12:10:00.000Z"
  }
}

GET /api/v1/public/community/questions/{id} returns the question with its published answers, and bumps the view counter — never edge-cache it. Up-vote with POST /api/v1/public/community/questions/{id}/vote?org=acme (an empty body is fine); the call is idempotent per visitor, so a repeat returns voted: false with the unchanged count:

200

{
  "data": {
    "voted": true,
    "vote_count": 15
  },
  "meta": {
    "request_id": "req_pub_qvote",
    "timestamp": "2026-08-26T12:11:00.000Z"
  }
}

7. Read the idea board and up-vote

GET /api/v1/public/ideas lists feature-request ideas with their lifecycle status (under_review, planned, in_progress, shipped, declined) — visitors can submit and vote, but only your team moves an idea onto the roadmap.

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/ideas?org=acme&sort=top"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/ideas?org=acme&sort=top",
);
console.log(await res.json());

200

{
  "data": {
    "ideas": [
      {
        "id": "fi_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3f5",
        "title": "Reschedule callbacks from the confirmation page",
        "excerpt": "We'd like end customers to pick a new slot without calling support…",
        "author_name": "Marco",
        "category": "callbacks",
        "status": "planned",
        "admin_response": "On the roadmap for Q1",
        "vote_count": 87,
        "comment_count": 12,
        "view_count": 1304,
        "created_at": "2026-07-02T08:00:00.000Z",
        "updated_at": "2026-08-19T15:20:00.000Z",
        "status_changed_at": "2026-08-19T15:20:00.000Z"
      }
    ],
    "total": 41,
    "limit": 20,
    "offset": 0
  },
  "meta": {
    "request_id": "req_pub_ideas",
    "timestamp": "2026-08-26T12:12:00.000Z"
  }
}

Up-vote with POST /api/v1/public/ideas/{id}/vote?org=acme — same idempotent-per-visitor contract as the question vote above.

8. Read the public roadmap

GET /api/v1/public/ideas/roadmap returns the three roadmap columns — planned, in_progress, shipped — each capped and ordered by votes (the shipped column reads newest-first and doubles as a “what we shipped” changelog). Pair it with the content pages under GET /api/v1/public/pages and GET /api/v1/public/pages/{slug} when you need the published copy that explains a column.

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/ideas/roadmap?org=acme"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/ideas/roadmap?org=acme",
);
console.log(await res.json());

200

{
  "data": {
    "planned": [
      {
        "id": "fi_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3f5",
        "title": "Reschedule callbacks from the confirmation page",
        "excerpt": "We'd like end customers to pick a new slot without calling support…",
        "author_name": "Marco",
        "category": "callbacks",
        "status": "planned",
        "admin_response": "On the roadmap for Q1",
        "vote_count": 87,
        "comment_count": 12,
        "view_count": 1304,
        "created_at": "2026-07-02T08:00:00.000Z",
        "updated_at": "2026-08-19T15:20:00.000Z",
        "status_changed_at": "2026-08-19T15:20:00.000Z"
      }
    ],
    "in_progress": [],
    "shipped": []
  },
  "meta": {
    "request_id": "req_pub_roadmap",
    "timestamp": "2026-08-26T12:13:00.000Z"
  }
}

9. Resolve a shared recording or a dashboard embed

GET /api/v1/public/recordings/{token} resolves a signed recording share link minted from the dashboard’s share action and returns the player HTML for the recipient — never the underlying storage path. An expired or revoked link answers 404 with the same non-disclosing page. GET /api/v1/public/analytics/dashboards/embed?token=… is the white-label variant for analytics: it verifies the signed grant and returns the layout snapshot plus the minting org’s public branding theme so the embed page renders inside your iframe.

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/analytics/dashboards/embed?token=v1.eyJhbGciOi…sig"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/analytics/dashboards/embed?token=v1.eyJhbGciOi…sig",
);
console.log(await res.json());

200

{
  "data": {
    "name": "Q3 deliverability board",
    "layout": {
      "widgets": [
        { "kind": "timeseries", "metric": "delivery_rate" },
        { "kind": "table", "metric": "top_failure_reasons" }
      ]
    },
    "branding": {
      "logo_url": "https://storage.example/signed-logo-url",
      "logomark_url": "https://storage.example/signed-logomark-url",
      "primary_color": "#0d9488",
      "accent_color": "#1a1a2e",
      "dashboard_name": "Acme reporting",
      "favicon_url": "https://storage.example/signed-favicon-url",
      "support_email": "support@acme.example",
      "custom_domain": "reports.acme.example",
      "terms_url": "https://acme.example/terms",
      "privacy_url": "https://acme.example/privacy"
    },
    "issued_at": "2026-08-20T12:00:00.000Z",
    "expires_at": "2026-09-19T12:00:00.000Z"
  },
  "meta": {
    "request_id": "req_pub_embed",
    "timestamp": "2026-08-26T12:14:00.000Z"
  }
}

Both resolvers keep the recipient link private — the token is a bearer credential, the responses are no-store, and a tampered or expired grant collapses to the same 404 without distinguishing which. POST /api/v1/public/subprocessor-subscriptions registers an email or a webhook endpoint for advance notice before Devotel adds or replaces a sub-processor. The Devotel site signs this call server-side, so a typical integration posts through its own backend or the site form rather than from a browser. The request is idempotent per endpoint: re-subscribing the same address returns the same subscription id and re-opens the double-opt-in.

cURL

curl -X POST \
  "https://api.orbit.devotel.io/api/v1/public/subprocessor-subscriptions" \
  -H "Content-Type: application/json" \
  -H "X-Devotel-Timestamp: 1782392400" \
  -H "X-Devotel-Signature: sha256=<hmac-of-`timestamp`.`body`>" \
  -d '{ "channel": "email", "email": "compliance@acme.example", "locale": "en" }'

Node.js

const body = JSON.stringify({
  channel: "email",
  email: "compliance@acme.example",
  locale: "en",
});
const timestamp = Math.floor(Date.now() / 1000).toString();
const signature = createHmac("sha256", process.env.DEVOTEL_SIGNING_SECRET!)
  .update(`${timestamp}.${body}`)
  .digest("hex");

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/subprocessor-subscriptions",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "X-Devotel-Timestamp": timestamp,
      "X-Devotel-Signature": `sha256=${signature}`,
    },
    body,
  },
);
console.log(await res.json());

201

{
  "data": {
    "id": "1e6a0f42-9c1d-4f5e-8b2d-1b7c00c4ec9a",
    "status": "pending",
    "confirm_token": "v1.eyJzaWQiOi….sig",
    "unsubscribe_token": "v1.eyJzaWQiOi…sig"
  },
  "meta": {
    "request_id": "req_pub_subproc",
    "timestamp": "2026-08-26T12:15:00.000Z"
  }
}

11. Confirm and unsubscribe from the notice email

Every notice email carries both links. The token template is v1.<payload>.<signature> — a signed, single-purpose credential bound to one subscription, valid 30 days. GET /api/v1/public/subprocessor-subscriptions/confirm?token=… completes the double opt-in and flips the subscription to confirmed:

cURL

curl -X GET \
  "https://api.orbit.devotel.io/api/v1/public/subprocessor-subscriptions/confirm?token=v1.eyJzaWQiOi…sig"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/subprocessor-subscriptions/confirm?token=v1.eyJzaWQiOi…sig",
);
// The endpoint answers a brand-neutral HTML page for the human who
// clicked the link, not a JSON envelope.
console.log(await res.text());

GET /api/v1/public/subprocessor-subscriptions/unsubscribe?token=… is the one-click footer link — it flips any state to unsubscribed and is safe to re-hit. Both endpoints answer an HTML page for the human who clicked; a missing, malformed, or expired token renders “link not valid” with a prompt to subscribe again, and re-subscribing from the sub-processor page mints a fresh pair of tokens on the same subscription id. Survey invitation links, hosted consent landing pages, and the agentic-commerce (ACP) checkout are the three public surfaces your recipients and shopping agents drive straight from a browser or an agent runtime. Like the boards above, all three ignore X-API-Key; the token or the storefront id in the path is the credential.

12. Open a survey invitation link

GET /api/v1/public/surveys/{token}

The survey link you send is this route with the signed invitation token in the path. It always answers HTML (text/html), not JSON: a self-contained page with a 0-10 score row and an optional comment box, or a thank-you page when the recipient already answered. The JSON block on the generated entry above is a schema placeholder; browsers and iframe embeds render the page below.

cURL

curl "https://api.orbit.devotel.io/api/v1/public/surveys/svy_v1.eyJhbGciOi…sig"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/surveys/svy_v1.eyJhbGciOi…sig",
);
console.log(await res.text()); // HTML page, not a JSON envelope

200

<!doctype html>
<html lang="en">
  <head><meta charset="utf-8"><title>How likely are you to recommend Acme?</title></head>
  <body>
    <!-- abbreviated: 0-10 score row + optional comment box, posted to
         POST /api/v1/public/surveys/{token}/submit -->
    <form method="post" action="/api/v1/public/surveys/svy_v1.eyJhbGciOi…sig/submit">
      <div class="score">7</div>
    </form>
  </body>
</html>

An expired or invalid token renders a non-disclosing 404 HTML page — This feedback link has expired or is invalid. — identical for tokens that never existed, so a probe cannot enumerate survey ids. See How to read a worked sample for the error envelope used by the JSON surfaces below.

404

<!doctype html>
<title>Link expired</title>
<p style="font-family:sans-serif;padding:32px">This feedback link has expired or is invalid.</p>

13. Submit a survey response (HTML vs JSON)

POST /api/v1/public/surveys/{token}/submit

The submit route accepts a JSON body or an HTML form post, keyed off the signed token in the URL, and is idempotent per link — a repeat submission never double-counts. The response format follows the caller’s Accept header: JSON clients get the { data, meta } envelope, form posts get a thank-you page.

cURL

curl -X POST \
  "https://api.orbit.devotel.io/api/v1/public/surveys/svy_v1.eyJhbGciOi…sig/submit" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{ "score": 9, "comment": "Fast support, clear docs." }'

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/surveys/svy_v1.eyJhbGciOi…sig/submit",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Accept: "application/json",
    },
    body: JSON.stringify({ score: 9, comment: "Fast support, clear docs." }),
  },
);
console.log(await res.json());

200

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_pub_survey_submit",
    "timestamp": "2026-08-26T12:20:00.000Z"
  }
}

Drop the Accept header (or send Accept: text/html) from a form post and the same call answers the thank-you page a human sees after clicking submit:

200

<!doctype html>
<title>Thanks</title>
<div style="font-family:sans-serif;padding:48px;text-align:center"><h1>Thanks for your feedback</h1><p>We've recorded your response.</p></div>

An invalid or expired token answers 403 on submit (the JSON surface names it; the HTML page route above uses the non-disclosing 404):

403

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Token is invalid or expired",
    "status": 403
  },
  "meta": {
    "request_id": "req_pub_survey_err",
    "timestamp": "2026-08-26T12:21:00.000Z"
  }
}

GET /api/v1/public/consent/{tenantId}/config

A hosted consent landing page renders from this route: it returns the public, safe-subset config a form needs — enabled flag, branding, copy, and the channels the tenant accepts. No secrets, no tenant enumeration: an unknown or disabled tenant answers enabled: false with empty branding and copy.

cURL

curl "https://api.orbit.devotel.io/api/v1/public/consent/tenant_8fb2d1b7c00c/config"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/consent/tenant_8fb2d1b7c00c/config",
);
console.log(await res.json());

200

{
  "data": {
    "enabled": true,
    "branding": {
      "logo_url": "https://cdn.acme.example/logo.svg",
      "primary_color": "#0d9488",
      "business_name": "Acme Stores"
    },
    "copy": {
      "headline": "Hear from us when it matters",
      "body": "One email a month with what changed and what is next.",
      "footer": "You can unsubscribe at any time."
    },
    "allowed_channels": ["email", "sms"]
  },
  "meta": {
    "request_id": "req_pub_consent_cfg",
    "timestamp": "2026-08-26T12:22:00.000Z"
  }
}

For a tenant whose form is switched off, the same call answers the non-disclosing variant — render nothing interactive when enabled is false:

200

{
  "data": {
    "enabled": false,
    "branding": {
      "logo_url": null,
      "primary_color": null,
      "business_name": null
    },
    "copy": {
      "headline": null,
      "body": null,
      "footer": null
    },
    "allowed_channels": []
  },
  "meta": {
    "request_id": "req_pub_consent_cfg_off",
    "timestamp": "2026-08-26T12:22:30.000Z"
  }
}

15. Capture an opt-in or opt-out

POST /api/v1/public/consent

The form posts here. An opt-out is one-click and never gated; an opt-in requires the signed proof-of-ownership token that Orbit delivered to the recipient’s own address, so nobody can subscribe a third party. On success the route returns the ids of the consent records it wrote, one per channel.

cURL

curl -X POST \
  "https://api.orbit.devotel.io/api/v1/public/consent" \
  -H "Content-Type: application/json" \
  -d '{
    "tenantId": "tenant_8fb2d1b7c00c",
    "contactIdentifier": "priya@acme.example",
    "channels": ["email"],
    "optIn": true,
    "proofToken": "v1.eyJhbGciOi…sig",
    "source": "public_form"
  }'

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/consent",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      tenantId: "tenant_8fb2d1b7c00c",
      contactIdentifier: "priya@acme.example",
      channels: ["email"],
      optIn: true,
      proofToken: "v1.eyJhbGciOi…sig",
      source: "public_form",
    }),
  },
);
console.log(await res.json());

200

{
  "data": {
    "status": "ok",
    "consentRecordIds": ["cst_9d8c7b6a5f4e3d2c1b0a"]
  },
  "meta": {
    "request_id": "req_pub_consent_ok",
    "timestamp": "2026-08-26T12:23:00.000Z"
  }
}

A malformed payload (missing channel, bad identifier) answers 422 with the offending fields listed in details.issues:

422

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid consent payload",
    "status": 422,
    "details": {
      "issues": [
        { "field": "channels", "message": "Expected non-empty array" },
        { "field": "contactIdentifier", "message": "Required" }
      ]
    }
  },
  "meta": {
    "request_id": "req_pub_consent_422",
    "timestamp": "2026-08-26T12:23:30.000Z"
  }
}

An opt-in without a valid proof token answers 403 CONSENT_PROOF_REQUIRED; opt-out ("optIn": false) never does.

16. Discover an agentic-commerce storefront

GET /api/v1/public/commerce/acp/{storefrontId}/.well-known/agentic-commerce

A shopping agent starts here. The route serves the ACP discovery manifest RAW — not the { data, meta } envelope — so a generic ACP client parses the protocol document directly. Unknown or unpublished storefronts 404.

cURL

curl "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/.well-known/agentic-commerce"

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/.well-known/agentic-commerce",
);
console.log(await res.json());

200

{
  "protocol": "agentic-commerce",
  "protocolVersion": "2025-09-29",
  "merchant": {
    "id": "acme-stores",
    "name": "Acme Stores",
    "currency": "EUR",
    "categories": ["coffee"]
  },
  "capabilities": {
    "discovery": true,
    "checkoutSessions": true,
    "delegatedPayment": true
  },
  "paymentMethods": ["delegated_mandate"],
  "endpoints": {
    "productFeed": "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/feed",
    "checkoutSessionCreate": "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/checkout",
    "checkoutSessionUpdate": "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/checkout/update",
    "checkoutSessionComplete": "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/checkout/complete"
  },
  "generatedAt": 1787745600000
}

17. Browse the hosted product feed

GET /api/v1/public/commerce/acp/{storefrontId}/feed

The feed is also served RAW, straight from the merchant’s stored catalog. Prices are in MAJOR currency units; the agent browses this to build a cart and never supplies a price of its own.

200

{
  "protocol": "agentic-commerce",
  "protocolVersion": "2025-09-29",
  "count": 2,
  "items": [
    {
      "id": "prs_01H9ZQX7C0",
      "title": "Espresso beans 1 kg",
      "description": "Single-origin, medium roast.",
      "price": 18.5,
      "currency": "EUR",
      "availability": "in_stock",
      "inventoryQuantity": 42,
      "link": null,
      "category": "coffee"
    }
  ],
  "generatedAt": 1787745600000
}

18. Open an ACP checkout session

POST /api/v1/public/commerce/acp/{storefrontId}/checkout

The agent posts the product ids and quantities it wants. The storefront prices every line SERVER-SIDE against the stored catalog — a forged price can never enter the cart — and returns the raw session snapshot. messages lists per-item problems (unknown product, out of stock); a blocking error keeps the session not_ready_for_payment.

cURL

curl -X POST \
  "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/checkout" \
  -H "Content-Type: application/json" \
  -d '{ "items": [ { "productId": "prs_01H9ZQX7C0", "quantity": 2 } ], "currency": "EUR" }'

Node.js

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/public/commerce/acp/acme-stores/checkout",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      items: [{ productId: "prs_01H9ZQX7C0", quantity: 2 }],
      currency: "EUR",
    }),
  },
);
console.log(await res.json());

200

{
  "id": "chk_7e6d5c4b3a291807",
  "merchantId": "acme-stores",
  "status": "ready_for_payment",
  "currency": "EUR",
  "category": null,
  "lineItems": [
    {
      "id": "prs_01H9ZQX7C0",
      "productId": "prs_01H9ZQX7C0",
      "title": "Espresso beans 1 kg",
      "quantity": 2,
      "unitPrice": 18.5,
      "currency": "EUR",
      "lineTotal": 37
    }
  ],
  "itemCount": 2,
  "subtotal": 37,
  "total": 37,
  "messages": [],
  "order": null,
  "createdAt": 1787745600000,
  "updatedAt": 1787745600000
}

POST /api/v1/public/commerce/acp/{storefrontId}/checkout/update re-prices the same session for a replacement item set — send the current session plus the new items and read the re-derived totals the same way.

19. Complete the checkout under an agent mandate

POST /api/v1/public/commerce/acp/{storefrontId}/checkout/complete

Completing a session requires a verified AP2 payment mandate: the route checks the agent’s signature before any charge, re-prices the cart against the stored catalog, and re-verifies the mandate’s scope and spend caps. An anonymous caller 401s; an unverifiable signature 403s. The response is RAW — the completed session plus the mandate and authorization it ran under (shown here with the fields the route logs):

200

{
  "session": {
    "id": "chk_7e6d5c4b3a291807",
    "merchantId": "acme-stores",
    "status": "completed",
    "currency": "EUR",
    "category": null,
    "lineItems": [
      {
        "id": "prs_01H9ZQX7C0",
        "productId": "prs_01H9ZQX7C0",
        "title": "Espresso beans 1 kg",
        "quantity": 2,
        "unitPrice": 18.5,
        "currency": "EUR",
        "lineTotal": 37
      }
    ],
    "itemCount": 2,
    "subtotal": 37,
    "total": 37,
    "messages": [],
    "order": {
      "id": "ord_2f8e1d0c9b8a7654",
      "checkoutSessionId": "chk_7e6d5c4b3a291807",
      "mandateId": "mdt_5a4b3c2d1e0f9876",
      "authorizationId": "auth_c1d2e3f4a5b67890",
      "amount": 37,
      "currency": "EUR"
    },
    "createdAt": 1787745600000,
    "updatedAt": 1787745960000
  },
  "mandate": { "id": "mdt_5a4b3c2d1e0f9876" },
  "authorization": {
    "authorizationId": "auth_c1d2e3f4a5b67890",
    "amount": 37
  }
}

No money moves on Devotel’s side — the authorization belongs to the mandate’s payment instrument, and the order record is what your storefront reconciles against.

API Reference

All Endpoints

Worked public samples

1. Look up a callback token

2. Check a callback’s status

3. Cancel the callback

4. Reschedule the callback

5. Errors

6. Browse and read community questions

7. Read the idea board and up-vote

8. Read the public roadmap

9. Resolve a shared recording or a dashboard embed

11. Confirm and unsubscribe from the notice email

12. Open a survey invitation link

13. Submit a survey response (HTML vs JSON)

15. Capture an opt-in or opt-out

16. Discover an agentic-commerce storefront

17. Browse the hosted product feed

18. Open an ACP checkout session

19. Complete the checkout under an agent mandate

​Worked public samples

​1. Look up a callback token

​2. Check a callback’s status

​3. Cancel the callback

​4. Reschedule the callback

​5. Errors

​Community surface + consent envelopes, worked

​6. Browse and read community questions

​7. Read the idea board and up-vote

​8. Read the public roadmap

​9. Resolve a shared recording or a dashboard embed

​10. Subscribe to sub-processor change notices

​11. Confirm and unsubscribe from the notice email

​Survey links, consent forms, and agentic commerce, worked

​12. Open a survey invitation link

​13. Submit a survey response (HTML vs JSON)

​14. Render a hosted consent form

​15. Capture an opt-in or opt-out

​16. Discover an agentic-commerce storefront

​17. Browse the hosted product feed

​18. Open an ACP checkout session

​19. Complete the checkout under an agent mandate

Worked public samples

1. Look up a callback token

2. Check a callback’s status

3. Cancel the callback

4. Reschedule the callback

5. Errors

Community surface + consent envelopes, worked

6. Browse and read community questions

7. Read the idea board and up-vote

8. Read the public roadmap

9. Resolve a shared recording or a dashboard embed

10. Subscribe to sub-processor change notices

11. Confirm and unsubscribe from the notice email

Survey links, consent forms, and agentic commerce, worked

12. Open a survey invitation link

13. Submit a survey response (HTML vs JSON)

14. Render a hosted consent form

15. Capture an opt-in or opt-out

16. Discover an agentic-commerce storefront

17. Browse the hosted product feed

18. Open an ACP checkout session

19. Complete the checkout under an agent mandate