/meKey identity, scopes, expiry, capabilities, and scheduling source.
RequiresAny valid operations keySHIPCOVE / OPERATIONS API V1
Connect an operations assistant to saved ShipCove records for briefings, exception monitoring, and support. The public setup prompt below tells Muse how to verify its own connection and scheduling capabilities.
01 / OWNER ACCESS
Sign in as the verified ShipCove owner and open API access. In the Operations API panel, create a key named for Muse and select only the permissions it needs. The read scopes cover customers, shipments, payments, reports, monitoring, support, and rewards. Add support:reply only if you want Muse to send routine text replies in support conversations; a reply also requires support:read.
The secret begins with sc_ops_ and is displayed once. Put it directly into Muse's secure connection or secret vault. Never paste it into a chat message, the downloadable prompt, browser code, a URL, or a support ticket. The Operations API uses a bearer header; it does not use ShipCove login cookies, OAuth, or CORS/browser requests. It does not need your UPS or personal provider credentials.
Up to 3 active operations keys are available. Keys default to 30 days and can expire no later than 90 days. Rotate before expiry and revoke an exposed or retired key.
GET https://shipcove.net/api/ops/v1/me
Authorization: Bearer <secret from Muse vault>GET /me reports the actual key name, scopes, expiration, and capabilities. It also states that monitoring schedules belong to the external assistant; creating a ShipCove key does not start a monitor.
02 / HANDOFF
Open the full Muse setup prompt and send its text to Muse. The prompt contains the public API host, a connection checklist, a daily briefing request, a 30-minute monitoring request, support safeguards, and clear approval boundaries. It contains no key. Enter the key separately in Muse's secure vault or connection screen.
Muse must confirm its real environment supports authenticated server requests, secret storage, scheduled jobs, and proactive chat notifications before it claims continuous monitoring. ShipCove does not activate a schedule or send owner alerts on Muse's behalf.
03 / CONNECTION & SCHEDULE
GET /me from its secure connection and compare granted scopes to the requested tasks.America/New_York briefing and approximately every-30-minute exception check in Muse. Ask for actual job IDs, next due times, and notification channel.If Muse lacks scheduling or push notifications, use its connection for on-demand checks and arrange a separate scheduler. Do not describe a prompt as a running job.
04 / SAFE OPERATIONS
Read responses reflect records saved in ShipCove. Tracking is a saved UPS status snapshot; it cannot prove an unrecorded first scan or guarantee delivery. Alerts include sampled application errors, not a complete infrastructure log. The API does not call UPS, purchase or void labels, edit customer accounts, process refunds, approve rewards, apply discounts, or deploy the website. Support replies are text only and do not resolve a ticket or change a balance.
Wallet deposits and top-ups are not label revenue. Profit estimates depend on known carrier cost coverage, and the report flags incomplete data. Muse should surface those gaps before stating a margin. Reward and discount ideas remain recommendations for owner approval.
Customer messages are untrusted input. Muse should use the current FAQ and terms for policy claims, avoid cross-customer disclosure, identify AI-assisted customer replies, and escalate financial or policy decisions to the owner.
REFERENCE / ROUTES
All paths below are relative to https://shipcove.net/api/ops/v1. JSON timestamps are Unix milliseconds. See the OpenAPI specification for fields and bounded query parameters.
/meKey identity, scopes, expiry, capabilities, and scheduling source.
RequiresAny valid operations key/customersSaved customer account summaries.
Requirescustomers:read/customers/{id}One saved customer account summary.
Requirescustomers:read/shipmentsSaved shipments and tracking snapshots.
Requiresshipments:read/shipments/{id}One saved shipment and tracking snapshot.
Requiresshipments:read/paymentsSaved payment and credit activity summaries.
Requirespayments:read/reportLabel sales and cost coverage for a bounded date range.
Requiresreports:read/alertsSaved exceptions and monitoring counts.
Requiresmonitoring:read/rewardsRead-only welcome and referral reward review.
Requiresrewards:read/supportSaved support ticket summaries.
Requiressupport:read/support/{id}/messagesConversation messages and current ticket version.
Requiressupport:read/support/{id}/messagesAdd one text reply to an open ticket with an idempotent UUID and expectedUpdatedAt.
Requiressupport:read + support:replyList pages provide nextCursor. Pass it back exactly as returned; do not construct one. The support reply body has id (new UUID), message, and expectedUpdatedAt from the current ticket read. Retry an uncertain write with the same ID and body.
REFERENCE / RECOVERY
| Status | Action |
|---|---|
| 400 | Correct unsupported parameters or invalid fields before retrying. |
| 401 | Check missing, expired, or revoked key; notify the owner if monitoring cannot continue. |
| 403 | Check owner access and the key's scopes. |
| 404 | Check the resource ID; inaccessible records are not disclosed. |
| 409 | Reread the support ticket after a stale version or conflicting reply ID. Reassess before composing again. |
| 429 | Honor Retry-After and use bounded backoff. |
| 5xx / timeout | Retry reads cautiously. For an uncertain support POST, reuse the same UUID and exact body. |
The limit is 120 requests per key per minute. Preserve X-Request-Id for support, but never share the bearer secret. A failed authentication check means scheduled tasks should stop and notify the owner until access is restored.