Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HelenaLM32/ECHO/llms.txt

Use this file to discover all available pages before exploring further.

When a buyer is ready to engage a creator, they place an order directly against a marketplace listing. From that point, both parties can communicate through the order, track its progress through a defined status lifecycle, and finalize the engagement with a review once the work is delivered.

​
Placing an order

An order is created by a buyer submitting a POST /orders request that references the target item and agrees on a final price. 
{
  "item_id": 42,
  "final_price": 450.00
}
The final_price field allows for flexibility — the amount can differ from the listing’s base_price when buyers and creators agree on a custom scope. The authenticated user making the request is recorded as buyer_id.

​
Order status lifecycle

All orders start with a status of PENDING. Status is updated via PATCH /orders/{id}/status as the engagement progresses.
Only authorized parties can update an order’s status. Attempting to update an order you are not a party to will return a 403 error.

​
Viewing orders

Both buyers and creators can retrieve their orders through the API.
EndpointReturns
GET /ordersAll orders for the authenticated user (as buyer or creator)
GET /orders/{id}Full details for a specific order
Order records include id, buyer_id, item_id, final_price, and status.

​
Order messaging

Both parties can send messages on an active order. This keeps all project communication tied to the order record rather than scattered across external channels. 
POST /order-messages
{
  "order_id": 99,
  "content": "Please send the high-resolution files in PNG format."
}
Each message is stored with:
  • order_id — which order the message belongs to
  • sender_id — the authenticated user who sent it
  • content — the message text
  • sent_at — timestamp of when it was sent

​
Leaving a review

After an order is completed, the buyer can leave a review to help other buyers make informed decisions and to build the creator’s reputation on the platform. 
{
  "order_id": 99,
  "score": 5,
  "comment": "Excellent work, delivered ahead of schedule and exactly to brief."
}
Reviews have a score from 1 to 5 and an optional text comment. See Disputes and Reviews for how reviews are surfaced on creator profiles and how average scores are calculated.

​
Payment record

Each completed order has a corresponding payment record that captures:
  • stripe_tx_id — the external transaction reference
  • total_amount — the full amount charged to the buyer
  • platform_fee — the portion retained by ECHO
  • payment_date — when the payment was processed
Payment setup and configuration are handled by platform administrators. This documentation describes the data structure only. Contact your ECHO administrator for payment integration details.

​
If something goes wrong

If a problem arises with an order — a dispute over deliverables, a missed deadline, or any other issue — either party can open a formal dispute. ECHO’s dispute system provides a structured messaging thread and admin mediation to reach a resolution.

Disputes and Reviews

Open a dispute, exchange messages with the other party, and request admin mediation.

Orders API

Full reference for the orders and order-messages endpoints.

Build docs developers (and LLMs) love

Get started for freeTalk to us