Open a dispute
Opens a dispute against one of the authenticated shopper’s own marketplace
orders. The dispute is created with status: "open" for the operator to
review, and a message thread is started so the shopper, merchant, and
operator can communicate.
A shopper may have only one open dispute per order at a time.
Authentication: API key in the Authorization: Bearer header and a
customer session — either x-auth-token or x-external-auth.
Authorizations
API Key Authentication
Use your API key in the Authorization header:
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: write operations, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Read-only access (GET requests only, plus POST semantic search)
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - All write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Headers
Customer session token. Provide this or x-external-auth.
Bring-your-own-auth assertion. Provide this or x-auth-token.
Query Parameters
Marketplace operator key only. The merchant the shopper is acting at.
Body
The shopper's own order the dispute is about.
The dispute reason code (see GET /v1/disputes/reasons).
not_received, not_as_described, damaged, wrong_item, quality, unauthorized, other Free-text detail. Required when reason is other.
Response
Dispute opened successfully

