Agency Partner API — plug any agency into your operation

Integrate once, serve every COD Scale merchant

Most COD businesses outsource part of the pipeline — confirmation calls to a call center, packing to a fulfillment warehouse, delivery to a courier, re-attempts to a follow-up (suivi) desk. The Agency Partner API turns that into a plug: the merchant issues the agency a scoped key from the dashboard, and the agency works the merchant’s orders through a documented, versioned API.

For agencies the equation is even better: build the integration once and every COD Scale merchant who connects you becomes a client you can serve on day one — no custom integration per merchant, ever.

Three ways for an agency to connect

• API — for agencies with developers (or an AI coding agent): a REST API with an OpenAPI spec, per-lane endpoints, idempotent writes, and strict per-connection scoping.
• Google Sheets — for non-technical agencies: the platform maintains a live spreadsheet per work lane. Locked columns carry the work queue; the agency records outcomes in its own ✏️ columns with dropdowns; everything syncs back automatically about every 10 minutes, and a Result column shows exactly what was applied.
• Agency Console — one free login for the agency manager showing every connected merchant, live work counts per lane, the Google Sheets, and the API docs. Merchants link an agency by handing it a one-time invite code.

The permission model

A connection carries any combination of four scopes: confirm (confirmation calls), fulfillment (packing and handoff), courier (delivery and tracking), and suivi (delivery follow-up). A hybrid agency — say a courier that also does fulfillment — simply gets both scopes and can dispatch parcels to itself.

The merchant stays in control the whole time: permissions are editable live and apply on the very next request, keys rotate with one click (the old key dies instantly), and a connection can be suspended and resumed at any time.

For developers and AI coding agents

The API is documented in three machine-friendly artifacts, all public and always in sync with production: the OpenAPI 3 spec at https://app.codscale.io/api/partner/openapi.json (generate your client from it), the complete integration guide in raw markdown at https://app.codscale.io/api/partner/integration.md, and an llms.txt index at https://app.codscale.io/api/partner/llms.txt.

Building with an AI coding agent? Paste this into it: “You are integrating my agency with the COD Scale Agency Partner API. Fetch https://app.codscale.io/api/partner/integration.md and https://app.codscale.io/api/partner/openapi.json, follow the golden rules and the checklist in the guide, and build the integration for my lane.” The guide carries the auth model, the quickstart ladder, per-lane examples, the error contract, and retry semantics — everything an agent needs to build without guessing.

Safety by design

• An agency only ever sees the work the merchant routed to it — other orders and parcels are invisible, for every agency, always.
• Order data shared with agencies is minimized to the job: customer, address, items, COD total — never your costs, margins, or finance.
• Order statuses are never set directly by an agency; they derive through your own transition rules, the same ones your in-house team uses.
• Writes are idempotent (safe retries), rate limited, and every action lands in the order timeline tagged with the agency’s name — full auditability.

How merchants connect an agency

• Open Settings → Agency Connections in the dashboard (OMS Pro plans).
• Create the connection, tick the scopes the agency should have, and hand over the key (shown once).
• Optionally create the Google Sheets per lane and invite the agency to the console with a one-time code.
• Watch the work flow: assignments route to the agency, outcomes come back through the same pipeline, and every action is auditable in the order timeline.

Frequently asked questions