docs
Get startedTroubleshootingPaymentsWebhooksAgent paymentsSwop MCPOviIdentity (swop.id)SwivyRPC (preview)API reference

Orders

GET /orders. Your sales, newest first, with cursor paging.

List orders

GEThttps://apps.apiswop.co/api/v5/merchant/orders

Scope: commerce.read

Returns orders where you are the seller, newest first. Buyer identity is deliberately left out; use the checkout.paid webhook for shipping details.

Query parameters

ParameterTypeDefaultNotes
limitinteger251 to 100
beforeISO 8601noneReturn orders created before this time. Pass the previous response's nextBefore.
curl "https://apps.apiswop.co/api/v5/merchant/orders?limit=25" \
  -H "Authorization: Bearer $SWOP_MERCHANT_KEY"

Response

{
  "state": "success",
  "data": {
    "orders": [
      {
        "orderId": "ORD-…",
        "status": "paid",
        "orderType": "physical",
        "lineItems": [ { "productId": "66a1…", "name": "Swop Classic Card", "quantity": 1, "unitAmount": 25, "totalAmount": 25 } ],
        "financial": { "subtotal": 25, "shippingCost": 5, "totalCost": 30, "currency": "USDC" },
        "payment": {
          "status": "completed",
          "paidAt": "2026-10-29T18:01:05.000Z",
          "amount": 30,
          "validation": { "details": { "receivedAmount": 30 } }
        },
        "settlement": { "status": "held" },
        "fulfillment": {
          "status": "pending",
          "requiresShipping": true,
          "shippedAt": null,
          "trackingNumber": "",
          "carrier": "",
          "estimatedDeliveryDate": null
        },
        "createdAt": "2026-10-29T18:01:05.000Z"
      }
    ],
    "nextBefore": "2026-10-29T18:01:05.000Z"
  }
}

Fields

FieldMeaning
orderIdSwop's order ID
statuscreated, paid, fulfilling, completed, cancelled, failed
orderTypedigital, physical, in_person_checkout, mixed
lineItems[]What was bought
financialsubtotal, shippingCost, totalCost, currency (USDC)
payment.statuspending, completed, failed, refunded, cancelled
payment.paidAt, payment.amountWhen and how much the buyer paid
payment.validation.details.receivedAmountThe amount that actually arrived on-chain
settlement.statusYour payout: pending, held, release_pending, releasing, released, failed, refunded
fulfillment.*Shipping status and tracking
nextBeforeCursor for the next page, or null at the end

On this page